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. You can use the same credentials that you use to access the telemetry server VM. The service console user accounts are managed in the telemetry server itself, just like any Linux user account.

/images/download/attachments/7111316/NetQ-1.1-service-console.png

Getting Service Console Information

The lower lefthand corner of the service console window displays information about

/images/download/thumbnails/7111316/NetQ-1.1-service-console-info.png
  • IP: The IP address of the telemetry server VM. In the default configuration, the IP field is empty. To have this field display the IP address, edit /etc/cts/redis/host.conf and set the HOST_IP variable to the telemetry server’s IP address, then restart the netq-gui service with sudo systemctl restart netq-gui.service.

  • Hostname: The hostname of the telemetry server VM. if you change the hostname and don’t restart the netq-gui service, the hostname won’t change in the service console.

  • Role: The role that the NetQ database is in, which currently can be master only, as there is only one Redis server, which is the primary.

  • Redis availability: Indicates whether or not the Redis database on the telemetry server VM is reachable.

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.

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

/images/download/attachments/7111316/NetQ-1.1-service-console---console.png

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

/images/download/attachments/7111316/NetQ-1.1-service-console---netq-show-agents.png

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