Manage the NetQ UI

As an administrator, you can manage access to and various application-wide settings for the NetQ UI from a single location.

Individual users have the ability to set preferences specific to their workspaces. This information is covered separately. Refer to Set User Preferences.

NetQ Management Workbench

The NetQ Management workbench is accessed from the main menu. For users responsible for maintaining the application, this is a good place to start each day.

To open the workbench, click , and select Management under the Admin column. The cards available vary slightly between the on-premises and cloud deployments. The on-premises management dashboard has an LDAP Server Info card, which the cloud version does not. The cloud management dashboard has an SSO Config card, which the on-premises version does not.

On-premises NetQ Management Dashboard

On-premises NetQ Management Dashboard

Cloud NetQ Management Dashboard

Cloud NetQ Management Dashboard

Manage User Accounts

From the NetQ Management workbench, you can view the number of users with accounts in the system. As an administrator, you can also add, modify, and delete user accounts using the User Accounts card.

Add New User Account

For each user that monitors at least one aspect of your data center network, a user account is needed. Adding a local user is described here. Refer to Integrate NetQ with Your LDAP server for instructions for adding LDAP users.

To add a new user account:

  1. Click Manage on the User Accounts card to open the User Accounts tab.

  2. Click Add User.

  3. Enter the user’s email address, along with their first and last name.

    Be especially careful entering the email address as you cannot change it once you save the account. If you save a mistyped email address, you must delete the account and create a new one.

  4. Select the user type: Admin or User.

  5. Enter your password in the Admin Password field (only users with administrative permissions can add users).

  6. Create a password for the user.

    1. Enter a password for the user.
    2. Re-enter the user password. If you do not enter a matching password, it will be underlined in red.
  7. Click Save to create the user account, or Cancel to discard the user account.

    By default the User Accounts table is sorted by Role.

  8. Repeat these steps to add all of your users.

Edit a User Name

If a user’s first or last name was incorrectly entered, you can fix them easily.

To change a user name:

  1. Click Manage on the User Accounts card to open the User Accounts tab.

  2. Click the checkbox next to the account you want to edit.

  3. Click above the account list.

  4. Modify the first and/or last name as needed.

  5. Enter your admin password.

  6. Click Save to commit the changes or Cancel to discard them.

Change a User’s Password

Should a user forget his password or for security reasons, you can change a password for a particular user account.

To change a password:

  1. Click Manage on the User Accounts card to open the User Accounts tab.

  2. Click the checkbox next to the account you want to edit.

  3. Click above the account list.

  4. Click Reset Password.

  5. Enter your admin password.

  6. Enter a new password for the user.

  7. Re-enter the user password. Tip: If the password you enter does not match, Save is gray (not activated).

  8. Click Save to commit the change, or Cancel to discard the change.

Change a User’s Access Permissions

If a particular user has only standard user permissions and they need administrator permissions to perform their job (or the opposite, they have administrator permissions, but only need user permissions), you can modify their access rights.

To change access permissions:

  1. Click Manage on the User Accounts card to open the User Accounts tab.

  2. Click the checkbox next to the account you want to edit.

  3. Click above the account list.

  4. Select the appropriate user type from the dropdown list.

  5. Enter your admin password.

  6. Click Save to commit the change, or Cancel to discard the change.

Correct a Mistyped User ID (Email Address)

You cannot edit a user’s email address, because this is the identifier the system uses for authentication. If you need to change an email address, you must create a new one for this user. Refer to Add New User Account. You should delete the incorrect user account. Select the user account, and click .

Export a List of User Accounts

You can export user account information at any time using the User Accounts tab.

To export information for one or more user accounts:

  1. Click Manage on the User Accounts card to open the User Accounts tab.

  2. Select one or more accounts that you want to export by clicking the checkbox next to them. Alternately select all accounts by clicking .

  3. Click to export the selected user accounts.

Delete a User Account

NetQ application administrators should remove user accounts associated with users that are no longer using the application.

To delete one or more user accounts:

  1. Click Manage on the User Accounts card to open the User Accounts tab.

  2. Select one or more accounts that you want to remove by clicking the checkbox next to them.

  3. Click to remove the accounts.

Manage User Login Policies

NetQ application administrators can configure a session expiration time and the number of times users can refresh before requiring users to re-login to the NetQ application.

To configure these login policies:

  1. Click (main menu), and select Management under the Admin column.

  2. Locate the Login Management card.

  3. Click Manage.

  4. Select how long a user may be logged in before logging in again; 30 minutes, 1, 3, 5, 6, or 8 hours. Default for on-premises deployments is 6 hours. Default for cloud deployments is 30 minutes.

  5. Indicate the amount of time in seconds the application can be refreshed before the user must log in again. Default is 1440 seconds (1 day).

  6. Enter your admin password.

  7. Click Update to save the changes, or click Cancel to discard them.

    The Login Management card shows the configuration.

Monitor User Activity

NetQ application administrators can audit user activity in the application using the Activity Log.

To view the log, click (main menu), then click Activity Log under the Admin column.

Click to filter the log by username, action, resource, and time period.

Click to export the log a page at a time.

Manage Scheduled Traces

From the NetQ Management workbench, you can view the number of traces scheduled to run in the system. A set of default traces are provided with the NetQ GUI. As an administrator, you can run one or more scheduled traces, add new scheduled traces, and edit or delete existing traces.

Add a Scheduled Trace

You can create a scheduled trace to provide regular status about a particularly important connection between a pair of devices in your network or for temporary troubleshooting.

To add a trace:

  1. Click Manage on the Scheduled Traces card to open the Scheduled Traces tab.

  2. Click Add Trace to open the large New Trace Request card.

  3. Enter source and destination addresses.

    For layer 2 traces, the source must be a hostname and the destination must be a MAC address. For layer 3 traces, the source can be a hostname or IP address, and the destination must be an IP address.

  4. Specify a VLAN for a layer 2 trace or (optionally) a VRF for a layer 3 trace.

  5. Set the schedule for the trace, by selecting how often to run the trace and when to start it the first time.

  6. Click Save As New to add the trace. You are prompted to enter a name for the trace in the Name field.

    If you want to run the new trace right away for a baseline, select the trace you just added from the dropdown list, and click Run Now.

Delete a Scheduled Trace

If you do not want to run a given scheduled trace any longer, you can remove it.

To delete a scheduled trace:

  1. Click Manage on the Scheduled Trace card to open the Scheduled Traces tab.

  2. Select at least one trace by clicking on the checkbox next to the trace.

  3. Click .

Export a Scheduled Trace

You can export a scheduled trace configuration at any time using the Scheduled Traces tab.

To export one or more scheduled trace configurations:

  1. Click Manage on the Scheduled Trace card to open the Scheduled Traces tab.

  2. Select one or more traces by clicking on the checkbox next to the trace. Alternately, click to select all traces.

  3. Click to export the selected traces.

Manage Scheduled Validations

From the NetQ Management workbench, you can view the total number of validations scheduled to run in the system. A set of default scheduled validations are provided and pre-configured with the NetQ UI. These are not included in the total count. As an administrator, you can view and export the configurations for all scheduled validations, or add a new validation.

View Scheduled Validation Configurations

You can view the configuration of a scheduled validation at any time. This can be useful when you are trying to determine if the validation request needs to be modified to produce a slightly different set of results (editing or cloning) or if it would be best to create a new one.

To view the configurations:

  1. Click Manage on the Scheduled Validations card to open the Scheduled Validations tab.

  2. Click in the top right to return to your NetQ Management cards.

Add a Scheduled Validation

You can add a scheduled validation at any time using the Scheduled Validations tab.

To add a scheduled validation:

  1. Click Manage on the Scheduled Validations card to open the Scheduled Validations tab.

  2. Click Add Validation to open the large Validation Request card.

  3. Configure the request. Refer to Validate Network Protocol and Service Operations for details.

Delete Scheduled Validations

You can remove a scheduled validation that you created (one of the 15 allowed) at any time. You cannot remove the default scheduled validations included with NetQ.

To remove a scheduled validation:

  1. Click Manage on the Scheduled Validations card to open the Scheduled Validations tab.

  2. Select one or more validations that you want to delete.

  3. Click above the validations list.

Export Scheduled Validation Configurations

You can export one or more scheduled validation configurations at any time using the Scheduled Validations tab.

To export a scheduled validation:

  1. Click Manage on the Scheduled Validations card to open the Scheduled Validations tab.

  2. Select one or more validations by clicking the checkbox next to the validation. Alternately, click to select all validations.

  3. Click to export selected validations.

Manage Threshold Crossing Rules

NetQ supports a set of events that are triggered by crossing a user-defined threshold, called TCA events. These events allow detection and prevention of network failures for selected ACL resources, digital optics, forwarding resources, interface errors and statistics, link flaps, resource utilization, sensor and WJH events. A complete list of supported events can be found in the TCA Event Messages Reference.

Instructions for managing these rules can be found in Manage Threshold-based Event Notifications.

Manage Notification Channels

NetQ supports Slack, PagerDuty, and syslog notification channels for reporting system and threshold-based events. You can access channel configuration in one of two ways:

  • Click Manage on the Channels card

  • Click , and then click Channels in the Notifications column

In either case, the Channels view is opened.

Determine the type of channel you want to add and follow the instructions for the selected type in Configure System Event Notifications. Refer to Remove a Channel to remove a channel you no longer need.

Configure Multiple Premises

The NetQ Management dashboard provides the ability to configure a single NetQ UI and CLI for monitoring data from multiple premises. This eliminates the need to log in to each premises to view the data.

As of NetQ 3.3.0 there are two ways to implement a multi-site on-premises deployment.

  • Full NetQ deployment at each premises

    • NetQ appliance or VM running NetQ Platform software with a database
    • Each premises has its own NetQ UI and CLI and operates independently
    • The NetQ appliance or VM at one of the deployments acts as the primary premises for the premises in the other deployments (similar to a proxy)
    • A list of these secondary premises is stored with the primary deployment
  • Full NetQ deployment at primary site and smaller deployment at secondary sites

    • The NetQ appliance or VM at one of the deployments acts as the primary premises for the premises in the other deployments (similar to a proxy)
    • The primary premises runs the NetQ Platform software (including the NetQ UI and CLI) and houses the database
    • All other deployments are secondary premises; they run the NetQ Controller software and send their data to the primary premises for storage and processing
    • A list of these secondary premises is stored with the primary deployment

After the multiple premises are configured, you can view this list of premises in the NetQ UI at the primary premises, change the name of premises on the list, and delete premises from the list.

To configure secondary premises so that you can view their data using the primary site NetQ UI, follow the instructions for the relevant deployment type of the secondary premises.

In this deployment model, each NetQ deployment can be installed separately. The data is stored and can be viewed from the NetQ UI at each premises.

To configure a these premises so that their data can be viewed from one premises:

  1. Open the NetQ UI installed on the NetQ Appliance or VM in any of the premises.

  2. Click Main Menu (Main menu).

  3. Select Management from the Admin column.

  4. Locate the Premises card.

  1. Click Manage.

  2. Click External Premises.

  1. Click Add External Premises.
  1. Enter the IP address for the API gateway on the NetQ appliance or VM for one of the secondary premises.

  2. Enter the access credentials for this host.

  3. Click Next.

  4. Select the premises you want to connect.

  1. Click Finish.

  2. Add more secondary premises by clicking and repeating Steps 8-12.

In this deployment model, the data is stored and can be viewed only from the NetQ UI at the primary premises.

The primary NetQ premises must be installed before the secondary premises can be added. For the secondary premises, create the premises here, then install them.

  1. Open the NetQ UI installed on the NetQ Appliance or VM where the database resides (this is your primary premises).

  2. Click Main Menu (Main menu).

  3. Select Management from the Admin column.

  4. Locate the Premises card.

  1. Click Manage. Your primary premises (OPID0) is shown by default.

  2. Click (Add Premises).

  1. Enter the name of one of the secondary premises you want to add.

  2. Click Done.

  1. Select the premises you just created.

  2. Click to generate a configuration key.

  1. Click Copy to save the key to a safe place, or click e-mail to send it to yourself or other administrator as appropriate.

  2. Click Done.

  3. Repeat steps 6-11 to add more secondary premises.

  4. Follow the steps in the Admin UI to install and complete the configuration of these secondary premises, using these keys to activate and connect these premises to the primary NetQ premises.

System Server Information

You can easily view the configuration of the physical server or VM from the NetQ Management dashboard.

To view the server information:

  1. Click Main Menu.

  2. Select Management from the Admin column.

  3. Locate the System Server Info card.

    If no data is present on this card, it is likely that the NetQ Agent on your server or VM is not running properly or the underlying streaming services are impaired.

Integrate with Your LDAP Server

For on-premises deployments you can integrate your LDAP server with NetQ to provide access to NetQ using LDAP user accounts instead of ,or in addition to, the NetQ user accounts. Refer to Integrate NetQ with Your LDAP Server for more detail.

Integrate with Your Microsoft Azure or Google Cloud for SSO

You can integrate your NetQ Cloud deployment with a Microsoft Azure Active Directory (AD) or Google Cloud authentication server to support single sign-on (SSO) to NetQ. NetQ supports integration with SAML (Security Assertion Markup Language) or OAuth (Open Authorization). Multi-factor authentication (MFA) is also supported. Only one SSO configuration can be configured at a time. You must enable the configuration for the configuration to take effect.

Configure Support

To integrate your authentication server:

  1. Click Main Menu.

  2. Select Management from the Admin column.

  3. Locate the SSO Config card.

  4. Click Manage.

  5. Click the type of SSO to be integrated:

    • Open ID: Choose this option to integrate using OAuth with OpenID Connect
    • SAML: Choose this option to integrate using SAML
  6. Specify the required parameters.

    You need several pieces of data from your Microsoft Azure or Google account and authentication server to complete the integration. Open your account for easy cut and paste of this data into the NetQ form.

    1. Enter your administrator password. This is required when creating a new configuration.

    2. Enter a unique name for the SSO configuration.

    3. Copy the identifier for your Resource Server into the Client ID field.

    4. Copy the secret key for your Resource Server into the Client Secret field.

    5. Copy the URL of the authorization application into the Authorization Endpoint field.

    6. Copy the URL of the authorization token into the Token Endpoint field.

      This example shows a Microsoft Azure AD integration.

    1. Click Add.
    1. As indicated, copy the redirect URL https://api.netq.cumulusnetworks.com/netq/auth/v1/sso-callback into your OpenID Connect configuration.

    2. Click Test to verify you are sent to the right place and can login. If it is not working, you are logged out. Check your specification and retest the configuration until it is working properly.

    3. Click Close. The SSO Config card reflects the configuration.

    1. To require users to log in to NetQ using this SSO configuration, click change under the current Disabled status.

    2. Enter your administrator password.

    3. Click Submit to enable the configuration. The SSO card reflects this new status.

    1. Enter your administrator password.

    2. Enter a unique name for the SSO configuration.

    3. Copy the URL for the authorization server login page into the Login URL field.

    4. Copy the name of the authorization server into the Identity Provider Identifier field.

    5. Copy the name of the application server into the Service Provider Identifier field.

    6. Optionally, copy a claim into the Email Claim Key field. When left blank, the user email address is captured.

      This example shows a Google Cloud integration.

    1. Click Add.
    1. As indicated, copy the redirect URL https://api.netq.cumulusnetworks.com/netq/auth/v1/sso-callback into your identity provider configuration.

    2. Click Test to verify you are sent to the right place and can login. If it is not working, you are logged out. Check your specification and retest the configuration until it is working properly.

    3. Click Close. The SSO Config card reflects the configuration.

    1. To require users to log in to NetQ using this SSO configuration, click change under the current Disabled status.

    2. Enter your administrator password.

    3. Click Submit to enable the configuration. The SSO card reflects this new status.

Modify Integrations

You can change the specifications for SSO integration with your authentication server at any time, including changing to an alternate SSO type, disabling the existing configuration, or reconfiguring the current configuration.

Change SSO Type

To choose a different SSO type:

  1. Click Main Menu.

  2. Select Management from the Admin column.

  3. Locate the SSO Config card.

  4. Click Disable.

  5. Click Yes.

  6. Click Manage.

  7. Select the desired SSO type and complete the form with the relevant data for that SSO type.

  8. copy the redirect URL on the success dialog into your identity provider configuration.

  9. Click Test to verify proper login operation. Modify your specification and retest the configuration until it is working properly.

  10. Click Update.

Disable SSO Configuration

To disable the existing SSO configuration:

  1. Click Main Menu.

  2. Select Management from the Admin column.

  3. Locate the SSO Config card.

  4. Click Disable.

  5. Click Yes to disable the configuration, or Cancel to keep it enabled.

Edit the SSO Configuration

To edit the existing SSO configuration:

  1. Click Main Menu.

  2. Select Management from the Admin column.

  3. Locate the SSO Config card.

  4. Modify any of the fields as needed.

  5. Click Test to verify proper login operation. Modify your specification and retest the configuration until it is working properly.

  6. Click Update.