Gathering troubleshooting information

The CLI provides commands to gather troubleshooting information in a report and export them to the 6WIND technical support. The following information can be retrieved:

  • fast path information
  • fast path and system network configuration (per VRF)
  • system information
  • core files (information about a process crash)

To manage the troubleshooting report, the CLI provides the following features:

Create and export a troubleshooting report

  • Create a troubleshooting report:
router{}tech-support report create
  • Send the generated report to another machine:
router{}tech-support report export last URL
URL
URL of the report destination. TFTP, FTP or SCP protocols can be used.
  • If the report file is too big to be exported, it can be reduced by omitting core files, as below:
router{}tech-support report create no-core-file

Manage troubleshooting report history

All generated reports are stored in the router. You can list, delete or send one of them.

  • Display all created reports, they are listed from the most recent to the oldest:
router{}tech-support report list
  • Delete one or all report(s):
router{}tech-support report delete REPORT_NAME|all
  • Send a report to another machine:
router{}tech-support report export REPORT_NAME|last URL

Manage core files

When a user process crashes, the system automatically generates a core file. Core files are automatically included in troubleshooting reports. It is also possible to manually generate and export a core file for specific debug purposes.

To do this, the CLI provides the following commands:

  • Display available core files, they are listed from the most recent to the oldest:
router{}tech-support core-file list
  • Delete one or all core file(s):
router{}tech-support core-file delete CORE_NAME|all
  • When requested by a technical support engineer, you can send a unique core file:
router{}tech-support core-file export CORE_NAME URL
  • Kill a process to test the core file generation:
router{}tech-support core-file kill PROCESS_ID|PROCESS_NAME
PROCESS_ID
Identifier of the process to kill.
PROCESS_NAME
Name of the process to kill. If multiple processes have the same name, all of them will be killed.

Example

In this example we assume that the BGP daemon is running. We will kill it to generate a core file, then a troubleshooting report:

router{}show system processes summary
[...]
2605 root      20   0   45724   6092   4628 S   0.0  0.1   0:00.05 bgpd
[...]
dup-vm{}tech-support core-file kill 2605
router{}tech-support core-file list
1 core file(s) found:

bgpd-1509718173 (Fri Nov  3 14:09:34 2017)
router{}tech-support report create
Gathering information. This may take some time...
No LSB modules are available.
Gathered information into /var/crash/troubleshooting-report-171103-140928.tar.gz.
router{}tech-support report list
2 report archive(s) found:

troubleshooting-report-171103-140928 (last)
troubleshooting-report-171103-140917
router{}

A troubleshooting report has been generated and can be exported as follows:

router{}tech-support report export last scp://me@mycomputer//tmp
exporting to file scp://me@mycomputer//tmp
me@mycomputer's password:
troubleshooting-report-171103-140928.tar.gz   100%  246KB 246.5KB/s   00:00
router{}