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 Cloud Appliance

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

Each system shipped to you contains:

  • Your NVIDIA NetQ Cloud Appliance (a Supermicro SuperServer E300-9D)
  • Hardware accessories, such as power cables and rack mounting gear (note that network cables and optics ship separately)
  • Information regarding your order

If you’re looking for hardware specifications (including LED layouts and FRUs like the power supply or fans and accessories like included cables) or safety and environmental information, check out the appliance’s user manual.

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

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

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

    cumulus@hostname:~$ passwd
    Changing password for cumulus.
    (current) UNIX password: cumulus
    Enter new UNIX password:
    Retype new UNIX password:
    passwd: password updated successfully
  3. The default hostname for the NetQ Cloud Appliance is netq-appliance. Change the hostname to fit your naming conventions while meeting Internet and Kubernetes naming standards.

    Kubernetes requires that hostnames comprise a sequence of labels concatenated with dots. For example, en.wikipedia.org is a hostname. Each label must be from 1 to 63 characters long. The entire hostname, including the delimiting dots, has a maximum of 253 ASCII characters.

    The Internet standards (RFCs) for protocols specify that labels can contain only the ASCII letters a through z (in lower case), the digits 0 through 9, and the hyphen-minus character ('-').

    Use the following command:

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

    The appliance contains two Ethernet ports. It uses port eno1 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 4.2.

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

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

    cumulus@hostname:~$ sudo opta-check-cloud

The final step is to install and activate the NetQ software using the CLI: