If you are using the current version of Cumulus NetQ, the content on this page 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.

Install the NetQ Appliance

This topic describes how to prepare your single, NetQ Appliance for installation of the NetQ software.

Inside the box that was shipped to you, you’ll find:

  • Your Cumulus NetQ Appliance (a Supermicro 6019P-WTR server)
  • Hardware accessories, such as power cables and rack mounting gear (note that network cables and optics ship separately)
  • Information regarding your order

For more detail about hardware specifications (including LED layouts and FRUs like the power supply or fans, and accessories like included cables) or safety and environmental information, refer to the user manual and quick reference guide.

Install the Appliance

After you unbox the appliance:
  1. Mount the appliance in the rack.
  2. Connect it to power following the procedures described in your appliance's user manual.
  3. Connect the Ethernet cable to the 1G management port (eno1).
  4. Power on the appliance.

If your network runs DHCP, you can configure NetQ over the network. If DHCP is not enabled, then you configure the appliance using the console cable provided.

Configure the Password, Hostname and IP Address

Change the password and specify the hostname and IP address for the appliance before installing the NetQ software.

  1. Log in to the appliance using the default login credentials:

    • Username: cumulus
    • Password: CumulusLinux!
  2. Change the password using the passwd command:

    cumulus@hostname:~$ passwd
    Changing password for cumulus.
    (current) UNIX password: CumulusLinux!
    Enter new UNIX password:
    Retype new UNIX password:
    passwd: password updated successfully
  3. The default hostname for the NetQ Appliance is netq-appliance. Change the hostname to fit your naming conventions using the following command:

    cumulus@hostname:~$ sudo hostnamectl set-hostname NEW_HOSTNAME
  4. Identify the IP address.

    The appliance contains two Ethernet ports. Port eno1, is dedicated for out-of-band management. This is where NetQ Agents should send the telemetry data collected from your monitored switches and hosts. By default, eno1 uses DHCPv4 to get its IP address. You can view the assigned IP address using the following command:

    cumulus@hostname:~$ ip -4 -brief addr show eno1
    eno1             UP   

    Alternately, you can configure the interface with a static IP address by editing the /etc/netplan/01-ethernet.yaml Ubuntu Netplan configuration file.

    For example, to set your network interface eno1 to a static IP address of with gateway and DNS server as and

    # This file describes the network interfaces available on your system
    # For more information, see netplan(5).
        version: 2
        renderer: networkd
                dhcp4: no
                addresses: []
                    addresses: [,]

    Apply the settings.

    cumulus@hostname:~$ sudo netplan apply

Verify NetQ Software and Appliance Readiness

Now that the appliance is up and running, verify that the software is available and the appliance is ready for installation.

  1. Verify that the needed packages are present and of the correct release, version 2.4.1 and update 26 or later.

    cumulus@hostname:~$ dpkg -l | grep netq
    ii  netq-agent   2.4.1-ub18.04u26~1581351889.c5ec3e5 amd64   Cumulus NetQ Telemetry Agent for Ubuntu
    ii  netq-apps    2.4.1-ub18.04u26~1581351889.c5ec3e5 amd64   Cumulus NetQ Fabric Validation Application for Ubuntu
  2. Verify the installation images are present and of the correct release, version 2.4.1.

    cumulus@hostname:~$ cd /mnt/installables/
    cumulus@hostname:/mnt/installables$ ls
    NetQ-2.4.1.tgz  netq-bootstrap-2.4.1.tgz
  3. Verify the appliance is ready for installation. Fix any errors indicated before installing the NetQ software.

    cumulus@hostname:~$ sudo opta-check
  4. Run the Bootstrap CLI. Be sure to replace the eno1 interface used in this example with the interface or IP address on the appliance used to listen for NetQ Agents.

    cumulus@:~$ netq bootstrap master interface eno1 tarball /mnt/installables/netq-bootstrap-2.4.1.tgz

    Allow about five to ten minutes for this to complete, and only then continue to the next step.

    If this step fails for any reason, you can run netq bootstrap reset [purge-db|keep-db] and then try again.

    If you have changed the IP address or hostname of the NetQ On-premises Appliance after this step, you need to re-register this address with NetQ as follows:

    Reset the appliance, indicating whether you want to purge any NetQ DB data or keep it.

    cumulus@hostname:~$ netq bootstrap reset [purge-db|keep-db]

    Re-run the Bootstrap CLI on the appliance. This example uses interface eno1. Replace this with your updated IP address, hostname or interface using the interface or ip-addr option.

    cumulus@:~$ netq bootstrap master interface eno1 tarball /mnt/installables/netq-bootstrap-2.4.1.tgz

The final step is to install and activate the Cumulus NetQ software. You can do this using the Admin UI or the CLI.

Click the installation and activation method you want to use to complete installation: