NetQ CLI Changes

A number of commands have changed in this release to accommodate the addition of new 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 include lifecycle management (LCM) and modular agent commands.

CommandSummaryVersion
netq lcm add credentials (username <text-switch-username> password <text-switch-password> | ssh-key <text-ssh-key>)Creates switch access credentials (either SSH key or basic username/password auth) to enable Cumulus Linux upgrades on switches.3.0.0
netq lcm add image <text-image-path>Uploads a Cumulus Linux install image to the LCM repository.3.0.0
netq lcm add role (superspine | spine | leaf | exit) switches <text-switch-hostnames>Adds a switch role to one or more switches.3.0.0
netq lcm del credentialsRemoves existing LCM credentials.3.0.0
netq lcm del image <text-image-id>Deletes a Cumulus Linux install image from the LCM repository.3.0.0
netq lcm show credentials [json]Displays configured LCM credentials.3.0.0
netq lcm show images [<text-image-id>] [json]Displays Cumulus Linux install images that have been added to the LCM repository.3.0.0
netq lcm show status <text-lcm-job-id> [json]Displays the status of an LCM upgrade task.3.0.0
netq lcm show switches [version <text-cumulus-linux-version>] [json]Displays all the switches running Cumulus Linux that are managed under LCM.3.0.0
netq lcm show upgrade-jobs [json]Displays all the LCM upgrade jobs and their status.3.0.0
netq lcm upgrade name <text-job-name> image-id <text-image-id> license <text-cumulus-license> hostnames <text-switch-hostnames> [order <text-upgrade-order>] [run-before-after]Creates and runs a new upgrade job.3.0.0
netq config add agent command service-key <text-service-key-anchor> [poll-period <text-cmd-periodicity>] [command <text-cmd-text>] [enable True | enable False]Configures, enables and disables modular agent commands that the NetQ agent runs at preset intervals.3.0.0
netq config agent factory-reset commandsRestores modular agent commands to their defaults.3.0.0
netq config del agent command service-key <text-service-key-anchor>Deletes a modular agent command.3.0.0
netq config show agent commands [service-key <text-service-key-anchor>] [json]Displays the modular agent commands.3.0.0

Modified Commands

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

Updated CommandOld CommandWhat ChangedVersion
netq [<hostname>] show ethtool-stats port <physical-port> (rx | tx) [extended] [around <text-time>] [json]netq [<hostname>] show ethtool-stats [<physical-port>] [rx | tx | min] [around <text-time>] [json]The port, rx and tx options are now required. Removed the min option. Added the extended option to show more statistics.3.0.0
netq [<hostname>] show events [level info | level error | level warning | level critical | level debug] [type clsupport | type ntp | type mtu | type configdiff | type vlan | type trace | type vxlan | type clag | type bgp | type interfaces | type interfaces-physical | type agents | type ospf | type evpn | type macs | type services | type lldp | type license | type os | type sensors | type btrfsinfo] [between <text-time> and <text-endtime>] [json]netq [<hostname>] show events [level info | level error | level warning | level critical | level debug] [type clsupport | type ntp | type mtu | type configdiff | type vlan | type trace | type vxlan | type clag | type bgp | type interfaces | type interfaces-physical | type agents | type ospf | type evpn | type lnv | type macs | type services | type lldp | type license | type os | type sensors | type btrfsinfo] [between <text-time> and <text-endtime>] [json]Removed type lnv since LNV is no longer supported in Cumulus Linux.3.0.0
netq [<hostname>] show interface-utilization [<text-port>] [tx|rx] [around <text-time>] [json]netq [<hostname>] show interface-utils [<text-port>] [tx|rx] [around <text-time>] [json]Changed interface-utils keyword to interface-utilization.3.0.0
netq check agents [hostnames <text-list-hostnames>] [include <agent-number-range-list> | exclude <agent-number-range-list>] [around <text-time>] [json]netq check agents [include <agent-number-range-list> | exclude <agent-number-range-list>] [around <text-time>] [json]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check bgp [hostnames <text-list-hostnames>] [vrf <vrf>] [include <bgp-number-range-list> | exclude <bgp-number-range-list>] [around <text-time>] [json | summary]netq check bgp [vrf <vrf>] [include <bgp-number-range-list> | exclude <bgp-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check cl-version [hostnames <text-list-hostnames>] [match-version <cl-ver> | min-version <cl-ver>] [include <version-number-range-list> | exclude <version-number-range-list>] [around <text-time>] [json | summary]netq check cl-version [match-version <cl-ver> | min-version <cl-ver>] [include <version-number-range-list> | exclude <version-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check clag [hostnames <text-list-hostnames> ] [include <clag-number-range-list> | exclude <clag-number-range-list>] [around <text-time>] [json | summary]netq check clag [include <clag-number-range-list> | exclude <clag-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check evpn [mac-consistency] [hostnames <text-list-hostnames>] [include <evpn-number-range-list> | exclude <evpn-number-range-list>] [around <text-time>] [json | summary]netq check evpn [mac-consistency] [include <evpn-number-range-list> | exclude <evpn-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check interfaces [hostnames <text-list-hostnames>] [include <interface-number-range-list> | exclude <interface-number-range-list>] [around <text-time>] [json | summary]netq check interfaces [include <interface-number-range-list> | exclude <interface-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check license [hostnames <text-list-hostnames>] [include <license-number-range-list> | exclude <license-number-range-list>] [around <text-time>] [json | summary]netq check license [include <license-number-range-list> | exclude <license-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check mlag [hostnames <text-list-hostnames> ] [include <mlag-number-range-list> | exclude <mlag-number-range-list>] [around <text-time>] [json | summary]netq check mlag [include <mlag-number-range-list> | exclude <mlag-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check mtu [hostnames <text-list-hostnames>] [unverified] [include <mtu-number-range-list> | exclude <mtu-number-range-list>] [around <text-time>] [json | summary]netq check mtu [unverified] [include <mtu-number-range-list> | exclude <mtu-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check ntp [hostnames <text-list-hostnames>] [include <ntp-number-range-list> | exclude <ntp-number-range-list>] [around <text-time>] [json | summary]netq check ntp [include <ntp-number-range-list> | exclude <ntp-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check ospf [hostnames <text-list-hostnames>] [include <ospf-number-range-list> | exclude <ospf-number-range-list>] [around <text-time>] [json | summary]netq check ospf [include <ospf-number-range-list> | exclude <ospf-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check sensors [hostnames <text-list-hostnames>] [include <sensors-number-range-list> | exclude <sensors-number-range-list>] [around <text-time>] [json | summary]netq check sensors [include <sensors-number-range-list> | exclude <sensors-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check vlan [hostnames <text-list-hostnames>] [unverified] [include <vlan-number-range-list> | exclude <vlan-number-range-list>] [around <text-time>] [json | summary]netq check vlan [unverified] [include <vlan-number-range-list> | exclude <vlan-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq check vxlan [hostnames <text-list-hostnames>] [include <vxlan-number-range-list> | exclude <vxlan-number-range-list>] [around <text-time>] [json | summary]netq check vxlan [include <vxlan-number-range-list> | exclude <vxlan-number-range-list>] [around <text-time>] [json | summary]Added ability to specify a list of hostnames using the hostnames <text-list-hostnames>] option.3.0.0
netq show ip addresses [<remote-interface>] [<ipv4>|<ipv4/prefixlen>] [vrf <vrf>] [subnet|supernet|gateway] [around <text-time>] [json]netq show ip addresses [<remote-interface>] [<ipv4>|<ipv4/prefixlen>] [vrf <vrf>] [around <text-time>] [json]Added the ability to display all addresses in a subnet or supernet or the layer 3 gateway of an address.3.0.0
netq show ipv6 addresses [<remote-interface>] [<ipv6>|<ipv6/prefixlen>] [vrf <vrf>] [subnet|supernet|gateway] [around <text-time>] [json]netq show ipv6 addresses [<remote-interface>] [<ipv6>|<ipv6/prefixlen>] [vrf <vrf>] [around <text-time>] [json]Added the ability to display all addresses in a subnet or supernet or the layer 3 gateway of an address.3.0.0

Removed Commands

The following table summarizes the previously deprecated commands that have been removed from Cumulus NetQ.

CommandSummaryVersion
netq [<hostname>] show lnv [around <text-time>] [json]LNV is no longer supported in Cumulus Linux.3.0.0
netq check lnv [around <text-time>] [json]LNV is no longer supported in Cumulus Linux.3.0.0