About CLI Sets

A CLI set is a text file that contains a series of CLI commands. These commands are run on a device using a CLI configuration job. See "Setting Up a CLI Configuration Job".

CLI sets are useful whenever you must execute commands that are not supported in other configuration steps.

CLI Command Example

interface discovery edit state disable

Instructions to Legacy orchestrator in a CLI Set File

You can include special instructions for Legacy orchestrator in a CLI set file. The following instructions can be included in a CLI set file:

• [#continue#]: The CLI step continues execution regardless of the execution status of the command found on the next line.
• [#disconnect#]: Legacy orchestrator waits for the device to recover from the execution of the next command for approximately five minutes. For example, this instruction must come before a reboot command. See CLI Commands that Must be Preceded by a #disconnect Instruction on page 356
• [#interface#]: Legacy orchestrator attempts to restore the connection with the device after the execution of the next command. Use this instruction before using an interface edit command that may cause a temporary loss of contact with the management interface of the device.

You must follow these rules when including instructions in CLI set files:

• In a CLI set file, any line that contains one or more instructions to Legacy orchestrator will only be consumed by Legacy orchestrator. It will not be transmitted to the target devices. All commands intended for devices must be on their own lines in the CLI set file.
• You can combine the instructions [#continue#] with [#disconnect#] or the instruction [#interface#] on the same line using the following format: [#continue,disconnect#].
• You cannot combine the instructions [#disconnect#] and [#interface#].
• You cannot put instructions on two consecutive lines.

CLI Commands that Must be Preceded by a #disconnect# Instruction

The following commands can only be used after the instruction #disconnect# allowing a reconnect after a delay.

• configuration reset
• configuration rollback
• configuration import
• firmware rollback
• firmware upgrade
• reboot

Unsupported CLI Commands

A CLI script should not include any commands that would cause a permanent loss of connectivity with the element.
Examples of unsupported commands are provided below.

• exit
• quit

CLI Commands that Require User Interaction

In general, a CLI script should not include commands that require user interaction. These commands would reset the connection to the element.

However, certain commands that, by default, require user interaction may accept options that disable the need for user interaction. For example: vid-set show vid paging disable. For more information about the options available commands, see the CLI Command Guide for the particular element model.

Support CLI script for Provider Connectivity Assurance Sensor F100 and F25

Certain limitations arise when executing Provider Connectivity Assurance Sensor F100 and F25 commands in the CLI Sets.

• When using the reload command in the CLI sets, it must be followed by sleep 1:

[#disconnect#]
reload; sleep 1

• When using the configure terminal command, it must finish with the end keyword. The commands to configure the unit must be executed between these two keywords (configure terminal and end), as below:

configure terminal; interface vlan 1000; no shutdown; end

• If a command returns a warning message, it needs to preceded by the [#continue#] CLI instruction, as below:

[#continue#]
configure terminal; interface xl-ethernet 0/2; speed 1000; end

Unsupported CLI Actions

You cannot add any interface configuration action to a CLI set that would cause a loss of connectivity with the management of the device.

Here are some examples of unsupported CLI actions:

• Changing the management IP address of a device.
• Changing the credentials used to access the device.
• Changing the Access Control List of the user session currently being used by Legacy orchestrator to access the device.
• Terminating the user session currently being used by Legacy orchestrator to accessthe device.