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

request software install

request software install—Download, install, and activate a software image on the Viptela device (on all devices except vEdge 100 routers). Before the software is installed, the software image is verified to determine that it is valid and that it has been signed. If the verification process fails, the software image installation is not performed.

Command Syntax

request software install filename [download-timeout minutes] [reboot [no-sync] ] [vpn vpn-id]


Installation Timeout Value
download-timeout minutes
How long to wait before canceling requests to install software.
Range: 1 through 1440 minutes (24 hours)
Default: 60 minutes
Name of Software Image
Install the software image in specified filename. The file can be in your home directory on the local device, or it can be on a remote device reachable through FTP, HTTP, SCP, or TFTP. If you are using SCP, you are prompted for the directory name and filename. No file path name is provided.
For a vEdge router, filename has the format viptela-release-number-mips64.tar.bz2 (this image includes both the vEdge and the software for a hardware-based vBond orchestrator).
For a vSmart controller and software-based vBond orchestrator, filename has the format viptela-release-number-x86_64.tar.bz2.
For a vManage NMS, filename has the format vmanage-release-number-x86_64.tar.bz2.
In all the image names, the release number consists of the last two digits of the release year and a number that indicates which release it is in that year. An example of a vEdge image name is viptela-16.1-mips64.tar.bz2, for the first image released in 2016. When you upgrade the software on a vManage NMS, you should back up the vManage storage partition before performing the upgrade. See Restore the vManage NMS.
Reboot after Installing the Software Image
reboot [no-sync]
Reboot the device after installation of the software image completes.
By default, the device's current configuration is copied to the other hard-disk partition and is installed with the new software image. If you include the no-sync option, the software is installed in the other hard-disk partition, and it is installed with the factory-default configuration. The existing configuration and any files that store information about the device history, such as log and trace files, are not copied to the other partition. Effectively, the no-sync option restores the device to its initial factory configuration.
Specific VPN
vpn vpn-id
VPN in which the image is located. When you include this option, one of the interfaces in the specified VPN is used to retrieve the software image. The interfaces on a vSmart controller are only in VPN 0, the VPN reserved for the control plane, so you can omit this option because vSmart images are always retrived from VPN 0.

Output Fields

The output fields are self-explanatory.

Details about the software download process are stored in the file /etc/viptela/download_log_latest. Only information for the latest download is stored in this file.

Note that after a software upgrade, if the newly installed software cannot operate for whatever reason with the existing configuration, the device is rebooted from the other partition, thus returning to the previous software version.

Example Output

Upgrade the software on a vManage NMS:

vManage# request software install /home/admin/vmanage-15.2.0-x86_64.tar.bz2 reboot 
It is recommended that you back up the vManage storage partition before upgrade. Proceed with upgrade? [y/n]: n
vManage storage partition not backed up. Stopping upgrade.
vManage# request software install /home/admin/vmanage-15.2.0-x86_64.tar.bz2 reboot
It is recommended that you back up the vManage storage partition before upgrade. Proceed with upgrade? [y/n]: Y
Prompted for vManage storage backup. Proceeding with upgrade
Starting download of image..
Copying file:///home/admin/vmanage-15.2.0-x86_64.tar.bz2via VPN 0
Successfully downloaded /home/admin/vmanage-15.2.0-x86_64.tar.bz2
Validating image /home/admin/vmanage-15.2.0-x86_64.tar.bz2..
Preparing filesystem
Extracting firmware
Creating recovery backup for factory reset
configuring boot-loader
Installation complete
preparing for reboot

Release Information

Command introduced in Viptela Software Release 14.1.
no-sync option added in Release 14.2.
download-timeout option added in Release 15.3.5.
Prompt for backing up vManage database added in Release 15.3.5.
Support for signed images and image verification added in Release 16.1.

  • Was this article helpful?