layout-3 layout-6 layout-1 layout-top
NVIDIA Docs Hubchevron_right NVIDIA Networkingchevron_right Networking Softwarechevron_right Management Softwarechevron_right

NVIDIA NetQ

layout-top layout-6 layout-1

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.

NetQ and Network OS Images

NetQ and network OS (Cumulus Linux and SONiC) images are managed with LCM. This section details how to check for missing images, upgrade images, and specify default images.

View and Upload Missing Images

You should upload images for each network OS and NetQ version currently installed in your inventory so you can support rolling back to a known good version should an installation or upgrade fail. If you have specified a default network OS and/or NetQ version, the NetQ UI also verifies that the necessary versions of the default image are available based on the known switch inventory, and if not, lists those that are missing.

To upload missing network OS images:

  1. Expand the Menu. Under Admin, select Manage Switches. Select the Image Management tab.

  2. On the Cumulus Linux Images card, select View # missing CL images to see which images you need.

cumulus linux images card with link to view missing images

If you have already specified a default image, you must click Manage and then Missing to see the missing images.

  1. Select one or more of the missing images and make note of the version, ASIC vendor, and CPU architecture for each.

  2. Download the network OS disk images (.bin files) from the NVIDIA Enterprise Support Portal. Log in to the portal and from the Downloads tab, select Switches and Gateways. Under Switch Software, click All downloads next to Cumulus Linux for Mellanox Switches. Select the current version and the target version, then click Show Downloads Path. Download the file.

  3. Back in the UI, select (Add Image) above the table.

dialog prompting the user to import the CL image

  1. Provide the .bin file from an external drive that matches the criteria for the selected image(s).

  2. Click Import.

If the upload was not successful, an Image Import Failed message appears. Close the dialog and try uploading the file again.

  1. Click Done.

  2. (Optional) Click Uploaded to verify the image is in the repository.

UI screen verifying that the image is in the repository

  1. Click close to return to the LCM dashboard.

    The Cumulus Linux Images card now reflects the number of images you uploaded.

  1. (Optional) Display a summary of Cumulus Linux images uploaded to the LCM repo on the NetQ appliance or VM:
netq lcm show cl-images

  1. Download the network OS disk images (.bin files) from the NVIDIA Enterprise Support Portal. Log into the portal and from the Downloads tab, select Switches and Gateways. Under Switch Software, click All downloads next to Cumulus Linux for Mellanox Switches. Select the current version and the target version, then click Show Downloads Path. Download the file.

  2. Upload the images to the LCM repository. The following example uses a Cumulus Linux 4.2.0 disk image.

    cumulus@switch:~$ netq lcm add cl-image /path/to/download/cumulus-linux-4.2.0-mlnx-amd64.bin

  3. Repeat step 2 for each image you need to upload to the LCM repository.

To upload missing NetQ images:

  1. Expand the Menu. Under Admin, select Manage Switches. Select the Image Management tab.

  2. On the NetQ Images card, select View # missing NetQ images to see which images you need.

netq images card with link to view missing images

If you have already specified a default image, you must click Manage and then Missing to see the missing images.

  1. Select one or all of the missing images and make note of the OS version, CPU architecture, and image type. Remember that you need both netq-apps and netq-agent for NetQ to perform the installation or upgrade.

  2. Download the NetQ Debian packages needed for upgrade from the NetQ repository, selecting the appropriate OS version and architecture. Place the files in an accessible part of your local network.

  3. Back in the UI, click (Add Image) above the table.

dialog prompting the user to import the NetQ images

  1. Provide the .deb file(s) from an external drive that matches the criteria for the selected image.

  2. Click Import.

If the upload was not successful, an Image Import Failed message appears. Close the Import Image dialog and try uploading the file again.

  1. Click Done.

  2. (Optional) Click Uploaded to verify the images are in the repository.

  3. Click to return to the LCM dashboard.

The NetQ Images card now shows the number of images you uploaded.

  1. (Optional) Display a summary of NetQ images uploaded to the LCM repo on the NetQ appliance or VM:
netq lcm show netq-images

  1. Download the NetQ Debian packages needed for upgrade from the NetQ repository, selecting the appropriate version and hypervisor/platform. Place them in an accessible part of your local network.

  2. Upload the images to the LCM repository. This example uploads the two packages (netq-agent and netq-apps) needed for NetQ version 4.0.0 for a NetQ appliance or VM running Ubuntu 18.04 with an x86 architecture.

    cumulus@switch:~$ netq lcm add netq-image /path/to/download/netq-agent_4.0.0-ub18.04u33~1614767175.886b337_amd64.deb
cumulus@switch:~$ netq lcm add netq-image /path/to/download/netq-apps_4.0.0-ub18.04u33~1614767175.886b337_amd64.deb

Upload Upgrade Images

To upload the network OS or NetQ images that you want to use for upgrade, first download the Cumulus Linux or SONiC disk images (.bin files) and NetQ Debian packages needed for upgrade from the NVIDIA Enterprise Support Portal and NetQ repository, respectively. Place them in an accessible part of your local network.

If you are upgrading the network OS on switches with different ASIC vendors or CPU architectures, you need more than one image. For NetQ, you need both the netq-apps and netq-agent packages for each variant.

After obtaining the images, upload them to NetQ with the UI or CLI:

  1. Click Image Management.

  2. Click Add Image on the Cumulus Linux Images or NetQ Images card.

  3. Provide one or more images from an external drive.

  4. Click Import.

  5. Monitor the progress until it completes. Click Done.

  6. Click to return to the LCM dashboard.

Use the netq lcm add cl-image <text-image-path> and netq lcm add netq-image <text-image-path> commands to upload the images. Run the relevant command for each image that needs to be uploaded.

Network OS images:

cumulus@switch:~$ netq lcm add image /path/to/download/cumulus-linux-4.2.0-mlx-amd64.bin

NetQ images:

cumulus@switch:~$ netq lcm add image /path/to/download/	netq-agent_4.0.0-ub18.04u33~1614767175.886b337_amd64.deb
cumulus@switch:~$ netq lcm add image /path/to/download/netq-apps_4.0.0-ub18.04u33~1614767175.886b337_amd64.deb

Specify a Default Upgrade Version

Specifying a default upgrade version is optional, but recommended. You can assign a specific OS or NetQ version as the default version to use when installing or upgrading switches. The default is typically the newest version that you intend to install or upgrade on all, or the majority, of your switches. If necessary, you can override the default selection during the installation or upgrade process if an alternate version is needed for a given set of switches.

To specify a default version in the NetQ UI:

  1. Click Image Management.

  2. Select the link in the relevant card.

    card highlighting link to set default CL version card highlighting link to set default NetQ version

  3. Select the version you want to use as the default for switch upgrades.

  4. Click Save. The default version is now displayed on the relevant Images card.

To specify a default network OS version, run:

cumulus@switch:~$ netq lcm add default-version cl-images <text-cumulus-linux-version>

To specify a default NetQ version, run:

cumulus@switch:~$ netq lcm add default-version netq-images <text-netq-version>

In the CLI, you can check which version of the network OS or NetQ is the default.

  • For Cumulus Linux, run netq lcm show default-version cl-images

  • For NetQ, run netq lcm show default-version netq-images

Remove Images from Local Repository

After you upgrade all your switches beyond a particular release, you can remove images from the LCM repository to save space on the server. To remove images:

  1. Expand the Menu. Under Admin, select Manage Switches. Select the Image Management tab.

  2. Click Manage on the Cumulus Linux Images or NetQ Images card.

  3. On the Uploaded tab, select the images you want to remove.

  4. Click .

To remove Cumulus Linux images, run:

netq lcm show cl-images [json]
netq lcm del cl-image <text-image-id>

  1. Determine the ID of the image you want to remove.

    cumulus@switch:~$ netq lcm show cl-images json
[
    {
        "id": "image_cc97be3955042ca41857c4d0fe95296bcea3e372b437a535a4ad23ca300d52c3",
        "name": "cumulus-linux-4.2.0-vx-amd64-1594775435.dirtyzc24426ca.bin",
        "clVersion": "4.2.0",
        "cpu": "x86_64",
        "asic": "VX",
        "lastChanged": 1600726385400.0
    },
    {
        "id": "image_c6e812f0081fb03b9b8625a3c0af14eb82c35d79997db4627c54c76c973ce1ce",
        "name": "cumulus-linux-4.1.0-vx-amd64.bin",
        "clVersion": "4.1.0",
        "cpu": "x86_64",
        "asic": "VX",
        "lastChanged": 1600717860685.0
    }
]

  2. Remove the image you no longer need.

    cumulus@switch:~$ netq lcm del cl-image image_c6e812f0081fb03b9b8625a3c0af14eb82c35d79997db4627c54c76c973ce1ce

  3. Verify the command removed the image.

    cumulus@switch:~$ netq lcm show cl-images json
[
    {
        "id": "image_cc97be3955042ca41857c4d0fe95296bcea3e372b437a535a4ad23ca300d52c3",
        "name": "cumulus-linux-4.2.0-vx-amd64-1594775435.dirtyzc24426ca.bin",
        "clVersion": "4.2.0",
        "cpu": "x86_64",
        "asic": "VX",
        "lastChanged": 1600726385400.0
    }
]

To remove NetQ images, run:

netq lcm show netq-images [json]
netq lcm del netq-image <text-image-id>

  1. Determine the ID of the image you want to remove.

    cumulus@switch:~$ netq lcm show netq-images json
[
    {
        "id": "image_d23a9e006641c675ed9e152948a9d1589404e8b83958d53eb0ce7698512e7001",
        "name": "netq-agent_4.0.0-cl4u32_1609391187.7df4e1d2_amd64.deb",
        "netqVersion": "4.0.0",
        "clVersion": "cl4u32",
        "cpu": "x86_64",
        "imageType": "NETQ_AGENT",
        "lastChanged": 1609885430638.0
    }, 
    {
        "id": "image_68db386683c796d86422f2172c103494fef7a820d003de71647315c5d774f834",
        "name": "netq-apps_4.0.0-cl4u32_1609391187.7df4e1d2_amd64.deb",
        "netqVersion": "4.0.0",
        "clVersion": "cl4u32",
        "cpu": "x86_64",
        "imageType": "NETQ_CLI",
        "lastChanged": 1609885434704.0
    }
]

  2. Remove the image you no longer need.

    cumulus@switch:~$ netq lcm del netq-image image_68db386683c796d86422f2172c103494fef7a820d003de71647315c5d774f834

  3. Verify the command removed the image.

    cumulus@switch:~$ netq lcm show netq-images json
[
    {
        "id": "image_d23a9e006641c675ed9e152948a9d1589404e8b83958d53eb0ce7698512e7001",
        "name": "netq-agent_4.0.0-cl4u32_1609391187.7df4e1d2_amd64.deb",
        "netqVersion": "4.0.0",
        "clVersion": "cl4u32",
        "cpu": "x86_64",
        "imageType": "NETQ_AGENT",
        "lastChanged": 1609885430638.0
    }
]

    Copyright © 2024  NVIDIA Corporation