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 an integral structure of the Cumulus NetQ application. They are where you collect and view the data that is important to you.

There are two types of workbenches:

  • Default: Provided by Cumulus Networks for use as they exist; changes made to these workbenches cannot be saved
  • Custom: Created by application users when default workbenches need some adjustments to better meet your needs or a completely different collection of cards is wanted; changes made to these workbenches are saved automatically.

Both types of workbenches display a set of cards. Default workbenches are public (available for viewing by all users), whereas Custom workbenches are private (only viewable by user who created them).

Default Workbenches

In this release, only one default workbench is available, the Cumulus Workbench, to get you started. It contains Device Inventory, Switch Inventory, Alarm and Info Events, and Network Health cards, giving you a high-level view of how your network is operating.

On initial login, the Cumulus Workbench is opened. On subsequent logins, the last workbench you had displayed is opened.

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
  • focused on application or user account management
  • etc.

Create a Workbench

To create a workbench:

  1. Click in the workbench header.

  2. Enter a name for the workbench.

  3. Click Create to open a blank new workbench, or Cancel to discard the workbench.

  4. Add cards to the workbench using or .

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

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 Cumulus 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 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 Main Menu
    • Click (Main Menu) and select the workbench from the Favorites or NetQ columns
  • Open through Cumulus logo
    • Click the logo in the header to open your favorite workbench

Manage Auto-refresh for Your Workbenches

With NetQ 2.3.1 and later, 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, simply 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 may 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 on 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 option.

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