Install and Configure the NetQ Agent and CLI on Ubuntu Servers
After installing or upgrading your Cumulus NetQ software, you should install the corresponding version of the NetQ Agents on each node you want to monitor. The node can be a:
- Server running Ubuntu 16.04
- Server running Ubuntu 18.04 (NetQ 2.2.2 and later)
This topic describes how to perform the installation and configuration. If you are upgrading, you can skip some of the steps which do not need to be performed a second time.
Install a NetQ Agent
To install the NetQ Agent you need to install the OS-specific meta
cumulus-netq, on each switch. Optionally, you can install it
on hosts. The meta package contains the NetQ Agent and NetQ applications.
If your network uses a proxy server for external connections, you should
first configure a global proxy
apt-get can access the meta package on the Cumulus Networks repository.
Install NetQ Agent on an Ubuntu Server
Before you install the NetQ Agent on an Ubuntu server, make sure the following packages are installed and running these minimum versions:
- iproute 1:4.3.0-1ubuntu3.16.04.1 all
- iproute2 4.3.0-1ubuntu3 amd64
- lldpd 0.7.19-1 amd64
ntp 1:4.2.8p4+dfsg-3ubuntu5.6 amd64
Make sure you are running lldpd, not lldpad. Ubuntu does not include
lldpdby default, which is required for the installation.
To install this package, run the following commands:
root@ubuntu:~# apt-get update root@ubuntu:~# apt-get install lldpd root@ubuntu:~# systemctl enable lldpd.service root@ubuntu:~# systemctl start lldpd.service
To install the NetQ Agent on an Ubuntu server:
Reference and update the local
root@ubuntu:~# wget -O- https://apps3.cumulusnetworks.com/setup/cumulus-apps-deb.pubkey | apt-key add -
Add the Ubuntu repository:
Ubuntu 16.04Create the file
/etc/apt/sources.list.d/cumulus-host-ubuntu-xenial.listand add the following line:
root@ubuntu:~# vi /etc/apt/sources.list.d/cumulus-apps-deb-xenial.list ... deb [arch=amd64] https://apps3.cumulusnetworks.com/repos/deb xenial netq-latest ...
Ubuntu 18.04Create the file
/etc/apt/sources.list.d/cumulus-host-ubuntu-bionic.listand add the following line:
root@ubuntu:~# vi /etc/apt/sources.list.d/cumulus-apps-deb-bionic.list ... deb [arch=amd64] https://apps3.cumulusnetworks.com/repos/deb bionic netq-latest ...
The use of
netq-latestin this example means that a
getto the repository always retrieves the latest version of NetQ, even in the case where a major version update has been made. If you want to keep the repository on a specific version - such as
netq-2.2- use that instead.
Install NTP on the server, if not already installed.
root@ubuntu:~# sudo apt-get install ntp
Configure the NTP server.
/etc/ntp.conffile in your text editor of choice.
Under the Server section, specify the NTP server IP address or hostname.
Enable and start the NTP service.
root@ubuntu:~# sudo systemctl enable ntp.service root@ubuntu:~# sudo systemctl start ntp.service
Verify NTP is operating correctly. Look for an asterisk (*) or a plus sign (+) that indicates the clock is synchronized.
root@ubuntu:~# ntpq -pn remote refid st t when poll reach delay offset jitter ============================================================================== +188.8.131.52 184.108.40.206 2 u 86 128 377 41.354 2.834 0.602 +220.127.116.11 18.104.22.168 3 u 103 128 377 13.395 -4.025 0.198 2a00:7600::41 .STEP. 16 u - 1024 0 0.000 0.000 0.000 \*22.214.171.124 249.224.99.213 2 u 101 128 377 14.588 -0.299 0.243
Install the meta package on the server.
root@ubuntu:~# apt-get update root@ubuntu:~# apt-get install cumulus-netq
Continue with NetQ Agent Configuration
Configure Your NetQ Agents
Once the NetQ Agents have been installed on the network nodes you want to monitor, the NetQ Agents must be configured to obtain useful and relevant data. Two methods are available for configuring a NetQ Agent:
- Edit the configuration file on the device, or
- Configure and run NetQ CLI commands on the device.
Configure NetQ Agents Using a Configuration File
You can configure the NetQ Agent in the
netq.yml configuration file contained in the
- Open the
netq.ymlfile using your text editor of choice.
- Locate the netq-agent section, or add it.
- Set the parameters for the agent as follows:
- port: 31980 (default configuration)
- server: IP address of the NetQ server or appliance where the agent should send its collected data
- vrf: default (default configuration)
Your configuration should be similar to this:
netq-agent: port: 31980 server: 127.0.0.1 vrf: default
Configure NetQ Agents Using the NetQ CLI
The NetQ CLI was installed when you installed the NetQ Agent; however, to use it to configure your NetQ Agents, you must first configure the CLI to communicate with your NetQ server or appliance.
Configure the NetQ CLI
Note that the steps to install the CLI are different depending on whether the NetQ software has been installed for an on-premises or cloud deployment.
Configuring the CLI for on-premises deployments requires only two commands:
netq config add cli server <ip-address-of-netq-server-or-appliance> netq config restart cli
Configuring the CLI for cloud deployments also only requires two commands; however, there are a couple of additional options that you can apply:
- In NetQ 2.2.2 and later, if your nodes do not have Internet access, you can use the CLI proxy that is available on the NetQ cloud server or NetQ Cloud Appliance.
- In NetQ 2.2.1 and later, you can:
- save your access credentials in a file and reference that file here to simplify the configuration commands
- specify which premises you want to query
For switches with Internet access run the following commands, being sure to replace the key values with your generated keys.
$ netq config add cli server api.netq.cumulusnetworks.com access-key <text-access-key> secret-key <text-secret-key> port 443 Successfully logged into NetQ cloud at api.netq.cumulusnetworks.com:443 Updated cli server api.netq.cumulusnetworks.com vrf default port 443. Please restart netqd (netq config restart cli) $ netq config restart cli Restarting NetQ CLI... Success!
Or, if you have created a keys file as noted in the installation procedures for the NetQ Cloud server or Appliance, run the following commands. Be sure to include the full path the to file.
$ netq config add cli server api.netq.cumulusnetworks.com cli-keys-file /<full-path>/credentials.yml port 443 Successfully logged into NetQ cloud at api.netq.cumulusnetworks.com:443 Updated cli server api.netq.cumulusnetworks.com vrf default port 443. Please restart netqd (netq config restart cli) $ netq config restart cli Restarting NetQ CLI... Success!
If you have multiple premises, be sure to include which premises you want to query. Rerun this command to query a different premises.
$ netq config add cli server api.netq.cumulusnetworks.com access-key <text-access-key> secret-key <text-secret-key> premises <premises-name> port 443 Successfully logged into NetQ cloud at api.netq.cumulusnetworks.com:443 Updated cli server api.netq.cumulusnetworks.com vrf default port 443. Please restart netqd (netq config restart cli) $ netq config restart cli Restarting NetQ CLI... Success!
For switches without Internet access, you can use the CLI proxy that is part of the NetQ Cloud Server or Appliance with NetQ 2.2.2 and later to manage CLI access on your nodes. To make use of the proxy, you must point each switch or host to the NetQ Cloud Server or Appliance. Run the following commands, using the IP address of the proxy:
$ netq config add cli server <proxy-ip-addr> Updated cli server <proxy-ip-addr> vrf default port 443. Please restart netqd (netq config restart cli) $ netq config restart cli Restarting NetQ CLI... Success!
Configure the NetQ Agent
Now that the CLI is configured, you can use it to configure the NetQ Agent to send telemetry data to the NetQ Server or Appliance.
If you intend to use VRF, skip to Configure the Agent to Use VRF. If you intend to specify a port for communication, skip to Configure the Agent to Communicate over a Specific Port.
The same commands are used no matter the operating system (Cumulus Linux, Ubuntu, etc.). This example uses an IP address of 192.168.1.254 for the NetQ hardware.
$ netq config add agent server 192.168.1.254 Updated agent server 192.168.1.254 vrf default. Please restart netq-agent (netq config restart agent). $ netq config restart agent
Configure the Agent to Use a VRF
While optional, Cumulus strongly recommends that you configure NetQ Agents to communicate with the NetQ Platform only via a VRF, including a management VRF. To do so, you need to specify the VRF name when configuring the NetQ Agent. For example, if the management VRF is configured and you want the agent to communicate with the NetQ Platform over it, configure the agent like this:
cumulus@leaf01:~$ netq config add agent server 192.168.1.254 vrf mgmt cumulus@leaf01:~$ netq config restart agent
Configure the Agent to Communicate over a Specific Port
By default, NetQ uses port 31980 for communication between the NetQ Platform and NetQ Agents. If you want the NetQ Agent to communicate with the NetQ Platform via a different port, you need to specify the port number when configuring the NetQ Agent like this:
cumulus@leaf01:~$ netq config add agent server 192.168.1.254 port 7379 cumulus@leaf01:~$ netq config restart agent