Skip to main content
Cisco SD-WAN
Support
Product Documentation
Viptela Documentation

Software Upgrade

Use the Software Upgrade screen to download new software images and to upgrade the software image running on a Viptela device.

From a centralized vManage NMS, you can upgrade the software on Viptela devices in the overlay network and reboot them with the new software. You can do this for a single device or for multiple devices simultaneously.

When you upgrade a group of vBond orchestrators, vSmart controllers, and vEdge routers, the software upgrade and reboot is performed first on the vBond orchestrator, next on the vSmart controllers, and finally on the vEdge routers. For vEdge routers, up to five routers can be upgraded and rebooted in parallel at the same time.

You cannot include the vManage NMS in a group software upgrade operation. You must upgrade and reboot the vManage server by itself.

It is recommended that you perform all software upgrades from the vManage NMS rather than from the CLI.

Screen Elements

  • Top bar—On the left are the menu icon, for expanding and collapsing the vManage menu, and the vManage product name. On the right are a number of icons and the user profile drop-down.
  • Title bar—Includes the title of the screen, Software Upgrade.
  • Device List drop-down—Displays the list of devices in the overlay network. When you first open the Software Upgrade screen, Device List is selected by default.
    • WAN Edge tab bar—Includes the Controller and vManage tabs.
    • Rows Selected—Displays the number of rows selected from the table. Includes:
      • Upgrade button—Installs a new software version on the device. Includes:
      • Activate button—Reboots the device and activates the new software version.
      • Delete Available Software button—Delete a software version from a device.
      • Set Default Version button—Set a software image to be the default image on the device.
    • Device Group drop-down—List of all configured device groups in the network.
    • Table of devices in the overlay network—To re-arrange the columns, drag the column title to the desired position.
  • Repository drop-down—Click Repository from the Device List drop-down to display the list of software images on the vManage or remote server.
    • Add New Software drop-down (on Repository screen)—Upload new software images to the vManage or remote server.
    • Table of software images—To re-arrange the columns, drag the column title to the desired position.
  • Search box—Includes the Search Options drop-down, for a Contains or Match string.
  • Refresh icon—Click to refresh data in the device table with the most current data.
  • Export icon—Click to download all data to a file, in CSV format (on Device List screen only).
  • Show Table Fields icon—Click to display or hide columns from the device table. By default, all columns are displayed.

G00478.png

View Software Images

To view a list of software images in the repository on the vManage server or on a remote server, from the Device List drop-down, click Repository.

Upgrade a Software Image

To upgrade the software image on a device:

  1. In the title bar, click the WAN Edge, Controller, or vManage tab.
  2. Select one or more devices on which to upgrade the software image.
  3. Click the Upgrade button. The Software Upgrade dialog box opens.
  4. Select the software version to install on the device. If the software is located on a Remote Server, select the VPN in which the software image is located.
  5. To automatically activate the new software version and reboot the device, select the Activate and Reboot checkbox.
  6. Click Upgrade. A progress bar indicates the status of the software upgrade.

If the control connection to the vManage NMS does not come up within the configured time limit, vManage NMS automatically reverts the device to the previously running software image. The configured time limit for all Viptela devices to come up after a software upgrade is 5 minutes, except for vEdge 100 routers, which have a default time of 12 minutes.

Note: If you upgrade the vEdge software to a version higher than that running on a controller device, a warning message is displayed that software incompatibilities might occur. It is recommended that you upgrade the controller software first, before upgrading the vEdge software.

Activate a New Software Image

If you did not select the Activate and Reboot checkbox when upgrading the software image, the device continues to use the existing configuration. To activate the new software image:

  1. In the title bar, click the vEdge, Controller, or vManage tab.
  2. Select one or more devices on which to activate the new software image.
  3. Click the Activate button. The Activate Software dialog box opens.
  4. Select the software version to activate on the device.
  5. Click Activate. vManage NMS reboots the device and activates the new software image.

If the control connection to the vManage NMS does not come up within the configured time limit, vManage NMS automatically reverts the device to the previously running software image. The configured time limit for all Viptela devices to come up after a software upgrade is 5 minutes, except for the vEdge 100 routers, which have a default time of 12 minutes.

Delete a Software Image

To delete a software image from a Viptela device:

  1. In the title bar, click the WAN Edge, Controller, or vManage tab.
  2. Select one or more devices from which to delete a software image.
  3. Click the Delete Available Software button. The Delete Available Software dialog box opens.
  4. Select the software version to delete.
  5. Click Delete.

Set the Default Software Version

You can set a software image to be the default image on a Viptela device. Performing this operation overwrites the factory-default software image, replacing it with an image of your choosing. It is recommended that you set a software image to be the default only after verifying that the software is operating as desired on the device and in your network.

To set a software image to be the default image on a device:

  1. In the title bar, click the vEdge, Controller, or vManage tab.
  2. Select one or more devices on which you wish to change the default software image. 
  3. Click the Set Default Version button. The Set Default Version dialog box opens.
  4. From the Version drop-down, select the software image to use as the default.
  5. Click Set Default.

Export Device Data in CSV Format

To export data for all devices to a file in CSV format, click the Export button. This icon, which is a downward-pointing arrow, is located to the right of the filter criteria both in the WAN Edge List and in the Controllers tab.

vManage NMS downloads all data from the device table to an Excel file in CSV format. The file is downloaded to your brower's default download location and is named viptela_download.csv.

View Log of Software Upgrade Activities

To view the status of software upgrades and a log of related activities:

  1. Click the Tasks icon located in the vManage toolbar. vManage NMS displays a list of all running tasks along with the total number of successes and failures. 
  2. Click a row to see details of a task. vManage NMS opens a status window displaying the status of the task and details of the device on which the task was performed.
  • Was this article helpful?