CLI Add-On Profile

Information About the CLI Add-On Profile

Using a CLI add-on profile, you can specify CLI commands to execute on devices. You can execute device configurations that are not available through other configuration group features.

Commands in a CLI add-on profile operate together with the configurations provided through configuration group features. However, commands in the CLI add-on profile override configurations specified by corresponding configuration group features. One use case for the CLI add-on profile is to add commands to temporarily override a setting configured in a configuration group feature without changing the feature.

Format

When you add commands to a CLI add-on profile, enter them as they appear in the output of the show sdwan running-config command.

CLI Add-On Profile Restrictions

  • Ensure that you only use configuration commands as they appear in the output of the show sdwan running-config command.

  • Use only supported commands in the CLI add-on profile, which are the qualified commands documented in the Cisco IOS XE Catalyst SD-WAN Qualified Command Reference. Using unsupported commands in the CLI add-on profile can cause errors when deploying a configuration group to devices.

Create a CLI Add-On Profile

Before You Begin

Ensure that there is at least one configuration group in the Configuration Groups list.

This procedure adds a CLI add-on profile to a configuration group that does not have one. For information about editing an existing CLI add-on profile, see Edit a CLI Add-On Profile.

Create a CLI Add-On Profile

  1. From the Cisco SD-WAN Manager menu, choose Configuration > Configuration Groups.

  2. Adjacent to a configuration group, click … and choose Edit.

  3. In the Feature Profiles - Unconfigured area, locate CLI Profile.


    Note

    If the configuration group already has a CLI profile configured, this option will not appear.

  4. On the CLI Profile card, click Start Configuration.

    An Edit Config Feature pane opens.

  5. Enter a name and, optionally, a description for a new CLI add-on profile.

  6. Enter configuration commands in the CLI Configuration area or click Import Config File to import a configuration.

  7. To convert a configuration value to a variable, select the value and click Create Variable.

    Enter the variable name, and click Create Variable. You can also type a variable name directly, in the format {{variable-name}}. Example: {{hostname}}

    Variables enable you to enter values for the variables individually for each device when you deploy a configuration group to devices. During the deployment, you can enter values manually or using a CSV file.

  8. To encrypt a plain-text password using type 6 encryption, select the password and click Encrypt Type 6.

    In the example below, you can select the password, ABCD, and click Encrypt Type 6 to encrypt the password. 

    server-private 10.0.0.1 key 0 ABCD

    For more information about type 6 encryption, see Type 6 Passwords on Cisco IOS XE SD-WAN Routers in the Cisco Catalyst SD-WAN Systems and Interfaces Configuration Guide, Cisco IOS XE Catalyst SD-WAN Release 17.x.


    Note

    Encrypt only passwords. Encrypting a CLI command may cause a failure when deploying the configuration group to devices.

  9. Click Save.

Edit a CLI Add-On Profile

Before You Begin

Ensure that there is a configuration group with a CLI add-on profile configured, in the Configuration Groups list. For information about creating a CLI add-on profile, see Create a CLI Add-On Profile.

Edit a CLI Add-On Profile

  1. From the Cisco SD-WAN Manager menu, choose Configuration > Configuration Groups.

  2. In the CLI add-on profile, adjacent to the config feature, click … and choose Edit Feature.

  3. Edit the configuration commands in the CLI Configuration area or click Import Config File to import a configuration.

  4. To convert a configuration value to a variable, select the value and click Create Variable.

    Enter the variable name, and click Create Variable. You can also type a variable name directly, in the format {{variable-name}}. Example: {{hostname}}

    Variables enable you to enter values for the variables individually for each device when you deploy a configuration group to devices. During the deployment, you can enter values manually or using a CSV file.

  5. To encrypt a plain-text password using type 6 encryption, select the password and click Encrypt Type 6.

    In the example below, you can select the password, ABCD, and click Encrypt Type 6 to encrypt the password. 

    server-private 10.0.0.1 key 0 ABCD

    For more information about type 6 encryption, see Type 6 Passwords on Cisco IOS XE SD-WAN Routers in the Cisco Catalyst SD-WAN Systems and Interfaces Configuration Guide, Cisco IOS XE Catalyst SD-WAN Release 17.x.


    Note

    Encrypt only passwords. Encrypting a CLI command may cause a failure when deploying the configuration group to devices.

  6. Click Save.