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.

Focus Your Monitoring Using Workbenches

Workbenches are where you collect and view the data that is important to you.

Two types of workbenches are available:

  • Default: Provided by NVIDIA; you cannot save changes you make to these workbenches
  • Custom: Created by the user; changes made to these workbenches are saved automatically

Both types of workbenches display a set of cards. Default workbenches are public (accessible to all users), whereas custom workbenches are private (viewing is restricted to the user who created them).

Default Workbenches

The default workbench contains Device Inventory, Switch Inventory, Events, and Network Health cards, giving you a high-level view of how your network is operating.

default netq workbench

On initial login, the NetQ Workbench opens. On subsequent logins, the last workbench you used opens.

Custom Workbenches

Users with either administrative or user roles can create and save as many custom workbenches as suits their needs. For example, a user might create a workbench that:

  • Shows all of the selected cards for the past week and one that shows all of the selected cards for the past 24 hours
  • Only has data about your virtual overlays; EVPN plus events cards
  • Has selected switches that you are troubleshooting
  • Is focused on application or user account management

And so forth.

Create a Workbench

To create a workbench:

  1. Click in the workbench header.

  2. Enter a name for the workbench.

  3. Click “Set as home workbench” if you would like to set this as your new default home workbench.

  4. Select the cards you would like to display on your new workbench by clicking on the desired cards:

  5. Click Create to create your new workbench.

Refer to Access Data with Cards for information about interacting with cards on your workbenches.

Clone a Workbench

To create a duplicate clone based on an existing workbench:

  1. Click in the workbench header.

  2. Set a name for the cloned workbench.

  3. Click “set as home workbench” if you would like to set this as your new default home workbench.

  4. Click Clone to clone the workbench.

Remove a Workbench

Once you have created a number of custom workbenches, you might find that you no longer need some of them. As an administrative user, you can remove any workbench, except for the default NetQ Workbench. Users with a user role can only remove workbenches they have created.

To remove a workbench:

  1. Click in the application header to open the User Settings options.

  2. Click Profile & Preferences.

  3. Locate the Workbenches card.

  4. Hover over the workbench you want to remove, and click Delete.

Open an Existing Workbench

There are several options for opening workbenches:

  • Open through the Workbench header
    • Click next to the current workbench name and locate the workbench
      • Under My Home, click the name of your favorite workbench
      • Under My Most Recent, click the workbench if in list
      • Search by workbench name
      • Click All My WB to open all workbenches and select it from the list
  • Open through the main menu
    • Click (main menu) and select the workbench from the Favorites or NetQ columns
  • Open through the NVIDIA logo
    • Click the logo in the header to open your favorite workbench

Manage Auto-refresh for Your Workbenches

You can specify how often to update the data displayed on your workbenches. Three refresh rates are available:

  • Analyze: updates every 30 seconds
  • Debug: updates every minute
  • Monitor: updates every two (2) minutes

By default, auto-refresh is enabled and configured to update every 30 seconds.

Disable/Enable Auto-refresh

To disable or pause auto-refresh of your workbenches, click the Refresh icon. This toggles between the two states, Running and Paused, where indicates it is currently disabled and indicates it is currently enabled.

While having the workbenches update regularly is good most of the time, you might find that you want to pause the auto-refresh feature when you are troubleshooting and you do not want the data to change on a given set of cards temporarily. In this case, you can disable the auto-refresh and then enable it again when you are finished.

View Current Settings

To view the current auto-refresh rate and operational status, hover over the Refresh icon on a workbench header, to open the tool tip as follows:

Change Settings

To modify the auto-refresh setting:

  1. Click the Refresh icon.

  2. Select the refresh rate you want. The refresh rate is applied immediately. A check mark is shown next to the current selection.

Manage Workbenches

To manage your workbenches as a group, either:

  • Click next to the current workbench name, then click Manage My WB.
  • Click , select Profiles & Preferences.

Both of these open the Profiles & Preferences page. Look for the Workbenches card and refer to Manage Your Workbenches for more information.