NetQ Management
As an administrator, you can manage access to and various application-wide settings for the NetQ GUI as well as view information about the system server, all from a single workbench.
Individual users have the ability to set preferences specific to their workspaces. This information is covered separately. Refer to User Account Information .
Contents
NetQ Management Workbench
The NetQ Management workbench is accessed from the main menu and from the header of an open workbench. For the user or users responsible for maintaining the application, this is a good place to start each day.
To open the workbench, click
, and select NetQ Management.
Manage Access Roles
From the NetQ Management workbench, you can view the number of access roles available in the system. With this release of the software, only one access role is available—Admin. You can view the details of this role by clicking Manage from the Access Roles card. In a future release you will be able to modify the Admin role and add and modify additional roles.
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 Account card.
Add New User Account
For each user that monitors at least one aspect of your data center network, a user account is needed.
To add a new user account:
-
Click Manage on the User Account card.
-
Click the User Accounts tab.
-
Click Add User.
-
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.
-
Skip the role assignment, since only the Admin role is available and is automatically assigned.
-
Create a password for the user.
-
Enter ( your ?) admin password.
-
Enter a password for the user. ( any password policies that must be followed here ?)
-
Re-enter the user password.
-
-
Click Save to create the user account, or Cancel to discard the user account.
Edit a Single User Account
Once you have user accounts created, you will inevitably need to change them in some way. You can modify their name or password from the User Account card.
You cannot edit their email address or access role. If you need to change an email address, you must delete the account and create a new one for this user.
To edit a user account:
-
Click Manage on the User Account card.
-
Click the User Accounts tab.
-
Hover over the User ID (email address) for the account you want to change, and click
when it appears to the right of the ID.
<insert modal> -
Modify the first and/or last name as needed.
-
If you do not want to update the password, click Save to commit the changes or Cancel to discard them.
-
If you do want to change the password for this user, click Reset Password.
-
Enter ( your ?) admin password.
-
Enter a password for the user. ( any password policies that must be followed here ?)
-
Re-enter the user password.
-
Click Save to commit the change, or Cancel to discard the change.
Change a User's Password
If you only want to change a password on a particular user account (no other edits), you can do this directly from the listing of user accounts rather than going through the full edit procedure.
To change a password:
-
Click Manage on the User Account card.
-
Click the User Accounts tab.
-
Click Reset in the Password column.
-
Enter ( your ?) admin password.
-
Enter a password for the user. ( any password policies that must be followed here ?)
-
Re-enter the user password.
-
Click Save to commit the change, or Cancel to discard the change.
Suspend Access for Selected Users
When you want to remove access from a user without removing their entire account, you can suspend their access.
To suspend access:
-
Click Manage on the User Account card.
-
Click the User Accounts tab.
-
Click to the left of each account you want to temporarily remove access. A check box appears next to each one and a menu appears at the bottom of the screen.
-
Click
in the menu.
-
Confirm that you want to suspend all of these accounts by clicking Yes.
Delete a Single User Account
When someone no longer needs access to the NetQ GUI, you can remove their account.
To remove a user account:
-
Click Manage on the User Account card.
-
Click the User Accounts tab.
-
Hover over the User ID (email address) for the account you want to change, and click
when it appears to the right of the ID.
-
Confirm that you want to completely remove this account by clicking Yes.
If currently logged in to the application, this user is immediately forced out of the application.
Delete Multiple User Accounts
To save time, if you need to remove more than one user account, you can do so all at once.
To remove multiple user accounts:
-
Click Manage on the User Account card.
-
Click the User Accounts tab.
-
Click to the left of each account you want to remove. A check box appears next to each one and a menu appears at the bottom of the screen.
-
Click
in the menu.
-
Confirm that you want to completely remove all of these accounts by clicking Yes.
For any users currently logged into the application, they are immediately forced out of the application.
Manage Workbenches
From the NetQ Management workbench, you can view the total number of workbenches in the system. As an administrator, you can also add, modify, copy, and remove workbenches in the application.Caution is recommended when removing workbenches not owned by you.
Add a Workbench
You can add a workbench for yourself or every user at any time using the Workbenches card. A workbench used by multiple users should contain cards with data that is targeted for those users. A workbench used by you alone can contain whatever cards you like. You may choose to create a workbench to monitor a particular problem until it is resolved and then remove it once the problem is resolved. It is entirely up to you.
To add a workbench:
-
Click Manage on the Workbenches card.
-
Click the Workbenches tab.
-
Click Add Workbench.
<insert model> -
Enter a name for the workbench.
-
Select the privacy level desired: Public (everyone can view) or Private (only you can view).
-
Enter yourself as the owner if the workbench is for you or if you are creating a general workbench for everyone to use. If you are creating the workbench for someone in particular to use, enter their name as the owner so they can xxxx. (or is this auto-filled with the user adding the workbench?)
-
Click Save to add the workbench to the application, or Cancel to discard the workbench.
Edit a Single Workbench
You can modify the privacy level, owner, and/or the cards to include on a given workbench. Changes take effect immediately. If changes are made to a public workbench, the next time a user adds or views the workbench, they will see the updates.
To modify a single workbench:
-
Click Manage on the Workbenches card.
-
Click the Workbenches tab.
-
Hover over the Workbench Name that you want to change, and click
when it appears to the right of the name.
<insert modal> -
Change the privacy setting, if desired, by clicking Public or Private.
-
Change the workbench owner by selecting a new owner from the dropdown list.
-
Review the cards on the workbench.
You can sort the cards alphabetically by name or size to more easily find a particular card. Do this by hovering over the table header and clicking. Click again to toggle the sort order between A-Z and Z-A.
-
Remove cards by clicking to the left of the card name; an X appears indicating it will be removed when you save your changes.
-
Change the default size of a card to display by clicking
in the Default Size column for the card you want to change, and selecting a different size (small, medium, or large). ( can you choose full screen? )
-
Can you add cards from here? (doesn't look like it)
-
Click Save to commit the changes, or Cancel to discard them.
Edit Multiple Workbenches
The only option available for editing multiple workbenches at once is the privacy setting.
To edit multiple workbenches:
-
Click Manage on the Workbenches card.
-
Click the Workbenches tab.
-
Click to the left of each workbench name you want to edit. A check box appears next to each one and a menu appears at the bottom of the screen.
-
Click
in the menu.
-
Click Public or Private to apply this privacy setting to all of the selected workbenches.
-
Click Save to commit the changes, or Cancel to discard them.
Clone a Workbench
You might have an occasion where, rather than creating a new workbench or editing an existing one that would need multiple edits, it would be easier to make a copy of an existing workbench that is very close to what you need and make only the minor edits needed. In this case, cloning a workbench is the fastest method for creating the new workbench you want.
To clone a workbench:
-
Click Manage on the Workbenches card.
-
Click the Workbenches tab.
-
Click to the left of the workbench you want to clone. A check box appears next to your selection and a menu appears at the bottom of the screen.
-
Click
in the menu. A confirmation message is shown in the upper right corner of the screen.
-
The cloned workbench appears at the top of the list as <original workbench name> clone. You can now edit the workbench to give it a new name and make any other changes you need. Refer to Edit a Single Workbench.
Delete One or More Workbenches
At some point, you may no longer use or need one or more workbenches, and to save space on your system, you can remove these workbenches.
When you delete a workbench, it is removed from the system. It is no longer available to any user.
To remove a single workbench:
-
Click Manage on the Workbenches card.
-
Click the Workbenches tab.
-
Hover over the Workbench Name that you want to remove, and click
when it appears to the right of the name.
-
Confirm that you want to remove this workbench by clicking Yes, or click Cancel to keep it.
To remove multiple workbenches:
-
Click Manage on the Workbenches card.
-
Click the Workbenches tab.
-
Click to the left of each workbench you want to remove. A check box appears next to each one and a menu appears at the bottom of the screen.
-
Click
in the menu.
-
Confirm that you want to remove all of these workbenches by clicking Yes, or click Cancel to keep them.
Scheduled Traces Management
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. ( Add note about limit of these if there is one .)
To add a trace:
-
Click Manage on the Scheduled Traces card.
-
Click the Scheduled Traces tab.
-
Click Add Trace to open the large Scheduled Trace Request card. ( assuming large card here versus medium, yes? )
-
Enter a name for the trace in the Select Trace field.
-
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.
-
Optionally specify a VLAN for a layer 2 trace or a VRF for a layer 3 trace.
-
Set the schedule for the trace, by selecting how often to run the trace and when to start it the first time.
-
Click Save As New to add the trace. ( does the request card stay on the workbench or "go away" once you're done configuring it? )
If you want to run the new trace right away for a baseline, open the small Trace Request card. Select the trace you just added, and click GO.
Edit a Scheduled Trace
You can modify a scheduled trace if you decide you want to increase or decrease the frequency that it is run, or you want to add a VLAN or VRF to the request.
To edit a scheduled trace:
-
Click Manage on the Scheduled Traces card.
-
Click the Scheduled Traces tab.
-
(Hover over source and click pencil or click next to trace and click pencil in trouser?) ( assuming this opens the large card here versus medium, yes? )
-
Modify the schedule or a VLAN or VRF specification.
-
Click Update to apply the changes to the existing trace. Note that prior results will vary from runs after this point in time.
Run One or More Scheduled Traces On Demand
At some point you may want to run one or more scheduled traces before they are next scheduled to run.
To run a trace on demand:
-
Click Manage on the Scheduled Traces card.
-
Click the Scheduled Traces tab.
-
Click next to one or more traces. A check box appears next to your selections, and a menu appears at the bottom of the screen.
-
Click
to run the selected traces now. A scheduled trace results card is opened on the workbench for each trace.
Delete One or More Scheduled Traces
At some point, you may no longer use or need one or more scheduled traces, and to save space on your system, you can remove these traces.
When you delete a trace, it is removed from the system. It is no longer available to any user.
To remove a single trace:
-
Click Manage on the Scheduled Traces card.
-
Click the Scheduled Traces tab.
-
Hover over the Source of the trace you want to remove, and click
when it appears to the right of the source.
-
Confirm that you want to remove this trace by clicking Yes, or click Cancel to keep it.
To remove multiple workbenches:
-
Click Manage on the Scheduled Traces card.
-
Click the Scheduled Traces tab.
-
Click to the left of each trace you want to remove. A check box appears next to each one and a menu appears at the bottom of the screen.
-
Click
in the menu.
-
Confirm that you want to remove all of these traces by clicking Yes, or click Cancel to keep them.
Scheduled Validations Management
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 preconfigured with the NetQ GUI. As an administrator, you can view the results for one or more scheduled validations, add new scheduled validations, or modify existing validations by editing, cloning, or deleting them.
View Validation Results
You can view the results 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 results:
-
Click Manage on the Scheduled Validations card.
-
Click the Scheduled Validations tab.
-
Click to the left of one or more validations. A checkmark appears confirming your selection, and a menu opens at the bottom of the screen.
-
Click
to open the validation results card for each selection.
-
Click
next to the NetQ Management card title to return to your workbench and view the cards.
Add a Scheduled Validation
You can add a scheduled validation at any time using the Scheduled Validations card. ( Add note about the maximum you can add )
To add a scheduled validation:
-
Click Manage on the Scheduled Validations card.
-
Click the Scheduled Validations tab.
-
Click Add Validation.
<insert model> -
Enter a name for the validation.
-
Select the validation types to include.
-
Set the schedule.
-
Click Save to add the validation, or Cancel to discard it.
Edit a Scheduled Validation
If you find you are missing information you want or need in a validation or you are seeing information you no longer want, you can edit the validation request using the Scheduled Validations card.
To edit a validation:
-
Click Manage on the Scheduled Validations card.
-
Click the Scheduled Validations tab.
-
Hover over the Validation Name, and click
.
-
Modify the name, validation types to include, and the schedule as needed. ( If name change is allowed, add note about changing name and impact to results tracking )
-
Click Save to confirm your changes, or click Cancel to discard them.
Edit Multiple Scheduled Validations
You can modify the validation types and schedules of more than one validation at a time, as long as you want them to all have the same validation types and schedule.
To edit multiple validations:
-
Click Manage on the Scheduled Validations card.
-
Click the Scheduled Validations tab.
-
Click next to the name of each validation you want to edit.
-
Modify the validation types to include and/or the schedule as needed.
-
Click Save to confirm your changes, or click Cancel to discard them.
Clone a Scheduled Validation
You might have an occasion where, rather than creating a new validation or editing an existing one that would need multiple edits, it would be easier to make a copy of an existing validation that is very close to what you need and make only the minor edits needed. In this case, cloning a validation is the fastest method for creating the new validation you want.
To clone a validation:
-
Click Manage on the Scheduled Validations card.
-
Click the Scheduled Validations tab.
-
Click next to the name the validation you want to clone. A check box appears next to your selection and a menu appears at the bottom of the screen.
-
Click
in the menu. A confirmation message is shown in the upper right corner of the screen.
-
The cloned validation appears at the top of the list as <original validation name> clone. You can now edit the validation to give it a new name and make any other changes you need. Refer to Edit a Scheduled Validation.
Delete One or More Scheduled Validations
If you are no longer interested in the results for a particular validation or you want to make room for a different validation, you can remove a validation using the Scheduled Validations card. When you delete a validation, it is removed from the system. It is no longer available to any users.
To remove a single validation:
-
Click Manage on the Scheduled Validations card.
-
Click the Scheduled Validations tab.
-
Hover over the validation name and click
when it appears to the right of the name.
-
Confirm that you want to remove this validation by clicking Yes, or click Cancel to keep it.
To remove multiple validations:
-
Click Manage on the Scheduled Validations card.
-
Click the Scheduled Validations tab.
-
Click next to the names of the validations you want to remove. Check boxes appear next to your selections and a menu appears at the bottom.
-
Click
in the menu.
-
Confirm that you want to remove all of these validations by clicking Yes, or click Cancel to keep them.
Notification Management
From the NetQ Management workbench, you can view the state of integrations with third-party notification tools. If you want to receive event notification through Slack or PagerDuty, you must set up the integrations to these notification tools. At this time, only one channel per tool can be configured.
Integrate with Slack
To set up NetQ to send event notifications to a Slack channel, you must first have a channel available, then configure the integration in the NetQ GUI.
If you have not already created a channel on which to receive the NetQ event notifications, follow these instructions:
-
In Slack, click + next to Channels.
-
Enter a name for the channel, and click Create Channel.
-
Create an incoming WebHook.
-
Select Customize Slack from the Slack dropdown menu.
-
Click Workspaces in the top right corner, and select the workspace where the channel is located.
-
Click Add Applications, and select Incoming WebHooks.
-
Click Add Configuration and enter the name of the channel you created (where you want to post notifications).
-
Click Add Incoming WebHooks integration.
-
Save WebHook URL in a text file for use in the integration procedure.
-
Once you have a channel ready, configure the NetQ GUI:
-
Click Manage on the Notifications card.
-
Click the Notification tab.
-
Enter the URL for the Slack Webhook.
-
To receive all alarm events (those with critical severity), confirm that the Send all alarms to Slack toggle is set to the right.
-
To receive all info events (those with warning, informational, and debugging severity), confirm that the Send all info to Slack toggle is set to the right.
-
Confirm the Turn off all notifications toggle is set to the left.
-
Confirm settings by clicking Yes, or click Cancel discard the configuration.
Integrate with PagerDuty
To set up NetQ to send event notifications to PagerDuty:
-
Click Manage on the Notifications card.
-
Click the Notification tab.
-
Enter the access key (also called an authorization token).
-
Enter the integration key (also called the service_key or routing_key; the default integration key is an empty string ("")).
-
To receive all alarm events (those with critical severity), confirm that the Send all alarms to PagerDuty toggle is set to the right.
-
To receive all info events (those with warning, informational, and debugging severity), confirm that the Send all info to PagerDuty toggle is set to the right.
-
Confirm the Turn off all notifications toggle is set to the left.
-
Confirm settings by clicking Yes, or click Cancel discard the configuration.
Topology Management
From the NetQ Management workbench, you can view the number of nodes and tiers in your topology. When you view your network using the topology view, each node has an associated tier that indicates what how many hops the node is away from the host. For example, in a three tier Clos topology, hosts would be at tier 0, switches that connect with the hosts, commonly called leafs, are 1 hop away from the hosts, so they would be part of tier 1, and switches that aggregate the leafs, commonly called spines, would then be at tier 2, one above the leafs.
It is usually highly visible in the topology view if a node has been assigned an incorrect tier. You can modify the node's tier using the Topology card.
View Current Tier Assignment
Tiers are assigned automatically by the system when xxx (on discovery? import?). You can view the tier assigned to each node using the Topology card.
To view the current tier assignment, cl ick Manage on the Topology card, and then click the Node Tier Assignment tab to show a grid view of the hostname of the node, tier assignment, and whether the tier has been assigned by the system (Auto) or modified by an administrator (Manual).
Edit Node Tier Assignments
It is usually highly visible in the topology view if a node has been assigned an incorrect tier. You can modify the node's tier using the Topology card.
To modify the assigned tier for a single node:
-
Click Manage on the Topology card.
-
Click the Node Tier Assignment tab.
-
Hover over the hostname of the node you want to edit, and click
when it appears to the right of the hostname.
-
Select the desired tier from the dropdown list/Enter the number for the tier. (no wire)
-
Click Save to confirm your change, or Cancel to discard it.
To modify the assigned tier for multiple nodes:
-
Click Manage on the Topology card.
-
Click the Node Tier Assignment tab.
-
Click next to each node you want to edit. A check box appears to confirm your selection, and a menu appears at the bottom of the screen.
-
Click
on the menu.
-
Select the desired tier for all of the selected nodes./Enter the number of the tier to apply to all of the selected nodes.
-
Click Save to confirm your change, or Cancel to discard it.
Revert Node Tier to System Assigned Tier
If one or more node assignments have been edited and saved, but were assigned incorrectly, you can revert their tier assignments back to the original system assigned tier.
To revert the current tier for a single node:
-
Click Manage on the Topology card.
-
Click the Node Tier Assignment tab.
-
Hover over the hostname of the node you want to edit, and click
when it appears to the right of the hostname.
-
Click Save to confirm your change, or Cancel to discard it.
To modify the assigned tier for multiple nodes:
-
Click Manage on the Topology card.
-
Click the Node Tier Assignment tab.
-
Click next to each node you want to edit. A check box appears to confirm your selection, and a menu appears at the bottom of the screen.
-
Click
on the menu.
-
Click Save to confirm your change, or Cancel to discard it.
Create an Alias for a Node Tier (is this part of 2.0?)
If you prefer something other than numbers for your tier identification, you can provide an alternate name for each tier using the Topology card.
To create an alias:
-
Click Manage on the Topology card.
-
Click the Node Tier Assignment tab.
-
???
View System Server Information
You can view basic information about the NetQ server from the NetQ Management workbench. To view the server information, open the workbench and scroll until you find the System Server Information card. The card includes the following (when available):
Item |
Description |
Examples |
UI Version |
NetQ GUI version |
2.0.0 |
IP Address |
IP address of the NetQ server ( what about MAC addr? ) |
192.168.13 |
Hostname |
User-defined name for the NetQ server |
leaf01, TOR4, Pinehurst |
Memory |
Amount of memory installed on the NetQ server |
16GB, |
CPU |
Vendor and name of CPU installed on the NetQ server |
Intel x86_64, ARM |
Model |
Vendor and name of platform and model |
Dell S3252F-ON, Mellanox SN2700, Lenovo NE10032O |
NIC |
Network interface card vendor and ASIC |
Broadcom Trident3, Mellanox Spectrum |
HD Size |
Size of the installed hard drive/SSD |
64 GB, |
Uptime |
Amount of time the server has been powered up |
362:23:26:31 (days:hours:minutes:seconds) |
Base OS |
Operating System running on the server ( version also? ) |
Cumulus Linux, Ubuntu, RHEL, CentOS |