Cumulus Linux 5.6 User Guide
NVIDIA® Cumulus Linux is the first full-featured Debian Buster-based, Linux operating system for the networking industry.
This user guide provides in-depth documentation on the Cumulus Linux installation process, system configuration and management, network solutions, and monitoring and troubleshooting recommendations. In addition, the quick start guide provides an end-to-end setup process to get you started.
Cumulus Linux 5.6 includes the NVIDIA NetQ agent and CLI. You can use NetQ to monitor and manage your data center network infrastructure and operational health. Refer to the NVIDIA NetQ documentation for details.
Try It Pre-built Demos
The Cumulus Linux documentation includes pre-built Try It demos for certain Cumulus Linux features. The Try It demos run a simulation in NVIDIA Air; a cloud hosted platform that works exactly like a real world production deployment. Use the Try It demos to examine switch configuration for a feature. For more information, see Try It Pre-built Demos.
Open Source Contributions
To implement various Cumulus Linux features, NVIDIA has forked various software projects, like CFEngine
Netdev and some Puppet Labs packages. Some of the forked code resides in the NVIDIA Networking GitHub repository and some is available as part of the Cumulus Linux repository as Debian source packages.
NVIDIA has also developed and released new applications as open source. The list of open source projects is on the Cumulus Linux packages page.
Hardware Compatibility List
You can find the most up-to-date hardware compatibility list (HCL) here. Use the HCL to confirm that Cumulus Linux supports your switch model. The HCL lists products by port configuration, manufacturer and SKU part number.
Download the User Guide
Use one of the following methods to download the Cumulus Linux user guide and view it offline:
- Host the documentation on a local host using hugo.
- Download a zip file of an HTML documentation build for offline use. Download the desired version, extract it locally, then open
cumulus-linux-56.htmlin your web browser.
- You can view the complete Cumulus Linux 5.6 user guide as a single page to print to PDF here. Click on the link one time and use the web browser print-to-PDF option to save the PDF locally.