NETQ(8)

NAME
netq - Cumulus NetQ Fabric Validation CLI

SYNOPSIS
netq [<hostname>] (check|show) <object> <options>
netq trace <options>
netq (agent|notifier) (<start|stop|restart|status>) [vrf <vrf>]

DESCRIPTION
        netq is a tool for validating the whole network fabric. NetQ Telemetry Server Agents (netq-agent) running on network switches and server hosts analyze and aggregate network state. By examining network-wide patterns, it provides correlation and ultimately causation of issues affecting the network.

GETTING STARTED
        netq needs to communicate with a central database in order to pull network events data, and hence a way to reach the database needs to be specified, which is the database hostname and port. The simplest and the easiest way to do this would be the following:

        netq config add server <ip-server>|<server-name> [port <port>]

        You can also edit this information in the 'backend' section in the config file at /etc/netq/netq.yml or in a separate file in /etc/netq/config.d/.

        Type netq to get the current status of all the agents running in the network. netq's command line is quite helpful and uses BASH's tab complete to provide a variety of useful information. 'netq help' and 'netq example' are good starting points.

FILES

            /etc/netq/netq.yml
                Primary configuration file for all Cumulus NetQ tools.

SEE ALSO

netq-agent(8)

AUTHOR
Cumulus Networks <support at cumulusnetworks dot com>

COPYRIGHT
2025,2017 Cumulus Networks