This documentation is for an older version of the software. If you are using the current version of Cumulus Linux, this content 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.

NetQ Service Console

The NetQ Telemetry Server provides access to the NetQ Service Console, a graphical user interface (GUI) for NetQ. The service console in turn provides terminal access to any node in the fabric.

The Cumulus NetQ Service Console utilizes elements of Portainer. You can read the Portainer license file here.

Connecting to the Service Console

To connect to the service console, open a browser, and go to the IP address of the telemetry server. You are prompted to log in with the username and password for the service console. The default account is the admin user, and its default password is CumulusNetQ!.

/images/download/attachments/6488214/netq-service-console-main.png

Configuring Users

By default, the service console is configured with an administrator account named admin, but you can add more users as needed. To add a new user:

  1. In the Service Console, click Users.

    /images/download/attachments/6488214/netq-service-console-users.png
  2. Enter the username in the Username field.

  3. Enter that user’s password in the Password and Confirm Password fields.

  4. If this user account is to be an administrator to the service console, enable the Administrator toggle.

  5. Click Add user to create the account.

Other User Account Actions

You can edit a user’s role. On the Users tab, select the account under Users, then click Edit.

You can delete a user account. On the Users tab, select the account under Users, then click Remove. You cannot delete the last remaining administrator account.

To change an account password, click the Password tab.

Accessing the NetQ Command Line

The service console provides access to a standard Bash shell, so you can run NetQ commands - or any Linux command - directly on a given node.

The console is connected to the NetQ CLI container within the telemetry server; it is not connected to the shell of the telemetry server itself. As such, the netq-shell command does not work in the console; it is intended to run regular NetQ commands.

/images/download/attachments/6488214/netq-service-console-services.png

In the Services window of the console, click Launch console, then click Connect.

/images/download/attachments/6488214/netq-service-console-terminal.png

You can run any NetQ commands within the console, such as netq show agents:

/images/download/attachments/6488214/netq-console-show-agents.png

When you’re finished with the session, click Disconnect to close the console.