supportsave

Collects logs from different modules and uploads the logs into a remote SCP or TFTP server.
Syntax
For IPv4:

supportsave [ add_cust_cmd | all | cancel | core | logs | del_cust_cmd | infra | l2 | l3 | list_cust_cmd | os | platform | system | delete ] [ scp | tftp ] [ ipv4-address ] [ server-path ] [ optional-tagname ] [ unit unit-number ] { all | unit unit-number }

For IPv6:

supportsave [ add_cust_cmd | all | cancel | core | logs | del_cust_cmd | infra | l2 | l3 | list_cust_cmd | os | platform | system | delete ] [ scp | tftp ] [ ipv6 ] [ ipv6-address ] [ server-path ] [ destination-directory name ] [ optional-tagname ] [ unit unit-number | all ] { all | unit unit-number }

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.
custom
Collects all custom commands.
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.
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.
system
Sends system information to the remote server.
scp
Specifies the remote SCP server.
tftp
Specifies the remote TFTP server.
logs
Collects all the logs but does not include core files.
delete all

Delete all supportsave core files from all units.

delete unit

Delete supportsave core files from a specified unit.

unit

Specify a unit number from which the respective supportsave logs are to be collected.

unit-number

Enter a valid unit number. The unit numbers range from 1 to 12. For multiple units, use a space as a separator.

all

Collect all supportsave log files from all units.

ipv6-address
Specifies the IPv6 address for the remote server.
ipv4-address
Specifies the IPv4 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 /.
unit-number

Specify the unit number from which the core files need to be deleted. The unit numbers range from 1 to 12.

optional-tagname
Appends a text string to the collected file name on the remote server.
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.

Note: In FastIron release 10.0.10d, the maximum number of core files is limited to 2 for all the ICX platforms.

The supportsave command supports IPv4. Beginning with FastIron release 10.0.20, supportsave supports IPv6 also.

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. When supportsave is initiated during NTP synchronization, the time taken to complete supportsave may display incorrect values in the FastIron 10.0.10f release.

Beginning with FastIron 10.0.10f, the supportsave command supports management Virtual Routing and Forwarding (VRF).

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.

The supportsavecommand records the details of individual module commands and the output of common commands, such as show running-config, show clock, and show configuration, in a separate file.

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 core files.

device# supportsave core scp 10.xx.xx.104 /vtest/ sfile234
Gathering information. SupportSave has started. It will take sometime for completion, 
depending on the size of the SupportSave file.
Login:xxxx
Password:
 
Uploading file: 20241028_163534-fm-tmp-2.tgz
Parameter Validation Successful
File Upload Started
Time taken to upload file: 22 seconds
File Upload Complete
 
Uploading file: 20241028_163534-fm-tmp-1.tgz
Parameter Validation Successful
File Upload Started
Time taken to upload file: 12 seconds
File Upload Complete
 
Uploading file: supportsave_ramacOct28_609c9f523a26_20241028_163534.tgz
Parameter Validation Successful
File Upload Started
Time taken to upload file: 3 seconds
File Upload Complete

Uploading file: 20241028_163534-fm-tmp-3.tgz
Parameter Validation Successful
File Upload Started
Time taken to upload file: 45 seconds
File Upload Complete
 
Supportsave took 158 seconds

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

device# supportsave all tftp 10.176.198.2 / CustTagNam
Gathering information. SupportSave has started. 
It will take sometime for completion, depending on the size of the SupportSave file.

Uploading file: 20241028_163534-fm-tmp-2.tgz
Parameter Validation Successful
File Upload Started
Time taken to upload file: 22 seconds
File Upload Complete
 
Uploading file: 20241028_163534-fm-tmp-1.tgz
Parameter Validation Successful
File Upload Started
Time taken to upload file: 12 seconds
File Upload Complete
 
Uploading file: supportsave_ramacOct28_609c9f523a26_20241028_163534.tgz
Parameter Validation Successful
File Upload Started
Time taken to upload file: 3 seconds
File Upload Complete

Uploading file: 20241028_163534-fm-tmp-3.tgz
Parameter Validation Successful
File Upload Started
Time taken to upload file: 45 seconds
File Upload Complete
 
Supportsave took 158 seconds
Note: If supportsave was cancelled through Ctrl-C, 
please run 'supportsave cancel' command before collecting Supportsave again.

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

device# supportsave all tftp ipv6 2001:df3:80d:8221::147 /
Gathering information....SupportSave has started. 
It will take around 15 to 45 minutes for completion, depending on the size of the SupportSave file. 
SYSLOG: <14> Nov 21 20:50:12 ICX8200 Router SupportSave collection started  
SupportSave: SupportSave collection status: Complete. Supportsave file supportsave_c0c5207e9c66_20241121_205012.tgz.
Supportsave completed in 448 seconds 

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

device# supportsave all scp ipv6 2001:df3:80d:8221::147 /
Gathering information....SupportSave has started. It will take sometime for completion, depending on the size of the SupportSave file.
Login:
SYSLOG: <14> Nov 27 06:41:37 ICX8200 Router SupportSave collection started  
fiuser
Password:
Uploading file: 20241127_064158-fm-tmp-1.tgz
Parameter Validation Successful
File Upload Started
SYSLOG: <14> Nov 27 06:43:59 ICX8200-48PF Router Download: FILE UPLOAD START  
SYSLOG: <14> Nov 27 06:44:42 ICX8200-48PF Router Download: FILE UPLOAD COMPLETED  
Time taken to upload file: 43 seconds
File Upload Complete
Uploading file: 20241127_064158-fm-tmp-3.tgz
Parameter Validation Successful
File Upload Started
SYSLOG: <14> Nov 27 06:44:42 ICX8200-48PF Router Download: FILE UPLOAD START  
SYSLOG: <14> Nov 27 06:45:49 ICX8200-48PF Router Download: FILE UPLOAD COMPLETED  
Time taken to upload file: 67 seconds
File Upload Complete
Uploading file: supportsave_c0c5207e9c66_20241127_064158.tgz
Parameter Validation Successful
File Upload Started
SYSLOG: <14> Nov 27 06:45:49 ICX8200-48PF Router Download: FILE UPLOAD START  
SYSLOG: <14> Nov 27 06:45:52 ICX8200-48PF Router Download: FILE UPLOAD COMPLETED  
Time taken to upload file: 3 seconds
File Upload Complete
Uploading file: 20241127_064158-fm-tmp-2.tgz
Parameter Validation Successful
File Upload Started
SYSLOG: <14> Nov 27 06:45:53 ICX8200-48PF Router Download: FILE UPLOAD START   
SYSLOG: <14> Nov 27 06:47:02 ICX8200-48PF Router Download: FILE UPLOAD COMPLETED  
Time taken to upload file: 69 seconds
File Upload Complete
Supportsave took 326 seconds
Note: If supportsave was cancelled through Ctrl-C, please run 'supportsave cancel' command before collecting Supportsave again.

The following example collects all the logs but does not include the core files.

device# supportsave logs scp 10.246.201.87 ~/ss_tntr lgs_vrfy
Gathering information....SupportSave has started. 
It will take sometime for completion, depending on the size of the SupportSave file.
 
Login:sk1211
 
Password:
 
Uploading file: supportsave_lgs_vrfy_609c9f51e752_20241115_124628.tgz
Parameter Validation Successful
File Upload Started
..

Time taken to upload file: 3 seconds
File Upload Complete

Uploading file: supportsave-lgs_vrfy-20241115_124628-fm-tmp-1.tgz
 
Time taken to upload file: 0 seconds
Download already in progress
 
Retrying upload
 
Uploading file: supportsave-lgs_vrfy-20241115_124628-fm-tmp-1.tgz
 
Time taken to upload file: 0 seconds
Download already in progress
 
Retrying upload
 
Uploading file: supportsave-lgs_vrfy-20241115_124628-fm-tmp-1.tgz
Parameter Validation Successful
File Upload Started
..

Time taken to upload file: 4 seconds
File Upload Complete
 
Supportsave took 80 seconds

The following example enables supportsave for a particular unit.
device# supportsave all scp 10.176.198.2 / CustTagNam unit 2 
The following example enables supportsave for core files for a particular unit.
device# supportsave all core all scp 10.176.198.2 / CustTagNam unit 2 
The following example deletes the supportsave core files from a specified unit.
device# show files cores
F        14812358 core_853_FastIron-8_2024-11-07_08-38-00.gz
F        451502 core_2006_fi_syslog-9_2024-11-12_15-32-45.gz
15263860 bytes 2 File(s) in cores

device# supportsave delete unit 1
History
Release version Command history
08.0.61 This command was introduced.
09.0.00 This command syntax was modified.
10.0.20 This command was modified to support IPv6.
10.0.10f, 10.0.20b_cd1 This command was modified to support management VRF.
10.0.10g_cd1 This command was modified to add the logs, unit, and delete keywords.