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.

Prepare Your Existing NetQ Appliances for a NetQ 3.1 Deployment

This topic describes how to prepare a NetQ 2.4.x or earlier NetQ Appliance before installing NetQ 3.1.x. The steps are the same for both the on-premises and cloud appliances. The only difference is the software you download for each platform. On completion of the steps included here, you will be ready to perform a fresh installation of NetQ 3.1.x.

The preparation workflow is summarized in this figure:

To prepare your appliance:

  1. Verify that your appliance is a supported hardware model.

  2. For on-premises solutions using the NetQ On-premises Appliance, optionally back up your NetQ data.

    1. Run the backup script to create a backup file in /opt/<backup-directory>.

      Be sure to replace the backup-directory option with the name of the directory you want to use for the backup file. This location must be somewhere that is off of the appliance to avoid it being overwritten during these preparation steps.

      cumulus@<hostname>:~$ ./backuprestore.sh --backup --localdir /opt/<backup-directory>
    2. Verify the backup file has been created.

      cumulus@<hostname>:~$ cd /opt/<backup-directory>
      cumulus@<hostname>:~/opt/<backup-directory># ls
  3. Install Ubuntu 18.04 LTS

    Follow the instructions here to install Ubuntu.

    Note these tips when installing:

    • Ignore the instructions for MAAS.

    • Ubuntu OS should be installed on the SSD disk. Select Micron SSD with ~900 GB at step#9 in the aforementioned instructions.

    • Set the default username to cumulus and password to cumulus.

    • When prompted, select Install SSH server.

  4. Configure networking.

    Ubuntu uses Netplan for network configuration. You can give your appliance an IP address using DHCP or a static address.

    • Create and/or edit the /etc/netplan/01-ethernet.yaml Netplan configuration file.

      # This file describes the network interfaces available on your system
      # For more information, see netplan(5).
          version: 2
          renderer: networkd
                  dhcp4: yes
    • Apply the settings.

      $ sudo netplan apply
    • Create and/or edit the  /etc/netplan/01-ethernet.yaml Netplan configuration file.

      In this example the interface, eno1, is given a static IP address of with a gateway at and DNS server at 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.

      $ sudo netplan apply
  5. Update the Ubuntu repository.

    1. Reference and update the local apt repository.

      root@ubuntu:~# wget -O- https://apps3.cumulusnetworks.com/setup/cumulus-apps-deb.pubkey | apt-key add -
    2. Add the Ubuntu 18.04 repository.

      Create the file /etc/apt/sources.list.d/cumulus-host-ubuntu-bionic.list and 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-latest in this example means that a get to 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.

  6. Install Python.

    Run the following commands:

    root@ubuntu:~# apt-get update
    root@ubuntu:~# apt-get install python python2.7 python-apt python3-lib2to3 python3-distutils
  7. Obtain the latest NetQ Agent and CLI package.

    Run the following commands:

    root@ubuntu:~# apt-get update
    root@ubuntu:~# apt-get install netq-agent netq-apps
  8. Download the bootstrap and NetQ installation tarballs.

    Download the software from the MyMellanox downloads page page.

    1. Select NetQ from the Product list.

    2. Select 3.1 from the Version list, and then select 3.1.0 from the submenu.

    3. Select Bootstrap from the Hypervisor/Platform list. Note that the bootstrap file is the same for both appliances.

    4. Scroll down and click Download.

    5. Select Appliance for the NetQ On-premises Appliance or Appliance (Cloud) for the NetQ Cloud Appliance from the Hypervisor/Platform list.

      Make sure you select the right install choice based on whether you are preparing the on-premises or cloud version of the appliance.

    6. Scroll down and click Download.

    7. Copy these two files, netq-bootstrap-3.1.0.tgz and either NetQ-3.1.0.tgz (on-premises) or NetQ-3.1.0-opta.tgz (cloud), to the /mnt/installables/ directory on the appliance.

    8. Verify that the needed files are present and of the correct release. This example shows on-premises files. The only difference for cloud files is that it should list NetQ-3.1.0-opta.tgz instead of NetQ-3.1.0.tgz.

      cumulus@<hostname>:~$ dpkg -l | grep netq
      ii  netq-agent   3.1.0-ub18.04u28~1594095612.8f00ba1_amd64   Cumulus NetQ Telemetry Agent for Ubuntu
      ii  netq-apps    3.1.0-ub18.04u28~1594095612.8f00ba1_amd64   Cumulus NetQ Fabric Validation Application for Ubuntu
      cumulus@<hostname>:~$ cd /mnt/installables/
      cumulus@<hostname>:/mnt/installables$ ls
      NetQ-3.1.0.tgz  netq-bootstrap-3.1.0.tgz
    9. Run the following commands.

      sudo systemctl disable apt-{daily,daily-upgrade}.{service,timer}
      sudo systemctl stop apt-{daily,daily-upgrade}.{service,timer}
      sudo systemctl disable motd-news.{service,timer}
      sudo systemctl stop motd-news.{service,timer}
  9. Run the Bootstrap CLI.

    Run the bootstrap CLI on your appliance. Be sure to replace the eth0 interface used in this example with the interface or IP address on the appliance used to listen for NetQ Agents.

If you are creating a server cluster, you need to prepare each of those appliances as well. Repeat these steps if you are using a previously deployed appliance or refer to Install NetQ System Platform for a new appliance.

You are now ready to install the NetQ Software. Refer to Install NetQ Using the Admin UI (recommended) or Install NetQ Using the CLI.