.svg?sv=2022-11-02&spr=https&st=2024-11-22T23%3A23%3A18Z&se=2024-11-22T23%3A33%3A18Z&sr=c&sp=r&sig=O96pH8C3lBZYwUuTx5rvBJoFTDSb6Dwb7eZlk7AyGzI%3D){kind=logo}
Creating a Configuration Flow Profile
- 19 Sep 2024
- 4 Minutes to read
- Contributors
- Print
- PDF
Creating a Configuration Flow Profile
- Updated on 19 Sep 2024
- 4 Minutes to read
- Contributors
- Print
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
A configuration flow profile defines the list of configuration templates that are required for a particular workflow. A system administrator can create a variety of configuration profiles for different workflows.
You create a configuration flow profile from scratch in the Configuration flow profile window. You can also duplicate an existing configuration flow profile and adjust it as necessary.
Before creating a profile, you should ensure that all the required configuration flow templates
(that you want to include in the profile) have been created.
To create a Configuration flow profile
Access the page Commission ▶ Flow Profiles.
Click the Add flow profile
button.Alternatively, you can copy an existing profile by selecting the profile in the list and
clicking the Duplicate flow profile
button.To edit an existing profile, double-click it in the list.
Enter a name for the profile in the Profile name field.
Enter a description for the profile in the Description field.
In the list that includes the existing configuration jobs, identify the configuration flow templates that you want to include in the profile. Drag and drop each template from the list of existing jobs over to the pane on the right side of the window. As you drag templates to the selected list, the template's parameters will be added to the pane above which displays the profile parameter details. These are the parameters that are defined with variables in the templates.
If you need to change the order of the configuration templates in the selected list, drag and drop them in the required order. The templates will be executed in the listed order. This is important if certain templates are prerequisites for other templates.
In the area that displays the profile parameter details, enter descriptions for each of the parameters. These descriptions will help the person who must provide specific values for the parameters in a configuration flow executor. For more information, see the table below.
If values are available in the Device token filter field, select a device token to use as a filter in the configuration flow executor. Filtering by token is only available for certain types of parameters. For more information, see the table after this procedure.
Click Apply, then click Close.
button.
button.Configuration flow profile - Parameter Descriptions (Commission ▶ Flow Profiles)
General
| Parameter | Description |
|---|---|
| Profile name | The name of the configuration flow profile. |
Existing configuration jobs
| Parameter | Description |
|---|---|
| List of configuration templates | This is the list of configuration templates that have been created. Drag and drop the templates required for the profile from the list in the left pane into the list of Selected configuration jobs in the right pane. If you do not see all the templates that you require, you can create additional templates as explained in "Creating a Configuration Flow Template". |
Profile parameters detail (for selected configuration jobs)
| Parameter | Description |
|---|---|
| List of configuration templates | This is the list of configuration templates that have been selected. Drag and drop the templates required for the profile from the Existing configuration jobs list (on the left side of the window) to this list. After you drag a template into this list, any parameters that were defined with a variable are displayed in the Profile parameters detail section of the page. |
Profile parameters detail
| Parameter | Description |
|---|---|
| Parameter name | This list contains all the parameters that were defined with variables in the selected templates. A variable looks like this: ${parameterName} You cannot add or delete from this list in the profile. If the list of parameters must be changed, the changes must be made in the templates that are included in the profile. |
| Type | The parameter type is determined automatically by Legacy orchestrator based on the parameter field in the template. |
| Description | You must enter a description of the parameter beside the parameter in the Description column. Your description should help the person who will create an executor for the template to understand the purpose of the variable so that they can enter an actual value in the executor. Examples: Physical location of the device UDP port MAC address of Node A |
| Device token filter | This filter uses device tokens. For certain types of parameters (port, interface and MAC address), the system administrator can select a device token to use as a filter in executors that will be used to run this profile. Selecting a device token in the profile will have an impact when the operator selects a parameter value in the executor. Legacy orchestrator will use the selected device in each device token to filter the possible values for the parameter. Note: Currently, filtering by device token only works when a single device is selected for a token. When multiple devices are included in the token list, parameter values will not be filtered. Filtering by device token is only available for parameters of these types:
Here is an example of how to use a device token as a filter:
|
| Selector enabled | If the variable type is port or interface, a selector can be enabled that displays the ports and interfaces in inventory. When creating a flow profile instance, the user can select from that inventory. |
© 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?