Setting Up the Module Discovery Trigger with Job Configurations
  • 21 Jun 2024
  • 8 Minutes to read
  • Contributors
  • PDF

Setting Up the Module Discovery Trigger with Job Configurations

  • PDF

Article summary

Enabling Inventory Modules

To ensure that new modules can be automatically provisioned and discovered, at least one Skylight sensor: control on the network must be enabled for discovery instances and for inventory-polling.

The procedures in this section explain how to create or change the discovery instances and inventory-polling state of managed modules.

Normally, a network administrator only needs to do these procedures once, when the Skylight orchestrator is installed. However, if you want to check for the availability of discovery instances, you can do so as explained in this section.


Note: The Skylight sensor: module will be loaded to Skylight orchestrator through the Skylight sensor: control.

To create/change the inventory instances of a Skylight sensor: control (from Skylight orchestrator)

For the Module Discovery Trigger, at least one Skylight sensor: control (managed by Skylight orchestrator) must be enabled for discovery instances. This can only be done on the Skylight sensor: control itself. However, you can log in on a managed Skylight sensor: control from Skylight orchestrator in order to create or change its discovery instances remotely:

  1. Access the list of managed Skylight sensor: control by selecting Devices ▶ Managed Elements.

  2. Locate the Skylight sensor: control that you want to access in the Managed Elements list and double-click its IP address (a link). After a brief delay, the login page for the Skylight sensor: control is displayed.

  3. Log in to the Skylight sensor: control and determine whether the discovery instance is configured and enabled. For detailed information about how to enable a device for inventory instances, see the user material for Skylight sensor: control.

To disable Override-config state in the Skylight sensor: control (in Skylight orchestrator)

When enabling Module Discovery Trigger, the Override-config state must be disabled.

  1. Access the list of managed Skylight sensor: control by selecting Devices ▶ Managed Elements.

  2. Locate the Skylight sensor: control that you want to access in the Managed Elements list and double-click its IP address (a link). After a brief delay, the login page for the Skylight sensor: control is displayed.

  3. Log into the Skylight sensor: control by selecting System ▶ Configuration ▶ RemDev Connection.

  4. Uncheck Override-config state.

To check/change the inventory-polling state of a Skylight sensor: control (in Skylight orchestrator)

All discovery instances of a Skylight sensor: control must also be enabled for inventory-polling in Skylight orchestrator. This means Skylight orchestrator will poll the inventory modules periodically and add any new modules in their inventory to the Skylight orchestrator Managed Modules & SFPs list.

You can view the inventory-polling state for all managed Skylight sensor: control as follows:

  1. Access the list of managed elements by selecting Devices ▶ Managed Elements.

  2. Display the Inventory Polling column in the Managed list as follows:

  • Right-click anywhere in the headings at the top of the table. A context menu is displayed.
    • Slide the cursor down the menu to Columns to view the full list of columns that can be displayed.
  • Check Inventory polling. The Inventory polling column is added to the table.
  1. To enable a module for inventory polling via Skylight sensor: control:
  • Double-click the Skylight sensor: control that you want to enable. The Device Configuration dialog is displayed.
  • Check the Enable Inventory polling? checkbox.
  • Click the Save button. The Device Configuration dialog closes.
  • Ensure that the Inventory polling column is checked for the module in the Managed list.

Preparing ME Reference Datasets for the Module Discovery Trigger

When new modules are going to be installed on the network, a network administrator prepares one or more ME Reference dataset files that list the modules to be installed. They will also prepare one or more configuration jobs to run on the new modules.

When the Discovery Trigger executes a configuration job, Skylight orchestrator scans the Unmanaged Modules & SFPs list looking for modules that are also in the ME Reference for the job. The configuration job will run on each of the matching modules.

If several configuration jobs will be included in the Module Discovery Trigger, the same ME Reference file can be selected for all jobs or different ME Reference files can be selected for different jobs. For example, you might want to define different configuration jobs for different model modules. In this case, you could have separate ME Reference files for each model.

You can define the modules on which to run a discovery configuration job by including one or more of the following pieces of information in the ME Reference file:

  • Sysname: Name of module
  • Serial number: Serial number of the module
  • Model: Module model
  • Management IP address: Can be specified with a subnet. Using a subnet is one of the most convenient ways of specifying modules for the Discovery Trigger.
  • Firmware: The active firmware of the modules
  • Parent IP address: The IP address of Skylight sensor: control. The modules will be managed by this Skylight sensor: control and only for Module Discovery Trigger.

Examples

Here are some examples of ME Reference files that could be used for the Module Discovery Trigger:

Management IP address. You can specify particular IP addresses, if they are known.
image.png

Management IP address with subnet. Skylight orchestrator will scan Unmanaged Modules & SFPs list for modules in the specified subnet.


Note: You cannot specify an IPv6 address with subnet in an ME Reference file.

The base IP address can only be in IPv4 format.

The subnet must be specified after the base IP address using CIDR notation: a forward slash followed by a value. For IPv4, the value can be from 0 to 32.

ipAddress/subnet

For example:
image.png

Serial number only. Skylight orchestrator will scan the Unmanaged Modules & SFPs list for the modules with the serial numbers specified in the ME Reference.

image.png

Model only. Skylight orchestrator will scan the Unmanaged Modules & SFPs list for all modules of the specified model.

image.png

Firmware. Skylight orchestrator will scan the Unmanaged Modules & SFPs list for all modules with the specified firmware.
image.png

Parent IP address. Skylight orchestrator will scan the Unmanaged Modules & SFPs list for all modules of a particular model on a subnet and manage the modules to Skylight sensor: control that are defined in the Parent IP address.
image.png

Any combination of the above. Skylight orchestrator will scan the Unmanaged Modules & SFPs list for modules matching all the specified parameters. For example, you might want to specify all modules of a particular model on a subnet.

image.png


Notes:

The subnet for Parent IP address is not supported.

If the Parent IP address is not entered, the module will be managed by the Skylight sensor: control that loaded those modules.


For more general information about ME Reference datasets and how to prepare them, see "About ME Reference Datasets (Device Datasets)".

Preparing Configuration Jobs for the Module Discovery Trigger

The Module Discovery Trigger includes one or more configuration jobs that are set up in the standard way in the Job Configuration page (Commission ▶ Jobs). For an introduction to configuration jobs, see "About Configuration Jobs".

Typically, when new modules are going to be installed on the network, a network administrator prepares the configuration jobs at the same time as the ME Reference files listing the new modules.

Here are some guidelines for preparing configuration jobs for the Module Discovery Trigger:

  • A configuration job (included in the Module Discovery Trigger) must use an ME Reference dataset to define the list of modules. For a detailed procedure for setting up a configuration job that uses an ME Reference, see "Creating Configuration Jobs Using Data Sets"
  • A configuration job (included in the Module Discovery Trigger) can include multiple configuration steps.
  • A configuration step can be set up in GUI mode (set directly in the Job Configuration page). This means that the parameters for all modules will be set to the same values. See "Creating Configuration Jobs in GUI Mode".
  • Alternatively, a configuration step can be set up using a configuration step dataset file.
    This means that parameters can be set to different values on different modules. If you will be using configuration dataset files, you must prepare them before setting up the configuration job. See "Creating a Configuration Step Dataset File".

Making Selections in the Module Discovery Trigger Page with Configuration jobs

The final task in setting up the Module Discovery Trigger is making a few selections in the Module Discovery Trigger page. You must enable the trigger and select one or more configuration jobs.

  1. Access the Module Discovery Trigger page by selecting Commission ▶ Module Discovery Trigger.

  2. Click the icon.png button (in the upper left corner of the page) [Configure discovery scheduler parameters]. The Module Discovery Trigger dialog is displayed.
    Setting Up the Module Discovery Trigger with Job Configurations_1.png

  3. In Configuration jobs, check Enable.

  4. Drag the configuration job(s) that you want to include in the Configuration jobs of Module Discovery Trigger from the list of jobs on the left side of the page to the list on the right side of the page.

  5. When you have finished selecting configuration jobs, click Apply, then click Close. For descriptions of the settings in the Configuration jobs of Module Discovery Trigger dialog, see the following table.

Module Discovery Trigger with Configuration jobs (Commission ▶ Module Discovery Trigger ▶ Configuration jobs)

ParameterDescription
Enable
  • Checked: The Module Discovery Trigger with Configuration jobs is enabled and will scan the Unmanaged Modules & SFPs list periodically looking for new modules that match the modules listed in the ME Reference file for a selected configuration job.
  • Unchecked: The Module Discovery Trigger with Configuration jobs is disabled.
Configuration job name (list on the left side)The configuration jobs defined in Skylight orchestrator. To include a job in the Module Discovery Trigger, drag it from the list on the left side of the page to the list on the right side of the page.
Configuration job name (list on the right side)The configuration jobs that have been selected for the Module Discovery Trigger. You can delete a job from the list by selecting the job, clicking the X (above the list) and clicking Apply (at the bottom of the dialog).

© 2024 Cisco and/or its affiliates. All rights reserved.
 
For more information about trademarks, please visit: Cisco trademarks
For more information about legal terms, please visit: Cisco legal terms

For legal information about Accedian Skylight products, please visit: Accedian legal terms and tradmarks



Was this article helpful?

Changing your password will log you out immediately. Use the new password to log back in.
First name must have atleast 2 characters. Numbers and special characters are not allowed.
Last name must have atleast 1 characters. Numbers and special characters are not allowed.
Enter a valid email
Enter a valid password
Your profile has been successfully updated.