This documentation is for an older version of the software. If you are using the current version of Cumulus Linux, this content 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.

UI Preface

A variety of resources are available for you to become familiar with Cumulus NetQ and to take advantage of its monitoring and analytic capabilities. These resources are identified here along with information about how the content is presented.

What’s New in Cumulus NetQ 2.1

Cumulus NetQ has been reinvented to scale with the fast adoption rate of open networks and rapid network growth. In addition to the real-time data collection and fabric-wide performance analysis that are already supported in Cumulus NetQ 1.4.1, Cumulus NetQ now offers a graphical user interface for:

  • Data visualizations of the overlay and underlay networks,
  • Simplified network troubleshooting with network-wide roll-ups of health and alarm status in a single card, and
  • Proactive validation of the network status and configuration to regularly detect network issues.

For further information regarding new features, improvements, bug fixes, and known issues present in this release, refer to the release notes.

Available Documentation

The NetQ documentation set has been reorganized and updated from prior releases. They still provide the information you need to proactively monitor your Linux-based network fabric using Cumulus NetQ. They assume that you have already installed Cumulus Linux and NetQ.

You may start anywhere in the documentation or read it from start to finish depending on your role and familiarity with the NetQ software and Linux networking. If you are new to NetQ, you may want to read the Cumulus NetQ Primer before reading the other available documents.

The following NetQ documents are available:

Document Formatting

This guide uses the following typographical and note conventions.

Typographical Conventions

Throughout the guide, text formatting is used to convey contextual information about the content.

Text FormatMeaning
Green textLink to additional content within the topic or to another topic
Text in Monospace fontFilename, directory and path names, and command usage
[Text within square brackets]Optional command parameters; may be presented in mixed case or all caps text
<Text within angle brackets>Required command parameter values-variables that are to be replaced with a relevant value; may be presented in mixed case or all caps text

Note Conventions

Several note types are used throughout the document. The formatting of the note indicates its intent and urgency.

Offers information to improve your experience with the tool, such as time-saving or shortcut options, or indicates the common or recommended method for performing a particular task or process

Provides additional information or a reminder about a task or process that may impact your next step or selection

Advises that failure to take or avoid specific action can result in possible data loss

Advises that failure to take or avoid specific action can result in possible physical harm to yourself, hardware equipment, or facility