This documentation is for the extended support release (ESR) version of Cumulus Linux. We will continue to keep this content up to date until 21 February, 2023, when ESR support ends. For more information about ESR, please read this knowledge base article.

If you are using the current version of Cumulus Linux, the content on this page may not be up to date. The current version of the documentation is available here. If you are redirected to the main page of the user guide, then this page may have been renamed; please search for it there.

Understanding the cl-support Output File

The cl-support script generates a compressed archive file of useful information for troubleshooting. The system either creates the archive file automatically or you can create the archive file manually.

Automatic cl-support File

The system creates the cl-support archive file automatically for the following reasons:

  • When there is a core file dump of any application (not specific to Cumulus Linux, but something all Linux distributions support), located in /var/support/core.
  • After the first failure of one of several monitored services since the switch was rebooted or power cycled.

Manual cl-support File

To create the cl-support archive file manually, run the cl-support command:

cumulus@switch:~$ sudo cl-support

If the support team requests that you submit the output from cl-support to help with the investigation of issues you might experience with Cumulus Linux and you need to include security-sensitive information, such as the sudoers file, use the -s option:

cumulus@switch:~$ sudo cl-support -s

On ARM switches, the cl-support FRR module might time out even when FRR is not running. To disable the timeout, run the cl-support command with the -M option; for example:

cumulus@switch:~$ sudo cl-support -M

For information on the directories included in the cl-support archive, see:

  • Troubleshooting the etc Directory. The /etc directory contains the largest number of files; however, log files might be significantly larger in file size.
  • Troubleshooting Log Files. This guide highlights the most important log files to inspect. Keep in mind, cl-support includes all of the log files.