Documentation forKiwi CatTools

Device.CLI.Send commands

The Device.CLI.Send commands activity allows you to issue a series of CLI commands to the selected devices as if you were typing them from the normal command line prompt, or Enable mode, if that option is checked.

The Device.CLI.Send commands activity automatically performs the following actions:

  1. Log in to the device.
  2. Handle any terminal display window length issues.
  3. Enter enable or privileged mode, if optioned.
  4. Enter specified commands in sequence, and wait for a valid response.
  5. Log each command entered and the device response to a text log file.
    Should an error occur, the activity aborts, if optioned.
  6. Disconnect from the device.

Setting up the activity for Device.CLI.Send commands

For information on setting up activities, see Add / Edit scheduled activity details.

Activity options

Configure the options specific to this activity in the Options tab.

List of commands to be entered into the device (Max 10,000 chrs)

Enter commands to change the configuration of selected devices.

For example, some CLI commands that can be entered are:

On a Cisco router:

Clear counters 
Clear interface

On a Cisco Catalyst CatOS switch:

Set Port 1/1 disable 
Set Port 2/12-24 enable

Each command must be entered on a separate line. If you enter a blank line between commands, this is applied just as if you pressed enter in a telnet session. The maximum limit is 10,000 characters.

You may also enter meta commands in the list of commands. For more information, see Meta Commands.
Or, read commands from file

Reads commands from the specified text file entered.

This option and "Config commands to be entered into the device" are mutually exclusive. If you select this option, the config commands field is deactivated, and the commands are only read from the text file.

The rules for entering commands in the text file are the same as the config commands field. Every line is read as a command to be entered in the devices config mode. A blank line between commands is read as an <Enter>. However, the text file does not have a limit on the number of characters allowed.

Enter commands in enable mode

CatTools enters enable mode before entering any of the commands to the device.
Save device output to file

Text file containing a device-specific record of each time the activity runs. All output from the device is recorded to a text file, exactly as it would appear in a telnet session. The file name is based on the device name and the date. Each device creates its own unique output file based on the %DeviceName% and %DateISO% variables.
Overwrite existing capture file

Overwrites the file created by the output from the last run of the Device.CLI.Send commands activity.

If unselected, the existing file is appended. A new file is created only when the activity's run date is different.
Answer [yes] to any confirmation prompts

Some issued commands have confirmation prompts, such as: "Are you sure? Y or N". CatTools automatically answers such prompts in the affirmative, on the assumption that if you entered the commands you want them to be executed.

If this option is unchecked, then the activity will enter N(for "No") in response to any command confirmation prompts.
Stop on error The activity immediately quits the job and returns control to CatTools if an error is encountered at any stage of processing.
Send output via e-mail Sends a report of activity results to a designated email address. The report can be sent as either an attachment or included in the body of the email.
Zip attachments To reduce network traffic and allow for password protection, you can choose to zip the attachments. This is the recommended and default option. It keeps the e-mail smaller and places all the files in a single attachment, which can be beneficial when you have, for example, 400 devices.
Password protect zip file Protect your configs and reports by adding a password to your zip file. A password protects your files over insecure mediums while in transit to your e-mail box. SolarWinds recommends using current password strength standards when creating a password for your files.