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.

IPM Preface

A variety of resources are available for you to become familiar with Cumulus Linux and Cumulus NetQ applications. These resources are identified here along with information about how the document contents are presented.

What’s New in Cumulus NetQ 1.4.0

Cumulus NetQ 1.4.0 includes the following new features:

  • Added
    • support for monitoring up to 200 Cumulus Linux nodes
    • validation of symmetric VXLAN routes through CLI
    • validation of forward error correction (FEC) operation through NetQL
  • Updated
    • color cues for netq show services command to more easily view status of services at a glance
    • NetQ CLI syntax for creating NetQ Notifier filters t o improve usability and operation
    • trace functionality to improve usability and operation
  • Early access feature
    • Image and Provisioning Management (IPM) application

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

Available Documentation

All of the IPM documentation assumes 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 to gain a high-level understanding of the product capabilities and operation.

The following NetQ-related documents are available:

Document Formatting

The Cumulus IPM User 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