supportsave (SCP)

Collects logs from different modules and uploads the logs into a remote SCP server.
Syntax
supportsave [ all | cancel | core | custom | info | infra | l2 | l3 | os | platform | spx | system | tag | [ unit-id number | tag ] ]
supportsave [ ipv4address ] [ show ]
supportsave [ add_cust_cmd_index { decimal_value "string" } ]
supportsave [ del_cust_cmd_index { all integer } ]
supportsave [ info disable | info enable | list_cust_cmd | show ]
Command Default

The supportsave functionality is not active.

Parameters
all
Sends all information to the remote SCP server.
cancel
Cancels the supportsave command operation.
core
Sends core information to the remote SCP server.
custom
Sends custom list of information to the remote SCP server.
info
Displays information about the supportsave command. If info is enabled, then the collected commands contain additional information like BEGIN, CONTEXT, TIME STAMP, HW/SW INFO, and so on.
infra
Sends infrastructure information to the remote SCP server.
l2
Sends Layer 2 information to the remote SCP server.
l3
Sends Layer 3 information to the remote SCP server.
os
Sends Operating System information to the remote SCP server.
platform
Sends platform information to the remote SCP server.
spx
Sends Sequenced Packet Exchange (SPX) information to the remote SCP server.
system
Sends system information to the remote SCP server.
tag
Appends a text string to the collected file name on the remote SCP server.
unit-id number
The unit number can be any ID present in the stack. The unit ID accepts only one integer. The logs are collected from the corresponding unit ID and send it to remote server.
show
Displays the amount of percentage executed in the currently executing command process.
ipv4address

Designates the IP address for the remote server.

add_cust_cmd index integer

Adds the given command at the given index in the custom commands list. If there is already a command present at the index passed, then add operation will fail.

string
The CLI command which is to be added. There is no default value.
integer
Index where the command will be added. Valid range 1 to 32. This is a mandatory parameter, with no default value.
del_cust_cmd index

Deletes the given command at the given index in the custom commands list. If there is already a command present at the index passed, then add operation will fail.

all
Removes all configured custom commands from the supportsave list.
integer
Index where the command will be deleted. Valid range 1 to 32. This is a mandatory parameter, with no default value.
info disable
Disables the header to be displayed for all show commands being executed.
info enable
Enable the header to be displayed for all show commands being executed.
list_cust_cmd
Displays the custom command list.
Modes

Privileged EXEC mode

Usage Guidelines

The collected logs are shared with the technical support personnel for investigating issues seen on the device. Once the supportsave command is executed, logs are collected and uploaded into the remote SCP server.

Parallel execution of supportsave command from two different sessions is not allowed. Parallel execution of supportsave command and the copy tftp or copy scp commands is not allowed.

The supportsave command supports IPv4.

A maximum of 32 commands can be added to the custom command list. Commands are not expanded while adding a command to the custom commands list. It is recommended not to add any filters with the commands.

Modifying the custom commands list using supportsave add_cust_cmd or supportsave del_cust_cmd is not allowed while supportsave data collection is in progress.

Time taken by the supportsave commands depends on the commands present in the list and the distance of SCP server.

In order to avoid looping, the supportsave command cannot be added to the custom command list. Also, the commands which changes the CLI mode (exit, quit) and commands which restart the router (switchover, reload) are not accepted.

The tag string should be less than 11 characters.

The supportsave command uses the outbound SSH session

SCP operations are not allowed while supportsave is in progress.

Cancelling the supportsave command during the file transfer does not cancel the current file transfer. While cancelling the supportsave command, you must wait for the current file transfer to complete before executing the supportsave command again.

Supportsave is not High Availability (HA) aware.

The supportsave command aborts when the remote server is terminated. Additionally, when the data is collected from the remote unit, and if the corresponding unit is powered off, the supportsave command is terminated.

Use the supportsave cancel command to stop supportsave opertations.

Examples

Example of supportsave command collecting Layer 3 information.

device# supportsave l3 scp 10.xx.xx.104 
User name:root
Password:Supportsave started. This operation may take several minutes.
Press "Shift-A" to abort supportsave operation.
asethura####################################################################
Connecting to remote host......

Sending data (8192 bytes per dot)
.

SCP transfer from device completed

Connection Closed

Supportsave completed in 1 seconds

Example of supportsave command adding a custom command to the fifth position in the index.

device# supportsave add_cust_cmd index 5 "host-max-num 512"

Example of supportsave command deleting a custom command from the fifth position in the index.

device# supportsave del_cust_cmd index 5 
History
Release version Command history
08.0.61 This command was introduced.