Configuration Flow Executors: Overview
  • 21 Jun 2024
  • 3 Minutes to read
  • Contributors
  • PDF

Configuration Flow Executors: Overview

  • PDF

Article summary

If you operate and maintain a network, you will use configuration flow executors to run configuration flow profiles. Each time you need to execute a configuration flow profile on one or more devices, you must create a new configuration flow executor. You can create a new executor or duplicate an existing one. After creating an executor, you run it and finally you view the execution status.

In the flow executor, you will select the devices on which the profile should be applied. You will also enter values for the parameters that were defined with flow tokens (variables) in the templates that are in the flow profile.
In addition to defining the configuration workflows to be executed on the network, the executors serve as a log of the configuration work that has been performed.

The following image shows the main steps in creating a configuration flow executor. For a detailed procedure, see "Creating a Configuration Flow Executor".


Note: From release Skylight orchestrator 23.12 and later, you can use Data Sets in the flow executor to assign the devices and values for the parameters that were defined with flow tokens (variables) in the templates found in the flow profile. For a detailed procedure, see "Creating a Configuration Flow Executor using Data Sets"

Overview of Creating a Configuration Flow Executor
Configuration Flow Executors Overview.PNG

Creating a configuration flow executor includes:

  • Executor name: Enter a name for the executor.
  • Number of failures: Enter a value to limit attempts at running the executor.
  • Profile name: Select one profile to execute in the current executor.
  • Device selection: Select devices from either the Elements or Modules & SFPs tab.
  • Value: Enter values for parameters. Ensure that values have been entered for all parameters before you attempt to run or schedule the executor.

Viewing List of Flow Executors

Flow executors are set up and managed in the Commission ▶ Flow Executors page, which displays a list of the configuration flow executors that have already been defined.

To view existing configuration flow executors and their status

  1. Select Commission ▶ Flow Executors.
    The Flow Executors page is displayed with a list of all existing flow executors.
    Configuration Flow Executors Overview_2.PNG

The following table explains the information displayed in the list of flow executors.

Flow Executor Configuration (Commission ▶ Flow Executors)

ParameterDescription
Executor nameThe name of the flow executor.
Profile nameThe name of the profile.
SuccessThe number of devices on which execution was completed successfully.
FailuresThe number of devices on which execution failed.
Start timeThe date and time when execution started.
End timeThe date and time when execution finished.
StatusThe status of the executor. Possible values:
  • Created: The flow was created, but not started.
  • Starting: The flow was created and is starting.
  • Started: The flow was started.
  • Stopping: The flow was stopped and is in the process of stopping. There are still configuration items in progress.
  • Stopped: The flow was stopped.
  • Completed: The flow has been completed.
  • Completed with errors: The flow has been completed, but at least one failure occurred.
  • Waiting for results: The flow is waiting for results.
Export StatusThe status of the export. Possible values:
  • Not start: The export has not started.
  • In progress: The export is in progress.
  • Success: The export was successful.
  • Export failed: The export has failed.
  • Transfer failed: The transfer has failed.
Force deleteThis checkbox does not currently have any effect.

If you want to delete an executor, select it in the list and click the Button_Remove_Generic.png button.

To delete several executors at once, Ctrl-click to select the executors and click the Button_Remove_Generic.png button.

© 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.