NetQ CLI Changes

A number of commands have changed in this release to accommodate the addition of new keywords and options or to simplify their syntax. Additionally, new commands have been added and others have been removed. A summary of those changes is provided here.

New Commands

The following table summarizes the new commands available with this release. They are grouped into the following categories: new netq show commands, What Just Happened feature, clustering deployment, detailed validation commands, and threshold-based events.

Command Summary Version
netq [<hostname>] show cl-manifest [json] Lists installed software packages one or all devices 2.4.0
netq [<hostname>] show cl-resource acl [ingress|egress] [around <text-time>] [json] Displays incoming and outgoing access control lists (ACLs) configured on one or all devices, currently or at a time in the past 2.4.0
netq [<hostname>] show cl-resource forwarding [around <text-time>] [json] Displays xxx on one or all devices, currently or at a time in the past 2.4.0
netq [<hostname>] show recommended-pkg-verison [release-id <test-release-id>] [package-name <text-package-name>] [json] Displays list of recommended packages to install/upgrade on one or all devices 2.4.0
netq [<hostname>] show cl-resource-util [cpu|memory] [around <text-time>] [json] Displays the CPU or memory utilization for a given device or all devices, currently or at a time in the past/td> 2.4.0
netq [<hostname>] show show-resource-util disk [<text-diskname>] [around <text-time>] [json] Displays the disk utilization for a given device or all devices, currently or at a time in the past 2.4.0
netq [<hostname>] show wjh-drop [<text-drop-type>] [ingress-port <text-ingress-port>] [reason <text-reason>] [src-ip <text-src-ip>] [dst-ip <text-dst-ip>] [proto <text-proto>] [src-port <text-src-port>] [dst-port <text-dst-port>] [src-mac <text-src-mac>] [dst-mac <text-dst-mac>] [egress-port <text-egress-port>] [traffic-class <text-traffic-class>] [rule-id-acl <text-rule-id-acl>] [between <text-time> and <text-endtime>] [around <text-time>] [json] Displays status of various resource, interface, and sensor-related drops, the reason for the drop, and where they have occurred in the last 24 hours, between a set of times, or at a time in the past 2.4.0
netq [<hostname>] show (agent| unit-tests [json] Displays the CPU or memory utilization for a given device or all devices, currently or at a time in the past/td> 2.4.0
netq [<hostname>] show show-resource-util disk [<text-diskname>] [around <text-time>] [json] Displays the disk utilization for a given device or all devices, currently or at a time in the past 2.4.0
netq bootstrap master interface <text-opta-ifname>] tarball <text-tarball-name> Loads master node with the NetQ installer in a server cluster deployment 2.4.0
netq bootstrap master upgrade <text-tarball-name> Loads master node with a new NetQ installer in a server cluster deployment 2.4.0
netq bootstrap reset Resets the NetQ installer to default settings on nodes in a server cluster deployment 2.4.0
netq bootstrap worker tarball <text-tarball-name> master-ip <text-master-ip> Loads a worker node with the NetQ installer in a server cluster deployment 2.4.0
netq install cluster join-workers <text-worker-01> [<text-worker-02>] Adds worker node(s) to the server cluster 2.4.0
netq show job-status <text-opta-ip> [json] Displays the status of running jobs on the standalone or cluster servers 2.4.0
netq config add agent cluster-servers <text-opta-ip-list> [port <text-opta-port>] [vrf <text-vrf-name>] [json] Configures the agent on monitored switches and hosts to send data to the cluster nodes. You can also provide a specific port or VRF to use for the communication. 2.4.0
netq check <protocol-or-service>
[include <proto-or-srvc-number-range-list> |
exclude <proto-or-srvc-number-range-list>]
[around <text-time>] [json | summary]

where <protocol-or-service> is one of the following:
  • bgp [vrf ]
  • cl-version [match-version | min-version ]
  • clag
  • evpn [mac-consistency]
  • interfaces
  • license
  • mtu [unverified]
  • ntp
  • ospf
  • sensors
  • vlan [unverified]
  • vxlan
Validates the specified protocol or service, running all tests or selected tests. 2.4.0
netq show (agent|bgp|cl-version|clag|
evpn|interfaces|license|mtu|ntp|ospf|sensors|
vlan|vxlan) unit-tests [json]
Displays the validation tests that can be run for each protocol and service accordingly. 2.4.0
netq add tca [event_id <text-event-id-anchor>] [scope <text-scope-anchor>] [tca_id <text-tca-id-anchor>] [severity info | severity critical] [is_active true | is_active false] [suppress_until <text-suppress-ts>] [ threshold <text-threshold-value> ] [channel <text-channel-name-anchor> | channel drop <text-drop-channel-name>] Configures a threshold-based event notification. Also used to set the severity of the event, disable the event temporarily or indefinitely, and remove a receiving channel. 2.4.0
netq del tca tca_id <text-tca-id-anchor> Removes a threshold-based event rule 2.4.0
netq show tca [tca_id <text-tca-id-anchor>] [json] Displays all or a given threshold-based event rules 2.4.0

Modified Commands

The following table summarizes the commands that have been changed with this release.

Updated Command Old Command What Changed Version
netq install cluster full interface <text-opta-ifname> bundle <text-bundle-url> config-key <text-opta-key> workers <text-worker-01> <text-worker-02>
and
netq install standalone full interface <text-opta-ifname> bundle <text-bundle-url> config-key <text-opta-key> [proxy-host <text-proxy-host> proxy-port <text-proxy-port>]
netq install interface <text-opta-ifname> tarball (<text-tarball-name> | download | download <text-opta-version>) config-key <text-opta-key> [proxy-host <text-proxy-host> proxy-port <text-proxy-port>] [file <text-config-file>] [force] Separated single command into two commands to support the new clustering feature for on-premises deployments. Removed download, file, and force options. 2.4.0
netq install opta cluster full interface <text-opta-ifname> bundle <text-bundle-url> config-key <text-opta-key> workers <text-worker-01> <text-worker-02> [proxy-host <text-proxy-host> proxy-port <text-proxy-port>]
*and*
netq install opta standalone full interface <text-opta-ifname> bundle <text-bundle-url> config-key <text-opta-key>
netq install opta interface <text-opta-ifname> tarball (<text-tarball-name> | download | download <text-opta-version>) config-key <text-opta-key> [proxy-host <text-proxy-host> proxy-port <text-proxy-port>] [file <text-config-file>] [force] Separated single command into two commands to support the new clustering feature for cloud deployments. Removed download, file, and force options. 2.4.0
netq config del agent (server|agent-url|cluster-servers) netq config del agent (server|agent-url) Added the ability to remove the agent from servers in a clustered deployment. 2.4.0

Deprecated Commands

The following table summarizes the commands that are present, but no longer active. A recommended alternative is provided, if appropriate.

Command Status Alternate Command Version
netq [check|show] lnv LNV was deprecated in Cumulus Linux 3.7.4 and has been removed from Cumulus Linux 4.0.0. Cumulus NetQ will continue to support and return LNV data as long as you are running a supported version of Cumulus Linux (earlier than 4.0.0) and Cumulus NetQ 2.4.x or earlier. To use these commands with Cumulus NetQ 2.4.x you must enable LNV in the netq.yml configuration file, as it is disabled by default. N/A 2.4.0