Upgrade NVOS

Use the REST API to upgrade NVOS on your switches. First, create a switch profile, then upload the NVOS image and track the progress of the upgrade.

Requirements

Download the NVOS image from the NVIDIA Enterprise Support Portal.
Only the admin or read-write user (rw-user) can perform the steps in this section.

You can upgrade NVOS at either the switch-level or domain-level. Switch-level operations are prioritized before domain-level operations.

Switch-level upgrade

Authenticate your credentials by creating a switch profile. Make a POST request to the /v1/switch-profiles endpoint that contains your username and password. Copy the ProfileID from the response body.
Upload the NVOS image by making a POST request to the /v1/images endpoint. After the image is successfully uploaded, the response body returns an ImageID.
Make a POST request to the /v1/upgrade-switch endpoint; select switch-based upgrade and include the ProfileID and ImageID from the previous steps, in addition to the IP addresses of the switches you want to upgrade.
If all initial validations succeed, the API returns an HTTP 202 Accepted response with a JSON body containing an operation ID. You can make a GET request to the /v1/operations/ endpoint to track the progress of the upgrade.

Domain-level upgrade

Authenticate your credentials by creating a switch profile. Make a POST request to the /v1/switch-profiles endpoint that contains your username and password. Copy the ProfileID from the response body.
Upload the NVOS image by making a POST request to the /v1/images endpoint. After the image is successfully uploaded, the response body returns an ImageID.
Make a PATCH request to the /v1/domains/{id} endpoint to create an association between the profile ID from the first step and a given domain. The response body returns a DomainID.
Make a POST request to the /v1/upgrade-switch endpoint; select domain-based upgrade and include the DomainID and ImageID from the previous steps.
If all initial validations succeed, the API returns an HTTP 202 Accepted response with a JSON body containing an operation ID. You can make a GET request to the /v1/operations/ endpoint to track the progress of the upgrade.