supportsave

Use the supportsave utility for collecting logs from the driver, internal libraries, and firmware. The collected logs are shared with the technical support personnel for investigating issues seen on the device.
Syntax
supportsave { all | custom | infra | l2 | l3 | os | platform | spx | system } { tftp_server_ IP tftp_ server's_ relative_ path_name [ user_tag ] | display | unit-id unit-number }
supportsave core { tftp_server_ IP tftp_ server's_ relative_ path_name [ user_tag ] | unit-id unit-number }
supportsave cancel
Parameters
all
Collects all supportsave related log files.
core
Collects core logs from all devices.
custom
Executes all commands present in the default and custom commands list and sends the output to the specified TFTP server address.
infra
Collects stacking related information.
l2
Collects Layer 2 related information.
l3
Collects Layer 3 related information.
os
Collects operating system (OS) related information.
platform
Collects platform related information.
spx
Collects SPX related information.
system
Collects all general commands information.
tftp_server_ IP
Specifies the IP address of the TFTP server.
tftp_ server's_ relative_ path_name
Specifies the file path name of TFTP server relative to TFTP server's default directory to dump supportsave logs. To specify the default directory itself, use '/'.
user_tag
Specifies the user tag to be added in the supportsave collected file name. Maximum of 10 characters are allowed.
display
Displays the supportsave information (except the non-textual output like core files) in the console window.
unit-id unit-number
Collects data from a specific stack or PE unit and the active unit and sends to the TFTP server. If the specified unit-id and the active unit are same, only the active unit data is collected.
cancel
Cancels supportsave.
Modes

Privileged EXEC mode

Usage Guidelines

The supportsave command has the following advantages over the show tech-support command:

  • Allows you to add additional commands to collect more data.
  • Allows to transfer the collected data to an external server such as Trivial File Transfer Protocol (TFTP) server.

TFTP is disabled by default, if FIPS is enabled. Enable TFTP manually for uploading supportsave data. It is a prerequisite to have the TFTP server with a write permission and the server must be accessible from the device.

Use the fips policy allow tftp-access command in configuration mode to enable TFTP access while the FIPS is enabled.

Limitations and prerequisites

The following are the limitations and pre-requisites of the supportsave utility:

  • Parallel execution of the supportsave command from two different sessions is not allowed.
  • Parallel execution of the supportsave command and the copy tftp/scp commands is not allowed.
  • It is recommended that you do not run any CLIs when supportsave operation is in progress.
  • Only IPv4 address is supported for the TFTP destination.
  • Only up to 32 commands can be added to the custom command list.
  • Commands are not expanded while adding a command to the custom commands list.
  • Commands added to the custom command list must be privileged EXEC mode MP commands.
  • It is recommended that you do not add any filters with the commands.
  • The supportsave command cannot be added to the custom commands list. Also, the commands which change the CLI mode (exit, quit, end) and commands which restart the router (switchover, reload, reload-yes) must not be added.
  • Modifying the custom commands list using the supportsave add-cmd or supportsave del-cmd commands is not allowed while the supportsave data collection is in progress.
  • Time taken by the supportsave command depends on the commands present in the list.
  • The supportsave command does not support collecting crash logs from standby units in a mixed stack.
  • The filename length including tag string must be less than 32 characters.
  • The supportsave custom command denies commands other than show commands, dm commands, and fips show command.
  • Few show output commands are restricted to display only the first page in the console. This restriction is not applicable for sending the supportsave command output through file transfer.
  • Display option is available for modules like l2, l3, platform, system, infra, custom and all. Non-textual output like core files are not displayed in the console.

Examples

When the display option is enabled, some of the show commands are restricted to display only the first page. However, the tftp_server_IP option, transfers the complete command output to the TFTP server.

Note: RUCKUS recommends to use all option to collect complete logs.

To collect all supportsave related logs, enter the supportsave all command as shown in the following example.

device# supportsave all 10.37.2.40 fi/prince/supportsave
Supportsave started. This operation may take several minutes.
Press "A" to abort supportsave operation.
ICX7650-48C
device#.***********************.................................................
.................................................................................
Supportsave completed in 10 seconds