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.


Use the CLI to monitor OSI Layer 1 physical components on network devices, including interfaces, ports, links, and peers. You can monitor transceivers and cabling deployed per port (interface), per vendor, per part number, and so forth.

This information can help you:

  • Determine which ports are empty versus which ones have cables plugged in to help validate expected connectivity.
  • Audit transceiver and cable components by vendor, helping you estimate replacement costs, repair costs, and overall maintenance costs.
  • Identify mismatched links.
  • Identify when physical layer changes (for example, bonds and links going down or flapping) occurred.

NetQ uses LLDP (Link Layer Discovery Protocol) to collect port information. NetQ can also identify peer ports connected to DACs (Direct Attached Cables) and AOCs (Active Optical Cables) without using LLDP, even if the link is not UP.

Physical Interfaces

View performance and status information about cables, transceiver modules, and interfaces with netq show interfaces physical:

netq [<hostname>] show interfaces physical [<physical-port>] [empty|plugged] [peer] [vendor <module-vendor>|model <module-model>|module] [around <text-time>] [json]

View Detailed Cable Information for All Devices

  • View which cables connect to each interface port for all devices, including the module type, vendor, part number and performance characteristics.
  • View the cable information for a given device by adding a hostname to show.
show interfaces physical

View Detailed Module Information for a Given Device

  • View detailed information about the transceiver modules on each interface port, including serial number, transceiver type, connector, and attached cable length.
  • View the module information for a given device by adding a hostname to show.
show interfaces physical module

View Ports without Cables Connected for a Given Device

  • Check for empty ports and compare expected versus actual deployment.
  • View the cable information for a given device by adding a hostname to show.
show interfaces physical empty

View Ports with Cables Connected for a Given Device

  • Check for ports that have cables connected, and compare expected versus actual deployment.
  • View the cable information for a given device by adding a hostname to show.
show interfaces physical plugged

View Components from a Given Vendor

  • Filter for a specific cable vendor to collect information such as how many ports use components from that vendor and when they were last updated.
show interfaces physical vendor

View All Devices Using a Given Component

  • View all devices with ports using a particular component.
show interfaces physical model

View Changes to Physical Components

  • View changes to the physical components on your devices.
show events type interfaces-physical with time constraints

View Utilization Statistics Networkwide

Utilization statistics can indicate whether resources are becoming dangerously close to their maximum capacity or other, user-defined thresholds. Depending on the function of the switch, the acceptable thresholds can vary.

View Compute Resources Utilization

  • View how many compute resources—CPU, disk, and memory—the switches on your network consume:
netq <hostname> show resource-util [cpu | memory] [around <text-time>] [json]
netq <hostname> show resource-util disk [<text-diskname>] [around <text-time>] [json]

If you do not specify options, the output shows the percentage of CPU and memory the switch consumed as well as the amount and percentage of disk space it consumed.

show resource-util

View Port Statistics

  • View statistics about a given node and interface, including frame errors, ACL drops, and buffer drops, with ethtool:
netq [<hostname>] show ethtool-stats port <physical-port> (rx | tx) [extended] [around <text-time>] [json]

If there are no changes, a “No matching ethtool_stats records found” message appears.

show ethtool-stats port

View Interface Statistics and Utilization

NetQ Agents collect performance statistics every 30 seconds for the physical interfaces on switches in your network. The NetQ Agent does not collect statistics for non-physical interfaces, such as bonds, bridges, and VXLANs. The NetQ Agent collects the following statistics:

  • Statistics
    • Transmit: tx_bytes, tx_carrier, tx_colls, tx_drop, tx_errs, tx_packets
    • Receive: rx_bytes, rx_drop, rx_errs, rx_frame, rx_multicast, rx_packets
  • Utilization
    • rx_util, tx_util
    • port speed

To view the interface statistics and utilization, run:

netq show interface-stats [errors | all] [<physical-port>] [around <text-time>] [json]
netq show interface-utilization [<text-port>] [tx|rx] [around <text-time>] [json]

Options include:

  • errors limits the output to only the transmit and receive errors found on the designated interfaces
  • physical-port limits the output to a particular port (interface)
  • around enables viewing of the data at a time in the past
  • json outputs results in JSON format
  • text-port limits output to a particular host and port; this option requires a hostname
  • tx, rx limits output to the transmit or receive values, respectively
show interface-stats
show interface-utilization

View ACL Resource Utilization Networkwide

  • View incoming and outgoing access control lists (ACLs) configured on all switches and host:
netq show cl-resource acl [ingress | egress] [around <text-time>] [json]

Use the egress or ingress options to show only the outgoing or incoming ACLs.

show cl-resource acl

View Forwarding Resources Utilization Networkwide

  • View forwarding resources on all devices, currently or at a time in the past:
netq show cl-resource forwarding [around <text-time>] [json]
show cl-resource forwarding

View SSD Utilization Networkwide

For NetQ Appliances that have 3ME3 solid state drives (SSDs) installed (primarily in on-premises deployments), you can view the utilization of the drive on demand. A warning is generated when a drive drops below 10% health, or has more than a 2% loss of health in 24 hours, indicating the need to rebalance the drive. Tracking SSD utilization over time lets you see any downward trend or drive instability before you receive a warning message.

To view SDD utilization, run:

netq show cl-ssd-util [around <text-time>] [json]
show cl-ssd-util

View Disk Storage After BTRFS Allocation Networkwide

Customers running Cumulus Linux 3 which uses the BTRFS (b-tree file system) might experience issues with disk space management. This is a known problem of BTRFS because it does not perform periodic garbage collection, or rebalancing. If left unattended, these errors can make it impossible to rebalance the partitions on the disk. To avoid this issue, NVIDIA recommends rebalancing the BTRFS partitions in a preemptive manner, but only when absolutely needed to avoid reduction in the lifetime of the disk. By tracking the state of the disk space usage, users can determine when to rebalance.

For details about when to rebalance a partition, refer to When to Rebalance BTRFS Partitions.

To view BTRFS disk utilization, run:

netq show cl-btrfs-util [around <text-time>] [json]
show cl-btrfs-info


Use the CLI to monitor interface (link) health using the netq show interfaces command.

The syntax for interface commands is:

netq show interfaces type (bond|bridge|eth|loopback|macvlan|swp|vlan|vrf|vxlan) [state <remote-interface-state>] [around <text-time>] [json]
netq <hostname> show interfaces type (bond|bridge|eth|loopback|macvlan|swp|vlan|vrf|vxlan) [state <remote-interface-state>] [around <text-time>] [count] [json]
netq [<hostname>] show events [severity info | severity error ] message_type interfaces [between <text-time> and <text-endtime>] [json]

View Status for All Interfaces

Viewing the status of all interfaces at one time can be helpful when you are trying to compare the configuration or status of a set of links.

show interfaces

View Interface Status for a Given Device

View the status of interfaces on a specific device.

spine01 show interfaces

View All Interfaces of a Given Type

View the status of a particular type of interface.

show interfaces type bond state

View the Total Number of Interfaces

To display the number of interfaces currently operating on a device, use the hostname and count options together.

leaf03 show interfaces count

View the Total Number of a Given Interface Type

View the number of interfaces of a particular type on a given device.

leaf03 show interfaces type swp count

View Aliases for Interfaces

View which interfaces have aliases.

show interfaces alias swp2

Check for MTU Inconsistencies

The maximum transmission unit (MTU) determines the largest size packet or frame that can be transmitted across a given communication link. When the MTU is not configured to the same value on both ends of the link, communication problems can occur. Use the netq check mtu command to verify that the MTU is correctly specified for each link.

check mtu