supportsave

Collects logs from different modules and uploads the logs into a remote SCP or TFTP server.
Syntax
supportsave [ add_cust_cmd | all | cancel | core | del_cust_cmd | info | infra | l2 | l3 | list_cust_cmd | os | platform | show | system ] [ scp | tftp ] [ ipv4-address ] [ server-path ] [ optional-tagname ]
Command Default

The supportsave functionality is not active.

Parameters
add_cust_cmd
Adds the given command at the given index in the custom commands list. If there is already a command present at the index passed, the add operation fails.
all
Sends all information to the remote server.
cancel
Cancels the supportsave command operation.
core
Sends core information to the remote server.
del_cust_cmd
Deletes the given command at the given index in the custom commands list. If there is already a command present at the index passed, the delete operation fails.
info
Displays information about the supportsave command. If info is enabled, the collected commands contain additional information such as BEGIN, CONTEXT, TIME STAMP, HW/SW INFO, and so on.
infra
Sends infrastructure information to the remote server.
l2
Sends Layer 2 information to the remote server.
l3
Sends Layer 3 information to the remote server.
list_cust_cmd
Displays the custom commands list.
os
Sends operating system (OS) information to the remote server.
platform
Sends platform information to the remote server.
show
Displays the percentage completed in the currently executing command process.
system
Sends system information to the remote server.
scp
Specifies the remote SCP server.
tftp
Specifies the remote TFTP server.
ipv4-address
Specifies the IP address for the remote server.
server-path
Specifies the file pathname for the remote server in ASCII text. The name can be up to 128 characters in length. The default is /.
optional-tagname
Appends a text string to the collected file name on the remote server.
Note: Not all parameters are supported for FastIron 09.0.0 but will be available in an upcoming patch release.
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 run, logs are collected and uploaded into the remote server.

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

When upgrading from FastIron 08.0.95c, it is recommended that you use the supportsave command and clear the core files before the upgrade.

The supportsave command supports IPv4.

A maximum of 32 commands can be added to the custom commands 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.

Run time for the supportsave command depends on the commands present in the custom commands list and the distance of the remote server.

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

The tag string should be 10 characters or less. If more than 10 characters are entered, an error message: "File tag is longer than max(10) chars".

The supportsave command uses the outbound SSH session.

SCP or TFTP 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 running 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 operations.

Examples

The following example collects 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

The following example adds a custom command to the fifth position in the index.

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

The following example deletes a custom command from the fifth position in the index.

device# supportsave del_cust_cmd index 5 

The following example sends all information to the default remote TFTP server.

device# supportsave all tftp 10.176.198.2 / CustTagNam
History
Release version Command history
08.0.61 This command was introduced.
09.0.00 The command syntax was modified.