layout-3 layout-6 layout-1 layout-top
NVIDIA Docs Hubchevron_right NVIDIA Networkingchevron_right Networking Softwarechevron_right Management Softwarechevron_right

NVIDIA NetQ

layout-top layout-6 layout-1

If you are using the current version of Cumulus NetQ, the content on this page 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.

config

You must run the netq config commands with sudo privileges.

netq config add agent cluster-servers

Configures the server cluster where the NetQ Agents on monitored switches and hosts should send their collected data. You can also provide a specific port or VRF to use for the communication. Note that you must restart the NetQ Agent to enable the configuration.

Syntax

netq config add agent cluster-servers
    <text-opta-ip-list>
    [port <text-opta-port>]
    [vrf <text-vrf-name>]
    [ssl true | ssl false]
    [ssl-cert <text-ssl-cert-file> | ssl-cert download]

Required Arguments

Argument Value Description
NA <text-opta-ip-list> Comma-separated list (no spaces) of IP addresses or hostnames of switches to include in server cluster

Options

Option Value Description
port <text-opta-port> Use the port with this name on each switch to receive data; default is port 31980
vrf <text-vrf-names> Use the VRF with this name on each switch to receive data; default VRF is default
ssl true, false Establish an SSL connection between agent and OPTA (true)
ssl-cert <text-ssl-cert-file> Use the SSL certificate contained in this file. Value must include entire path to the file.
ssl-cert download NA Download the SSL certificate

Sample Usage

Configure cluster with default port and VRF

cumulus@switch:~$ netq config add agent cluster-servers leaf01,leaf02,spine01
Updated agent for cluster servers leaf01,leaf02,spine01 port 31980 vrf default. Please restart netq-agent (netq config restart agent)

cumulus@switch:~$ netq config restart agent
  • netq config del agent cluster-servers
  • netq config restart agent

netq config add agent command

The NetQ Agent contains a pre-configured set of modular commands that run periodically and send event and resource data to the NetQ appliance or VM. This command lets you fine-tune which events the agent can poll and vary the frequency of polling. Note that you must restart the NetQ Agent to enable the configuration.

Refer to the Manage NetQ Agents for additional details, including service keys and default polling intervals.

Syntax

netq config add agent command
    service-key <text-service-key-anchor>
    [poll-period <text-cmd-periodicity>]
    [command <text-cmd-text>]
    [enable True | enable False]

Required Arguments

Argument Value Description
service-key <text-service-key-anchor> Modify the NetQ Agent command with this service key (name)

Options

Option Value Description
poll-period <text-cmd-periodicity> Set the polling period (in seconds) for the NetQ Agent command with the designated service key
command <text-cmd-text> Run this executable command for the NetQ Agent command with the designated service key
enable True, False Enable (True) or disable (False) the NetQ Agent command with the designated service key

Sample Usage

Modify the polling frequency for a command:

cumulus@switch:~$ netq config add agent command service-key lldp-json poll-period 60
Successfully added/modified Command service lldpd command /usr/sbin/lldpctl -f json

Disable a command:

cumulus@switch:~$ netq config add agent command service-key ospf-neighbor-json enable False
Command Service ospf-neighbor-json is disabled
  • netq config show agent
  • netq config agent factory-reset

netq config add agent cpu-limit

Configures the NetQ Agent to use no more than a specified maximum percentage (between 40 and 60 percent) of the CPU resources of the switch. If you run the command without a value, NetQ assumes a limit of 40%. Cumulus Linux versions 3.6 or later or 4.1.0 or later must be running on the switch for this setting to take effect. Note that you must restart the NetQ Agent to enable the configuration.

For more detail about this feature, refer to this Knowledge Base article.

Syntax

netq config add agent cpu-limit
    [<text-limit-number>]

Required Arguments

None

Options

Option Value Description
NA <text-limit-number> Set the threshold for the maximum percentage of CPU resources that the NetQ Agent can use

Sample Usage

Limit CPU usage by NetQ Agent to 60%:

cumulus@switch:~$ netq config add agent cpu-limit 60
Successfully set agent CPU limit to 60
Please restart agent(netq config restart agent)
'netq-agent'
cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!
  • netq config show agent cpu-limit
  • netq config del agent cpu-limit
  • netq config restart agent

netq config add agent frr-monitor

Configures the NetQ Agent to monitor the Free Range Router (FRR) function when running in a Docker container. Typically, FRR runs as a service. Note that you must restart the NetQ Agent to enable the configuration.

Syntax

netq config add agent frr-monitor
    [<text-frr-docker-name>]

Required Arguments

None

Options

Option Value Description
NA <text-frr-docker-name> Collect statistics about the FRR docker container with this name pattern, used by grep

Sample Usage

Configure NetQ Agent to collect FRR statistics:

cumulus@switch:~$ netq config add agent frr-monitor frr
Successfully added FRR docker monitoring for netq-agent. Please restart service.

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!
  • netq config show agent frr-monitor
  • netq config del agent frr-monitor
  • netq config restart agent

netq config add agent gnmi-port

Configures the default port over which the gNMI Agent listens. For additional information, see gNMI Streaming.

Syntax

netq config add agent gnmi-port <text-gnmi-port>

Required Arguments

Argument Value Description
gnmi-port <text-gnmi-port> Configure gNMI to listen over specified port

Options

None

Sample Usage

cumulus@switch:~$ netq config add agent gnmi-port <gnmi_port>
  • netq config add agent gnmi
  • netq config restart agent

netq config add agent loglevel

Configures the amount of information to log about the NetQ Agent activity, from only critical issues to every available message. Identified issues get logged to /var/log/netq-agent.log file. The default log level is info.

  • Error: Logs only events classified as errors
  • Warning: Logs events classified as warnings and errors
  • Info: Logs events classified as info, warning, and errors
  • Debug: Logs all events

After you finish debugging, reset the log level to info or higher. Note that you must restart the NetQ Agent to enable the configuration.

Syntax

netq config add agent loglevel
    [debug|error|info|warning]

Required Arguments

None

Options

Option Value Description
NA debug, error, info, warning Log NetQ Agent events with this severity

Sample Usage

Configure NetQ Agent to log only errors:

cumulus@switch:~$ netq config add agent loglevel error
Successfully added logging for netq-agent. Please restart service.

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!
  • netq config show agent loglevel
  • netq config del agent loglevel
  • netq config restart agent

netq config add agent opta-discovery-servers

Configures the range of IP addresses to search as part of the lifecycle management discovery process (when NetQ is looking for Cumulus Linux switches not running NetQ).

Ranges can be contiguous, for example 192.168.0.24-64, or non-contiguous, for example 192.168.0.24-64,128-190,235, but they must be within a single subnet. You can include a maximum of 50 addresses in an address range; if necessary, break the range into smaller ranges.

Syntax

netq config add agent opta-discovery-servers 
    <text-opta-discovery-ips> 
    [vrf <text-vrf-name>]
    [port <text-discovery-server-port>]

Required Arguments

Argument Value Description
opta-discovery-servers <text-opta-discovery-ips> Look for Cumulus Linux switches not running NetQ within this range of IP addresses

Options

Option Value Description
vrf <text-vrf-name> Look for Cumulus Linux switches with the specified IP addresses that use the VRF with this name. When unspecified, the command uses the default VRF.
port <text-discovery-server-port> Look for Cumulus Linux switches with the specified IP addresses that use this port. When unspecified, the command uses port 31980.

Sample Usage

Configure a range of IP addresses to search for switches that are not running NetQ:

cumulus@switch:~$ netq config add agent opta-discovery-servers 192.168.0.24-64,128-190
Updated agent discovery servers 192.168.0.24-64,128-190 port 31980 vrf default. Please restart netq-agent (netq config restart agent)

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!
  • netq config restart agent

netq config add agent opta-enable

Enable or disable the NetQ Agent. Use this command to collect data with gNMI.

Syntax

 netq config add agent opta-enable [true|false]

Required Arguments

None

Options

Option Value Description
NA true, false Disable the NetQ Agent (false) or enable it (true)

None

netq config add agent server

Configures the destination NetQ server for the data collected by the NetQ Agent and for API requests.

Syntax

netq config add agent server
    <text-opta-ip>
    [port <text-opta-port>]
    [vrf <text-vrf-name>]
    [ssl true | ssl false ]
    [ssl-cert <text-ssl-cert-file> | ssl-cert download]
    [inband-interface <interface-name>]

Required Arguments

Argument Value Description
server <text-opta-ip> Use the NetQ server with this IP address to receive NetQ Agent data and API requests

Options

Option Value Description
port <text-opta-port> Use this port on the NetQ server to receive NetQ Agent data and API requests
vrf <text-vrf-name> Use this VRF on the NetQ server to receive NetQ Agent data and API requests
ssl true, false Establish an SSL connection between agent and OPTA (true)
ssl-cert <text-ssl-cert-file> Use the SSL certificate contained in this file. Value must include entire path to the file.
ssl-cert download NA Download the SSL certificate
inband-interface Use this in-band interface to manage the switch when not using an out-of-band network

Sample Usage

Configure destination server with default port and VRF

cumulus@switch:~$ netq config add agent server 192.168.200.250
Updated agent server 192.168.200.250 port 31980 vrf default. Please restart netq-agent (netq config restart agent)

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!
  • netq config del agent server
  • netq config restart agent

netq config add agent services

Configures the NetQ Agent to monitor CPU and memory usage for services specified in the command. The service you configure the agent to monitor using this command will be added to the list of services displayed in the UI.

This command is only supported on Spectrum switches.

Syntax

netq config add agent services <text-service-name-list>

Required Arguments

Argument Value Description
services <text-service-name-list> Configure the NetQ Agent to monitor services. Format this value as a comma-separated list, without spaces. You can add up to 10 services.

Options

None

Sample Usage

cumulus@switch:~$ netq config add agent services dnsmasq
Successfully added services for netq-agent. Please restart netq-agent (netq config restart agent)


cumulus@switch:~$ netq config show agent services
Services Enabled
----------------------------------------
dnsmasq
  • netq config show agent services
  • netq config del agent services

netq config add agent spice

Configures the NetQ Agent to collect and send Spice statistics. This command can only be run on Spectrum switches running Cumulus Linux.

Syntax

netq config add agent spice

Required Arguments

Argument Value Description
spice NA Collect and send Spice data

Options

None

Sample Usage

cumulus@switch:~$ netq config add agent spice
Successfully added spice for netq-agent. Please restart netq-agent (netq config restart agent)

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!
  • netq config del agent spice
  • netq conifg show agent spice

netq config add agent stats

Configures the NetQ Agent to collect and send interface statistics.

Syntax

netq config add agent stats

Required Arguments

Argument Value Description
stats NA Collect and send interface statistics

Options

None

Sample Usage

cumulus@switch:~$ netq config add agent stats
stats config added. Please restart netq-agent (netq config restart agent)

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!
  • netq config show agent stats
  • netq config del agent stats
  • netq config restart agent

netq config add agent wjh

Configures the NetQ Agent to collect and send What Just Happened events from NVIDIA Spectrum™ switches. Refer to the WJH events reference for a list of supported WJH events and to WJH configuration for configuration information.

Syntax

netq config add agent wjh

Required Arguments

Argument Value Description
wjh NA Collect and send What Just Happened events

Options

None

Sample Usage

cumulus@chassis:~$ netq config add agent wjh
Successfully added WJH monitor. Please restart netq-agent (netq config restart agent)

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!
  • netq config show agent wjh
  • netq config del agent wjh
  • netq config add agent wjh-drop-filter
  • netq config add agent wjh-threshold
  • netq config restart agent

netq config add agent wjh-drop-filter

Filters the WJH events at the NetQ Agent before the NetQ system processes and displays them. NetQ performs the filtering on a drop-type basis. You can filter the drop type further by specifying one or more drop reasons, severities, or source/destination IP addresses. You must restart the agent after applying a filter with the netq config restart agent command.

Refer to the WJH events reference for a comprehensive list of drop types, reasons, and severities. WJH commands are only supported by NVIDIA Spectrum switches.

Syntax

netq config add agent wjh-drop-filter
    drop-type <text-wjh-drop-type> 
    [drop-reasons <text-wjh-drop-reasons>]
    [severity <text-drop-severity-list>]

netq config add agent wjh-drop-filter 
    ips [<text-wjh-ips>]

Required Arguments

Argument Value Description
drop-type <text-wjh-drop-type> Ignore WJH events with this drop type. Valid drop types include acl, buffer, l1, l2, router, and tunnel.

Options

Option Value Description
drop-reasons <text-wjh-drop-reasons> Ignore WJH events with these drop reasons. To specify more than one drop reason, format this value as a comma-separated list, without spaces. Valid drop reasons vary according to the drop type. Refer to the WJH events reference.
severity <text-drop-severity-list> Ignore WJH events with these severities. To specify more than one severity, format this value as a comma-separated list, without spaces. Valid severities include Notice, Warning, and Error.
ips <text-wjh-drop-ips> Ignore WJH events for these IP addresses. Format this value as a comma-separated list.

Sample Usage

The following example configures the NetQ Agent to ignore all L1 drops:

cumulus@switch:~$ sudo netq config add agent wjh-drop-filter drop-type l1

This example configures the NetQ Agent to ignore L1 drops with bad signal integrity:

cumulus@switch:~$ sudo netq config add agent wjh-drop-filter drop-type l1 drop-reasons BAD_SIGNAL_INTEGRITY

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!

This example configures the NetQ Agent to ignore router drops with a ‘warning’ severity level:

cumulus@switch:~$ sudo netq config add agent wjh-drop-filter drop-type router severity Warning

This example configures the NetQ Agent to ignore router drops that are due to blackhole routes:

cumulus@netq-ts:~$ sudo netq config add agent wjh-drop-filter drop-type router drop-reasons BLACKHOLE_ROUTE

The following example configures the NetQ Agent to ignore all drops that contain 192.168.0.15 as a source or destination IP address:

cumulus@switch:~$ sudo netq config add agent wjh-drop-filter ips 192.168.0.15

This example configures the NetQ Agent to ignore all drops that contain 192.168.0.15 or 192.168.0.45 as source or destination IP address:

cumulus@switch:~$ sudo netq config add agent wjh-drop-filter ips 192.168.0.15,192.168.0.45

This example configures the NetQ Agent to ignore all drops that contain 192.168.0.15/16 prefix network as a source or destination IP address:

cumulus@switch:~$ sudo netq config add agent wjh-drop-filter ips 192.168.0.15/16
  • netq config del agent wjh-drop-filter
  • netq config add agent wjh
  • netq config add agent wjh-threshold
  • netq config show agent wjh-drop-filter

netq config add agent wjh-threshold

WJH latency and congestion metrics depend on threshold settings to trigger the events. NetQ measures packet latency as the time spent inside a single system (switch). It measures congestion as a percentage of buffer occupancy on the switch. When configured, the NetQ Agent collects and sends these WJH-triggered events when a metric crosses the high and low thresholds.

This command only applies to NVIDIA Spectrum switches.

Syntax

netq config add agent wjh-threshold
    (latency|congestion)
    (<text-tc-list>|all)
    (<text-port-list>|all)
    <text-th-hi>
    <text-th-lo>

Required Arguments

Argument Value Description
wjh-threshold NA Collect and send WJH latency or congestion events triggered by the specified high and low thresholds
latency NA Collect and send WJH latency events
congestion NA Collect and send WJH congestion events
NA <text-tc-list> or all Only send events for these traffic classes, or use all for all traffic classes. To include more than one traffic class, format this value as a comma-separated list, without spaces.
NA <text-port-list> or all Only send events occurring on these ports, or use all for all ports. To include more than one port, format this value as a comma-separated list, without spaces. For example swp1,swp2,swp3,swp4.
NA <text-th-hi> Trigger an event when the latency is greater than this amount of time, or when buffer occupancy is greater than this percentage.
NA <text-th-lo> Trigger an event when the latency is less than this amount of time, or when buffer occupancy is less than this percentage.

Options

None

Sample Usage

Create latency thresholds for Class 3 traffic on port swp1 where the upper threshold is 10 and the lower threshold is 1.

cumulus@switch:~$ sudo netq config add agent wjh-threshold latency 3 swp1 10 1

Create congestion thresholds for Class 4 traffic on port swp1 where the upper threshold is 200 and the lower threshold is 10.

cumulus@switch:~$ sudo netq config add agent wjh-threshold congestion 4 swp1 200 10
  • netq config show agent wjh-threshold
  • netq config del agent wjh-threshold
  • netq config add agent wjh
  • netq config add agent wjh-drop-filter
  • netq config restart agent

netq config add cli proxy

Adds a new proxy server to the CLI configuration.

Syntax

  netq config add cli proxy 
    <text-proxy-type> 
    <text-proxy-url>

Required Arguments

Argument Value Description
NA <text-proxy-type> Proxy type (http, https)
NA <text-proxy-url> Proxy server URL

Options

None

  • netq config del cli proxy

netq config add cli server

Configures the NetQ CLI on the switch or host where you run this command. Cloud deployments require the access-key and secret-key options or the cli-keys-file option, as well as the premises option.

When the NetQ CLI is not configured, you can run only netq config and netq help commands, and you must use sudo to run them.

Syntax

netq config add cli server
    <text-gateway-dest>
    [access-key <text-access-key> secret-key <text-secret-key> premises <text-premises-name> | cli-keys-file <text-key-file> premises <text-premises-name>]
    [vrf <text-vrf-name>]
    [port <text-gateway-port>]

Required Arguments

Argument Value Description
server <text-gateway-dest> Hostname or IP address of the NetQ appliance or VM in on-premises deployments, or gateway IP address or domain name for cloud/remote deployments.
access-key <text-access-key> Access key obtained from NetQ UI for cloud/remote deployments
secret-key <text-secret-key> Secret key obtained from NetQ UI for cloud/remote deployments
premises <text-premises-name> Name of the premises with the data you want to monitor. When you have multiple premises, you must run this command again to view data from another premises.
cli-keys-file <text-key-file> Use the access and secret keys contained in this file for cloud/remote deployments, rather than providing keys individually. Value must include entire path to the file.

Options

Argument Value Description
vrf <text-vrf-name> Use this VRF for communication with the telemetry server (NetQ appliance, VM, or cloud gateway). This should be the same VRF where you set the routing tables for connectivity to the telemetry server. Typically this is the management VRF.
port <text-gateway-port> Use this port for communication with the telemetry server (NetQ appliance, VM, or cloud gateway). The default port is 32708 for on-premises deployments and 443 for cloud deployments.

Sample Usage

On-premises:

cumulus@switch:~$ sudo netq config add cli server 10.0.1.1 vrf mgmt port 32000
cumulus@switch:~$ sudo netq config restart cli

Cloud/remote:

cumulus@switch:~# sudo netq config add cli server api.netq.cumulusnetworks.com access-key 45d11f46bc09986db64612c590204054b1f12bc05219324a7d66084cf741779c secret-key zHoQ9feNlScNuGBVzUNqr0c0kJL+FAZbhEz8YtW2Rc0= premises NewYork 
cumulus@switch:~# sudo netq config restart cli
  • netq config show cli premises
  • netq config del cli server
  • netq config restart cli

netq config add opta config-key

Adds the OPTA configuration key as part of the on-switch OPTA configuration.

Syntax

netq config add opta config-key <text-opta-key> 
    [vrf <text-vrf-name>] 
    [proxy-host <text-proxy-host> proxy-port <text-proxy-port>]

Required Arguments

Argument Value Description
config-key <text-opta-key> OPTA configuration key

Options

Option Value Description
vrf <text-vrf-names> Specifies VRF used to communicate with the NetQ cloud
proxy-host <text-proxy-host> Specifies proxy host
proxy-port <text-proxy-port> Specifies proxy port

Sample Usage

netq config add opta config-key tHkSI2d3LmRldjMubmV0cWRldi5jdW11bHVasdf29ya3MuY29tGLsDIiwzeUpNc3BwK1IyUjVXY2p2dDdPL3JHS3ZrZ1dDUkpFY2JkMVlQOGJZUW84PTIEZGV2MzoHbmV0cWRldr vrf mgmt
  • netq config add opta proxy-host

netq config add opta proxy-host

Adds a proxy host as part of the on-switch OPTA configuration.

Syntax

netq config add opta 
    proxy-host <text-proxy-host> 
    proxy-port <text-proxy-port>

Required Arguments

Argument Value Description
proxy-host <text-proxy-host> Specifies proxy host
proxy-port <text-proxy-port> Specifies proxy port

Options

None

  • netq config del opta proxy-host

netq config asic-monitor-simulation

Syntax

netq config (start|stop|status|restart) asic-monitor-simulation

Required Arguments

Argument Value Description
config start, stop, status, restart NA

Options

None

None

netq config color

Configures command output to presents results in color for many commands. Results with errors are shown in red, and warnings are shown in yellow. Results without errors or warnings are shown in either black or green. VTEPs are shown in blue. A node in the pretty output of a trace command is shown in bold, and a router interface is wrapped in angle brackets (< >). Outputs are shown with color cues as soon as you run the command.

Syntax

netq config (add|del) color

Required Arguments

Argument Value Description
add NA Display color-coded command output
del NA Remove color-coded command output

Options

None

Sample Usage

cumulus@switch:~$ netq config add color
Color coded output config added

None

netq config agent factory-reset commands

Resets the factory default settings for NetQ Agent modular commands, removing any manual adjustments made to data to collect and polling frequency.

Syntax

netq config agent factory-reset commands

Required Arguments

Argument Value Description
factory-reset commands NA Reset NetQ Agent polling data and frequency to factory settings

Options

None

Sample Usage

cumulus@switch:~$ netq config agent factory-reset commands
Netq Command factory reset successful
  • netq config add agent
  • netq config show agent

netq config del agent

Disables or removes NetQ Agent configurations on a switch.

Syntax

netq config del agent 
    [asic-monitor|cluster-servers|cpu-limit|frr-monitor|loglevel|server|spice|ssl|stats|wjh] 
    [json]

Required Arguments

None

Options

Option Value Description
asic-monitor NA Stop the NetQ Agent from monitoring ASICs
cluster-servers NA Remove all cluster servers configured to receive NetQ Agent data
cpu-limit NA Remove CPU usage limit for the NetQ Agent on this device
frr-monitor NA Stop the NetQ Agent from monitoring FRR when running in a container
loglevel NA Stop the NetQ Agent from logging events about the agent
server NA Delete the current destination of NetQ Agent data and API requests
spice NA Stop the NetQ Agent from collecting Spice data
ssl NA Delete SSL configuration
stats NA Stop the NetQ Agent from collecting interface statistics
wjh NA Stop the NetQ Agent from collecting WJH information
json NA Display the output in JSON file format

Sample Usage

cumulus@switch:~$ netq config del agent cluster-servers
Deleted agent cluster servers 10.10.0.101,10.20.0.101 port 31980 vrf default. Please restart netq-agent (netq config restart agent)

cumulus@switch:~$ netq config restart agent
  • netq config add agent
  • netq config restart agent
  • netq config show agent

netq config del agent services

Configures the NetQ Agent to stop monitoring CPU and memory usage for services specified in the command. The service you configure the agent to monitor using this command will be removed from the list of services displayed in the UI. The following services are always monitored and cannot be deleted: monclagd, mstpd, lldpd, frr (including zebra, bgpd, ospfd), netqd, netq-agent, wd_keepalive, nvued, switchd, sx_sdk, ntpd, pwmd, and smond.

This command is only supported on Spectrum switches.

Syntax

netq config del agent services <text-service-name-list>

Required Arguments

Argument Value Description
services <text-service-name-list> Stops the NetQ Agent from monitoring specified services. Format this value as a comma-separated list, without spaces.

Options

None

  • netq config show agent services
  • netq config add agent services

netq config del agent wjh-drop-filter

Deletes a What Just Happened event filter on a switch. Run the netq show agent wjh-drop-filter command for a list of WJH filter configurations.

Syntax

netq config del agent wjh-drop-filter
    drop-type <text-wjh-drop-type> 
    [drop-reasons <text-wjh-drop-reasons>]
    [severity <text-drop-severity-list>]

netq config del agent wjh-drop-filter 
    ips [<text-wjh-ips>]

Required Arguments

Argument Value Description
drop-type <text-wjh-drop-type> Delete WJH event filter with this drop type. Valid drop types include acl, buffer, l1, l2, router, and tunnel.

Options

Option Value Description
drop-reasons <text-wjh-drop-reasons> Delete WJH event filter with these drop reasons. To specify than one drop reason, format this value as a comma-separated list, without spaces. Valid drop reasons vary according to the drop type. Refer to the WJH events reference.
severity <text-drop-severity-list> Delete WJH event filter with these severities. To specify more than one severity, format this value as a comma-separated list, without spaces. Valid severities include Notice, Warning, and Error.
ips <text-wjh-drop-type> Delete WJH events filter for these IP addresses (comma-separated list)

Sample Usage

Remove L1 filter for specified drop reasons:

cumulus@switch:~$ sudo netq config del agent wjh-drop-filter drop-type l1 drop-reasons PORT_ADMIN_DOWN,BAD_SIGNAL_INTEGRITY

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!

Remove all WJH IP-based filters:

cumulus@switch:~$ sudo netq config del agent wjh-drop-filter ips

Remove WJH filter where the source or destination IP address is 192.168.0.15 or 192.168.0.45:

cumulus@switch:~$ sudo netq config del agent wjh-drop-filter ips 192.168.0.15,192.168.0.45
  • netq config add agent wjh-drop-filter
  • netq config add/del agent wjh
  • netq config del agent wjh-threshold
  • netq config show agent wjh-drop-filter

netq config del agent wjh-threshold

Remove latency or congestion thresholds for WJH events.

Syntax

netq config del agent wjh-threshold
    (latency|congestion)
    (<text-tc-list>|all)

Required Arguments

Argument Value Description
wjh-threshold NA Remove latency or congestion events triggered by thresholds
latency NA Remove latency event thresholds
congestion NA Remove congestion event thresholds
NA <text-tc-list> or all Remove latency or congestion events for these traffic classes, or use all for all traffic classes. When you want more than one traffic class, format this value as a comma-separated list, without spaces.

Options

None

Sample Usage

cumulus@switch:~$ netq config del agent wjh-threshold latency 3

cumulus@switch:~$ netq config del agent wjh-threshold congestion 4
  • netq config show agent wjh-threshold
  • netq config add agent wjh-threshold
  • netq config del agent wjh
  • netq config del agent wjh-drop-filter
  • netq config restart agent

netq config del cli

Removes the NetQ CLI configuration or proxy server from a switch.

Syntax

netq config del cli (server | proxy)

Required Arguments

Argument Value Description
cli server, proxy Delete the current NetQ CLI configuration or proxy server

Options

None

Sample Usage

cumulus@switch:~$ netq config del cli server
  • netq config add cli server
  • netq config show cli premises
  • netq config restart agent

netq config del opta proxy-host

Deletes a proxy host as part of the on-switch OPTA configuration.

Syntax

netq config del opta proxy-host

Required Arguments

None

Options

None

  • netq config add opta proxy-host

netq config opta

Configures the OPTA (on-premises telemetry aggregator) service in cloud environments. Read more about configuring the OPTA service.

Syntax

netq config (start|stop|status|restart) opta

Required Arguments

Argument Value Description
NA start, stop, status, restart NA

Options

None

Sample Usage

netq config restart opta
  • netq config lcm-executor

netq config reload parser

Loads the NetQ configuration file.

Syntax

netq config reload parser

Required Arguments

None

Options

None

Sample Usage

cumulus@switch:~$ netq config reload parser
Parser reloaded

None

netq config reset premise

Resets the UUID for a given premises. In cloud deployments, this command can be used to reset a premises so that it can be reconfigured and attached to a different VM.

Syntax

netq config reset premise <test-premises-name>

Required Arguments

Argument Value Description
premise <text-premises-name> Resets the premises with this name

Options

None

Sample Usage

Use the netq config show cli premises command to check whether the premises is active or inactive. The status must be inactive before it can be attached to a new server.

cumulus@switch:~$ netq config show cli premises
Name                     OPID  Timezone    Namespace    Tag    CLI Status    Status
-----------------  ----------  ----------  -----------  -----  ------------  --------
prem-1             1719853531  PST         default      US     not selected  Active
prem-2             1719855240  PST         default      US     selected      Inactive

cumulus@switch:~$ netq config reset premise prem-1
Premise has been reset successfully. Please verify using 'netq config show cli premises'

cumulus@switch:~$ netq config show cli premises
Name                     OPID  Timezone    Namespace    Tag    CLI Status    Status
-----------------  ----------  ----------  -----------  -----  ------------  --------
prem-1             1719853531  PST         default      US     not selected  Inactive
prem-2             1719855240  PST         default      US     selected      Inactive
  • netq config show cli premises

netq config restart

Restarts the NetQ Agent or CLI daemons on a switch. Use this command after making changes to the NetQ Agent or CLI configurations.

Syntax

netq config restart agent

netq config restart cli

Required Arguments

Argument Value Description
agent NA Restart the NetQ Agent daemon (netq-agent)
cli NA Restart the NetQ CLI daemon (netq-cli)

Options

None

Sample Usage

cumulus@switch:~$ netq config restart agent
Restarting netq-agent... Success!

cumulus@switch:~$ netq config restart cli 
Restarting NetQ CLI... Success!
  • netq config stop agent
  • netq config status agent

netq config select cli premise

In a multi-premises deployment, this command configures the NetQ CLI to view data from the given premises.

Syntax

netq config select cli
    premise <text-premise>

Required Arguments

Argument Value Description
premise <text-premise> Show data from this premises in the NetQ CLI command outputs

Options

None

Sample Usage

cumulus@switch:~$ netq config select cli premise Boston
Input premise Boston
Switched to premise Boston
  • netq config show cli premises

netq config show agent

Displays the configuration of the NetQ Agent on a switch. Several forms of this command are available.

Syntax

netq config show agent 
    [asic-monitor|cpu-limit|frr-monitor|loglevel|services|ssl|stats|wjh|wjh-drop-filter|wjh-threshold] 
    [json]

Required Arguments

None

Options

Option Value Description
asic-monitor NA Display NetQ Agent ASIC monitoring configuration
cpu-limit NA View the maximum percentage of CPU resources that the NetQ Agent can use
frr-monitor NA Display FRR monitoring configuration
loglevel NA Display the NetQ Agent logging level configuration
services NA Display custom services and processes configuration
ssl NA Display SSL configuration
stats NA Display status of interface statistics
wjh NA Display NetQ Agent What Just Happened monitoring configuration
wjh-drop-filter NA Display NetQ Agent WJH filter configuration
wjh-threshold NA Display NetQ Agent WJH latency and congestion thresholds configuration
json NA Display the output in JSON format

Sample Usage

cumulus@switch:~$ netq config show agent 
netq-agent                value      default
------------------------  ---------  ---------
exhibitport
exhibiturl
server                    127.0.0.1  127.0.0.1
cpu-limit                 100        100
agenturl
wjh                                  Enabled
enable-opta-discovery     False      False
agentport                 8981       8981
port                      31980      31980
vrf                       default    default
is-gnmi-enabled           False      False
netq_stream_port          7680       7680
netq_stream_address       127.0.0.1  127.0.0.1
is-ssl-enabled            False      False
ssl-cert
generate-unique-hostname  False      False
()
  • netq config show all
  • netq config show cli premises
  • netq config add agent
  • netq config del agent

netq config show agent commands

The NetQ Agent contains a pre-configured set of modular commands that run periodically and send event and resource data to the NetQ appliance or VM. This command displays the configuration of these commands, including the definition of the commands, which are active, and how often they run. You can also filter by the service key to view a given command.

Syntax

netq config show agent commands
    [service-key <text-service-key-anchor>]
    [json]

Required Arguments

Argument Value Description
commands NA View the configuration of all NetQ Agent modular commands

Options

Option Value Description
service-key <text-service-key-anchor> View the configuration of the NetQ Agent command with this service key (name)
json NA Display the output in JSON format

Sample Usage

Show the configuration for all commands:

cumulus@switch:~$ netq config show agent commands
 Service Key               Period  Active       Command
-----------------------  --------  --------  ---------------------------------------------------------------------
bgp-neighbors                  60  yes       ['/usr/bin/vtysh', '-c', 'show ip bgp vrf all neighbors json']
evpn-vni                       60  yes       ['/usr/bin/vtysh', '-c', 'show bgp l2vpn evpn vni json']
lldp-json                     120  yes       /usr/sbin/lldpctl -f json
clagctl-json                   60  yes       /usr/bin/clagctl -j
dpkg-query                  21600  yes       dpkg-query --show -f ${Package},${Version},${Status}\n
ptmctl-json                   600  yes       /usr/bin/ptmctl -d -j
mstpctl-bridge-json            60  yes       /sbin/mstpctl showall json
ports                        3600  yes       Netq Predefined Command
proc-net-dev                   30  yes       Netq Predefined Command
dom                          1800  yes       Netq Predefined Command
roce                           60  yes       Netq Predefined Command
roce-config                    60  yes       Netq Predefined Command
nvue-roce-config               60  yes       Netq Predefined Command
agent_stats                   300  yes       Netq Predefined Command
agent_util_stats               30  yes       Netq Predefined Command
tcam-resource-json            300  yes       /usr/cumulus/bin/cl-resource-query -j
config-mon-json               120  yes       Netq Predefined Command
nvue-mon-json                  60  yes       Netq Predefined Command
running-config-mon-json        30  yes       Netq Predefined Command
cl-support-json               180  yes       Netq Predefined Command
resource-util-json            120  yes       findmnt / -n -o FS-OPTIONS
smonctl-json                  120  yes       /usr/sbin/smonctl -j
sensors-json                 1800  yes       sensors -u
ssd-util-json               86400  yes       /usr/sbin/smartctl -a /dev/sda
ssd-util-nvme-json          86400  yes       /usr/sbin/smartctl -a /dev/nvme0
ospf-neighbor-json             60  yes       ['/usr/bin/vtysh', '-c', 'show ip ospf vrf all neighbor detail json']
ospf-interface-json            60  yes       ['/usr/bin/vtysh', '-c', 'show ip ospf vrf all interface json']
ecmp-hash-info                 60  yes       cat /etc/cumulus/datapath/traffic.conf
ecmp-info                      60  yes       Netq Predefined Command
ptp-config-info                60  yes       cat /etc/ptp4l.conf
ptp-clock-info                 60  yes       Netq Predefined Command
ptp-clock-status               60  yes       Netq Predefined Command
ptp-statistics                 60  yes       Netq Predefined Command
ptp-correction                 30  yes       Netq Predefined Command
log-exporter                   60  yes       Netq Predefined Command
adaptive-routing-config       120  yes       Netq Predefined Command

Show the configuration for a specified command:

cumulus@switch:~$ netq config show agent commands service-key agent_stats
 Service Key       Period  Active       Command
---------------  --------  --------  -----------------------
agent_stats           300  yes       Netq Predefined Command
  • netq config add agent commands
  • netq config agent factory-reset commands

netq config show all

Displays the configuration of the NetQ Agent and NetQ CLI on a switch.

Syntax

netq config show all
    [json]

Required Arguments

None

Options

Option Value Description
json NA Display the output in JSON format

Sample Usage

cumulus@switch:~$ netq config show all 
netq-agent                value      default
------------------------  ---------  ---------
exhibitport
exhibiturl
server                    127.0.0.1  127.0.0.1
cpu-limit                 100        100
agenturl
wjh                                  Enabled
enable-opta-discovery     False      False
agentport                 8981       8981
port                      31980      31980
vrf                       default    default
is-gnmi-enabled           False      False
netq_stream_port          7680       7680
netq_stream_address       127.0.0.1  127.0.0.1
is-ssl-enabled            False      False
ssl-cert
generate-unique-hostname  False      False
()
netq-cli     value              default
-----------  -----------------  ---------
server       10.188.45.236      127.0.0.1
netq-user    admin
premises     admin-1708956199
port         32708              32708
count        4000               4000
vrf          default            default
api-logging  False              False
()
  • netq config show agent
  • netq config show cli premises

netq config show cli premises

Displays the configuration of the NetQ CLI across premises.

Syntax

netq config show cli premises
    [json]

Required Arguments

None

Options

Option Value Description
json NA Display the output in JSON format

Sample Usage

cumulus@switch:~$ netq config show cli premises
Name                   OPID  Timezone      Namespace  Tag    CLI Status     Status
---------------  ----------  ----------  -----------  -----  ------------   -----------
OPID0                     0  IST                 nan  TAG0   selected       Active
premise1              20001  PST                 nan  US     not selected   Inactive
premise2              20002  PST                 nan  US     not selected   Inactive
()
  • netq config select cli premise
  • netq config reset premise

netq config start agent

Starts the NetQ Agent on a switch.

Syntax

netq config start agent

Required Arguments

None

Options

None

Sample Usage

cumulus@switch:~$ netq config start agent 
Starting netq-agent... Success!
  • netq config show agent
  • netq config stop agent
  • netq config restart agent

netq config status agent

Displays the operational status of the NetQ Agent on a switch.

Syntax

netq config status agent
    [verbose] 
    [json]

Required Arguments

None

Options

Option Value Description
verbose NA Display detailed output
json NA Display the output in JSON format

Sample Usage

cumulus@switch:~$ netq config status agent 
netq-agent... Running

cumulus@switch:~$ netq config status agent 
netq-agent...stopped
  • netq config show agent
  • netq config stop agent
  • netq config restart agent

netq config status cli

Displays the operational status of the NetQ CLI on a switch.

Syntax

netq config status cli

Required Arguments

None

Options

None

Sample Usage

cumulus@switch:~$ netq config status cli
NetQ CLI... Running
  • netq config show cli premises
  • netq config restart cli

netq config stop agent

Stops the NetQ Agent on a switch.

Syntax

netq config stop agent

Required Arguments

None

Options

None

Sample Usage

cumulus@switch:~$ netq config stop agent
Stopping netq-agent... Success!
  • netq config show agent
  • netq config start agent
  • netq config restart agent

    Copyright © 2024  NVIDIA Corporation