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.

NetQ UI Card Reference

This reference describes the cards available with the NetQ 3.2 graphical user interface (NetQ UI). Each item and field on the four sizes of cards is shown. You can open cards using one of two methods:

  • Search for the card by name in the Global Search box in the application header
  • Click . Select a card category or scroll down. Click on the desired card. Click Open Cards.

Cards opened on the default Cumulus Workbench are not saved. Create a new workbench and open cards there to save and view the cards at a later time.

Cards are listed in alphabetical order by name.

Event Cards

The event cards are located on the default Cumulus workbench. They can also be added to user-created workbenches.

Events|Alarms Card

You can easily monitor critical events occurring across your network using the Alarms card. You can determine the number of events for the various system, interface, and network protocols and services components in the network.

The small Alarms card displays:

The medium Alarms card displays:

The large Alarms card has one tab.

The Alarm Summary tab displays:

The full screen Alarms card provides tabs for all events.

Events|Info Card

You can easily monitor warning, info, and debug severity events occurring across your network using the Info card. You can determine the number of events for the various system, interface, and network protocols and services components in the network.

The small Info card displays:

The medium Info card displays:

The large Info card displays:

The full screen Info card provides tabs for all events.

Inventory Cards

The inventory cards are located on the default Cumulus workbench. They can also be added to user-created workbenches.

Inventory|Devices Card

The small Devices Inventory card displays:

The medium Devices Inventory card displays:

The large Devices Inventory card has one tab.

The Switches tab displays:

The full screen Devices Inventory card provides tabs for all switches and all hosts.

Inventory|Switch Card

Knowing what components are included on all of your switches aids in upgrade, compliance, and other planning tasks. Viewing this data is accomplished through the Switch Inventory card.

The small Switch Inventory card displays:

ItemDescription
Indicates data is for switch inventory
CountTotal number of switches in the network inventory
ChartDistribution of overall health status during the designated time period; fresh versus rotten

The medium Switch Inventory card displays:

The large Switch Inventory card contains four tabs.

The Summary tab displays:

The ASIC tab displays:

The Platform tab displays:

The Software tab displays:

The full screen Switch Inventory card provides tabs for all components, ASIC, platform, CPU, memory, disk, and OS components.

Network Health Card

As with any network, one of the challenges is keeping track of all of the moving parts. With the NetQ GUI, you can view the overall health of your network at a glance and then delve deeper for periodic checks or as conditions arise that require attention. For a general understanding of how well your network is operating, the Network Health card workflow is the best place to start as it contains the highest view and performance roll-ups.

The Network Health card is located on the default Cumulus workbench. It can also be added to user-created workbenches.

The small Network Health card displays:

The medium Network Health card displays the distribution, score, and trend of the:

The large Network Health card contains three tabs.

The System Health tab displays:

The Network Service Health tab displays:

The Interface Health tab displays:

The full screen Network Health card displays all events in the network.

Network Services Cards

There are two cards for each of the supported network protocols and services—one for the service as a whole and one for a given session. The network services cards can be added to user-created workbenches.

ALL BGP Sessions Card

This card displays performance and status information for all BGP sessions across all nodes in your network.

The small BGP Service card displays:

The medium BGP Service card displays:

The large BGP service card contains two tabs.

The Sessions Summary tab displays:

The Alarms tab displays:

The full screen BGP Service card provides tabs for all switches, all sessions, and all alarms.

BGP Session Card

This card displays performance and status information for a single BGP session. Card is opened from the full-screen Network Services|All BGP Sessions card.

The small BGP Session card displays:

The medium BGP Session card displays:

The large BGP Session card contains two tabs.

The Session Summary tab displays:

The Configuration File Evolution tab displays:

The full screen BGP Session card provides tabs for all BGP sessions and all events.

With NetQ, you can monitor the number of nodes running the EVPN service, view switches with the sessions, total number of VNIs, and alarms triggered by the EVPN service. For an overview and how to configure EVPN in your data center network, refer to Ethernet Virtual Private Network-EVPN .

All EVPN Sessions Card

This card displays performance and status information for all EVPN sessions across all nodes in your network.

The small EVPN Service card displays:

The medium EVPN Service card displays:

The large EVPN service card contains two tabs.

The Sessions Summary tab which displays:

The Alarms tab which displays:

The full screen EVPN Service card provides tabs for all switches, all sessions, all alarms.

EVPN Session Card

This card displays performance and status information for a single EVPN session. Card is opened from the full-screen Network Services|All EVPN Sessions card.

The small EVPN Session card displays:

The medium EVPN Session card displays:

The large EVPN Session card contains two tabs.

The Session Summary tab displays:

The Configuration File Evolution tab displays:

The full screen EVPN Session card provides tabs for all EVPN sessions and all events.

ALL LLDP Sessions Card

This card displays performance and status information for all LLDP sessions across all nodes in your network.

With NetQ, you can monitor the number of nodes running the LLDP service, view nodes with the most LLDP neighbor nodes, those nodes with the least neighbor nodes, and view alarms triggered by the LLDP service. For an overview and how to configure LLDP in your data center network, refer to Link Layer Discovery Protocol .

The small LLDP Service card displays:

The medium LLDP Service card displays:

The large LLDP service card contains two tabs.

The Sessions Summary tab which displays:

The Alarms tab which displays:

The full screen LLDP Service card provides tabs for all switches, all sessions, and all alarms.

LLDP Session Card

This card displays performance and status information for a single LLDP session. Card is opened from the full-screen Network Services|All LLDP Sessions card.

The small LLDP Session card displays:

The medium LLDP Session card displays:

The large LLDP Session card contains two tabs.

The Session Summary tab displays:

The Configuration File Evolution tab displays:

The full screen LLDP Session card provides tabs for all LLDP sessions and all events.

All MLAG Sessions Card

This card displays performance and status information for all MLAG sessions across all nodes in your network.

The small MLAG Service card displays:

The medium MLAG Service card displays:

The large MLAG service card contains two tabs.

The All MLAG Sessions summary tab which displays:

The All MLAG Alarms tab which displays:

The full screen MLAG Service card provides tabs for all switches, all sessions, and all alarms.

MLAG Session Card

This card displays performance and status information for a single MLAG session. Card is opened from the full-screen Network Services|All MLAG Sessions card.

The small MLAG Session card displays:

The medium MLAG Session card displays:

The large MLAG Session card contains two tabs.

The Session Summary tab displays:

The Configuration File Evolution tab displays:

The full screen MLAG Session card provides tabs for all MLAG sessions and all events.

All OSPF Sessions Card

This card displays performance and status information for all OSPF sessions across all nodes in your network.

The small OSPF Service card displays:

The medium OSPF Service card displays:

The large OSPF service card contains two tabs.

The Sessions Summary tab displays:

The Alarms tab displays:

The full screen OSPF Service card provides tabs for all switches, all sessions, and all alarms.

OSPF Session Card

This card displays performance and status information for a single OSPF session. Card is opened from the full-screen Network Services|All OSPF Sessions card.

The small OSPF Session card displays:

The medium OSPF Session card displays:

The large OSPF Session card contains two tabs.

The Session Summary tab displays:

The Configuration File Evolution tab displays:

The full screen OSPF Session card provides tabs for all OSPF sessions and all events.

Switch Card

Viewing detail about a particular switch is essential when troubleshooting performance issues. With NetQ you can view the overall performance and drill down to view attributes of the switch, interface performance and the events associated with a switch. This is accomplished through the Switches card.

Switch cards can be added to user-created workbenches. Click to open a switch card.

The small Switch card displays:

The medium Switch card displays:

The large Switch card contains four tabs:

The Attributes tab displays:

The Utilization tab displays:

The Interfaces tab displays:

The Digital Optics tab displays:

The full screen Switch card provides multiple tabs.

Trace Cards

There are three cards used to perform on-demand and scheduled traces—one for the creation of on-demand and scheduled traces and two for the results. Trace cards can be added to user-created workbenches.

Trace Request Card

This card is used to create new on-demand or scheduled trace requests or to run a scheduled trace on demand.

The small Trace Request card displays:

The medium Trace Request card displays:

The large Trace Request card displays:

The full screen Trace Request card displays:

On-demand Trace Results Card

This card is used to view the results of on-demand trace requests.

The small On-demand Trace Results card displays:

The medium On-demand Trace Results card displays:

The large On-demand Trace Results card contains two tabs.

The On-demand Trace Result tab displays:

The On-demand Trace Settings tab displays:

The full screen On-demand Trace Results card displays:

Scheduled Trace Results Card

This card is used to view the results of scheduled trace requests.

The small Scheduled Trace Results card displays:

The medium Scheduled Trace Results card displays:

The large Scheduled Trace Results card contains two tabs:

The Results tab displays:

The Configuration tab displays:

The full screen Scheduled Trace Results card displays:

Validation Cards

There are three cards used to perform on-demand and scheduled validations—one for the creation of on-demand and scheduled validations and two for the results. Validation cards can be added to user-created workbenches.

Validation Request Card

This card is used to create a new on-demand or scheduled validation request or run a scheduled validation on demand.

The small Validation Request card displays:

The medium Validation Request card displays:

The large Validation Request card displays:

The full screen Validation Request card displays all scheduled validation requests.

On-Demand Validation Result Card

This card is used to view the results of on-demand validation requests.

The small Validation Result card displays:

The medium Validation Result card displays:

The large Validation Result card contains two tabs.

The Summary tab displays:

The Configuration tab displays:

The full screen Validation Result card provides a tab for all on-demand validation results.

Scheduled Validation Result Card

This card is used to view the results of scheduled validation requests.

The small Scheduled Validation Result card displays:

The medium Scheduled Validation Result card displays:

The large Scheduled Validation Result card contains two tabs.

The Summary tab displays:

The Configuration tab displays:

The full screen Scheduled Validation Result card provides tabs for all scheduled validation results for the service.