.svg?sv=2022-11-02&spr=https&st=2024-12-22T23%3A01%3A44Z&se=2024-12-22T23%3A11%3A44Z&sr=c&sp=r&sig=BD7EWnDUHHFgtQD4t4sl760t0vA854ilr2IfM5JgR1Y%3D){kind=logo}
Creating a Configuration Flow Executor
- 21 Jun 2024
- 5 Minutes to read
- Contributors
- Print
- PDF
Creating a Configuration Flow Executor
- Updated on 21 Jun 2024
- 5 Minutes to read
- Contributors
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
A configuration flow executor sets up the final details of how a particular configuration flow profile will be executed. In a configuration flow executor, the user must:
- Select the configuration flow profile to apply to the network (in the Profile selection tab).
- Select the devices on which the profiles will be applied (in the Device selection tab). Different templates may be applied to different types of devices-depending on the token that was defined for each template.
- Enter actual values for the parameters that were defined with flow tokens (variables) in the templates included in the profile (in the Parameters input tab).
You can create a configuration flow executor from scratch in the flow executor dialog. When an executor has been created for a profile, you can reuse it or duplicate it, then enter a new name, select devices, and keep or change values for the exposed parameters.
To create a configuration flow executor
Access the page Commissioning ▶ Flow Executors.
Select the Add flow executor
button. Alternatively, to copy an existing executor, select it in the list and select the Duplicate flow executor 
button. To reuse an existing executor, double-click it in the list.
The Configuration flow profile dialog is displayed. The Profile selection tab is on top.Enter a name for the executor in the Executor name field.
(Optional) Enable the Number of failures checkbox to limit the number of attempts to execute the profile. Then enter a number in the Number of failures field.
In the Profile name tab, check the profile that you wish to execute. Only one profile can be selected.
Select the Device selection tab.
Drag devices from the list of available devices (in the left pane) to the appropriate group of target devices (in the right pane). For more information about selecting devices, see NE_TOKEN in the table after this procedure.
Select the Parameters Input tab.
Enter values for all parameters in the list. If you duplicated or are reusing the executor, values will already be displayed. You can change the values, if necessary.
Click Apply.
To execute the configuration flow immediately, select the Execution status tab and click the Start Executor button.
Click Close button to close the Configuration flow executor dialog.
Click the Refresh
button to refresh the user interface.
button. Alternatively, to copy an existing executor, select it in the list and select the Duplicate flow executor 
button. To reuse an existing executor, double-click it in the list.
button to refresh the user interface.Configuration flow executor dialog - Parameter descriptions (Commissioning ▶ Flow Executor)
General
| Parameter | Description |
|---|---|
| Executor name | The name of the executor. |
| Number of failures | Enter a value if you want to limit the number of attempts at running the executor. If you use the Executor Scheduler function, this is recommended. Leave the field blank if you want to let the user run the executor an unlimited number of times. |
Profile name - Flow Profile
| Parameter | Description |
|---|---|
| Profile name | This column lists the names of the profiles that have been defined. You can only select one profile to execute in the current executor. |
| Description | This column contains descriptions that are available for the profiles that have been defined. Some profiles may not have a description because no description was entered in the profile itself. It is possible to add a description to a profile, if necessary, by editing the profile. See "Creating a Configuration Flow Profile". |
Device selection tab
| Parameter | Description |
|---|---|
| List of available devices Elements/ Modules & SFPs tabs (left pane) | This is the list of managed devices to which the selected profile could be applied. You can order the list by any of the columns, by clicking the heading column and choosing Sort Ascending or Sort Descending. If you want to apply the selected profile to a device, drag the device from the list in the left pane to the appropriate section in the right pane (where devices are grouped by Device token). See the description of Device token below in this table. |
| Selected devices (right pane) Device token | The right pane contains a section for each of the tokens (Device token or device tokens) used in the selected profiles. Tokens indicate which devices the configuration flow should be applied to. Typically, tokens are used to indicate the role of the device in a configuration flow. For example, in the configuration flow for a PAA test, the token in one template is NODE_A and the token in a second template is NODE_Z. If the PAA test profile is selected in the executor, two sections would be displayed on the right side of the page: NODE_A and NODE_Z. You would drag aggregator devices from the left side of the page to the NODE_Z section (in the right pane), and other devices to the NODE_A section (also in the right pane). |
Parameter input
| Parameter | Description |
|---|---|
| Description | This column contains descriptions of the parameters that require values. The parameters were defined in the templates that are included in the profile selected for execution. |
| Type | The parameter type is determined automatically by Skylight orchestrator based on the parameter field in the template. |
| Value | This column contains the values that will be used for the parameter when the profile is executed. You can double-click in a row to enter a value. The field is enabled to accept a value. A value may already appear beside the description of a particular parameter. This happens when you duplicated or are reusing an executor. If no value appears beside the description of a parameter, it is because you are creating a new executor from scratch. You must ensure that values have been entered for all parameters before you attempt to run or schedule the executor. Note: If you assign values that contain spaces for the token defined in the CLI flow template configuration, you must add \" characters around the value to ensure the execution functions correctly. |
Execution status
| Parameter | Description |
|---|---|
| Status | This section gives the overall status of the configuration jobs that were applied to the network. Possible values are:
|
| Configuration jobs | This section (in the right pane) lists all of the configuration jobs (and details) that were executed by this configuration flow executor. |
| Execution log | This section (in the left pane) can display the execution log for any of the configuration flows in the list in the right pane. To view the execution log for a particular configuration flow, click anywhere in the row for the configuration flow. |
© 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?