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 dashboards where you collect and view data. 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, Validation Summary, What Just Happened, Host Inventory, DPU Inventory, and Events cards.

default netq workbench

Upon initial login, the NetQ Workbench opens. Upon subsequent logins, the last workbench you viewed opens.

Custom Workbenches

People with either administrative or user roles can create and save an unlimited number of custom workbenches. For example, you might create a workbench that:

  • Shows network statistics for the past week alongside network statistics for the past 24 hours.
  • Only displays data about virtual overlays.
  • Displays switches that you are troubleshooting.
  • Is focused on application or account management.

Create a Workbench

  1. Select add icon New in the workbench header.

  2. Enter a name for the workbench and choose whether to set it as your default home workbench.

  3. Select the cards you would like displayed on your new workbench.

    interface displaying the cards a user can select to add to their workbench
  4. Click Create.

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

Clone a Workbench

To create a duplicate of an existing workbench:

  1. Select Clone in the workbench header.

  2. Name the cloned workbench and select Clone.

Remove a Workbench

Admins can remove any workbench, except for the default NetQ Workbench. User accounts can only remove workbenches they have created.

To remove a workbench:

  1. Select profile icon User Settings in the top-right corner.

  2. Select 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
    • Expand the Menu and select the workbench from the Favorites or Workbenches sections
  • Open through the NVIDIA logo
    • Click the logo in the header to open your favorite workbench

Manage Auto-refresh

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 2 minutes

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

To modify the auto-refresh setting:

  1. Select the dropdown next to Refresh.

  2. Select the refresh rate. A check mark indicates the current selection. The new refresh rate is applied immediately.

    refresh rate dropdown listng rate options of 30 seconds, 1 minute, and 2 minutes

To disable auto-refresh, select pause icon Pause. When you’re ready for the data to refresh, select play icon Play.