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.0

Cumulus NetQ 2.0.0 includes the following new and updated features:

  • Added

    • Modern cloud-based infrastructure enables scalable and agile network with real-time data collection

    • Graphical User Interface (UI) provides a visual representation of the network devices and events

      • Monitor network-wide health

      • Monitor individual device health and configuration

      • Monitor network protocols and services on a per session or all sessions basis

      • View network devices inventory and device component inventory

      • Track alarms and informational events across the network and for individual devices and components, protocols and services

      • Customize your own monitoring workbench to meet your needs

    • Command Line Interface (CLI)

      • View the count of interfaces, addresses, and routes on a particular device using netq <hostname> show command

    • RESTful API provides access to data for use in third-party analytic tools

    • NetQ appliance with Cumulus Linux and NetQ pre-installed to speed deployment and get monitoring as quickly as possible

  • Updated

    • Instead of using the netq show commands to display changes between two points in time, a new netqshow events command is available to see these changes.

    • The netq config ts commands used to configure the Telemetry Server have been replaced with netq config commands for configuring the NetQ platform and notifications.

    • Timestamps are displayed as an absolute time when a change occurred (Mon Feb 4 07:23:18 2019) versus relative to the current time (0d:2h:58m:34s ago).

The following features have been deprecated in this release:

  • NetQL, query language for directly accessing the database. This data is now available through the NetQ UI.

  • netq-shell command. This is no longer needed as you can run commands from any node.

  • Service Console. Access the CLI directly rather than through the UI.

For additional details about changes to the CLI, refer to the NetQ Command Line Overview.

For further information regarding 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 to gain a high-level understanding of the product capabilities and operation.

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 Format

Meaning

Green text

Link to additional content within the topic or to another topic

Text in Monospace font

Filename, 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.

Tip or Best Practice

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

Information

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

Caution

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

Warning

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