tpvm upgrade

Upgrades the TPVM image. This command downloads the TPVM Debian image file using SCP or SFTP or FTP servers. Any previously installed TPVM instance is upgraded, and TPVM configuration from the SLX configuration database is applied, if available. Upgrades can be full or incremental. By default, full upgrades are performed.

Syntax

tpvm upgrade directory directory-name filename image-file-name host { hostname | ip-address } user username password password protocol { SCP | SFTP | FTP } uselocalfile tpvmid incremental snapshot use-vrf vrf-name

Parameters

directory directory-name: Specifies the remote directory that contains the TPVM image.
filename image-file-name: The Debian TPVM image file name.
host [ hostname | ip-address ]: Specifies the remote server. Remote server information can be provided either as a hostname or ip-address. Both IPv4 and IPv6 addresses are supported.
user username: Specifies the login name for the remote server.
password password: Specifies the password associated with the user name.
protocol [ SCP | SFTP | FTP ]: Specifies the protocol to be used to download the TPVM image.
uselocalfile: Indicates that the TPVM upgrade process must use the TPVM Debian file located in the directory /tftpboot/SWBD2900.
tpvmid: The ID of the TPVM instance. This value is always TPVM.
incremental: Indicates that incremental update must be performed.
snapshot: Indicates that when performing updates, both incremental as well as full, a snapshot of the TPVM instance before upgrade must be taken. This snapshot is then available for use if the upgrade fails for any reason.
use-vrf vrf-name: Defines the VRF to use to access the remote host.

Modes

EXEC mode

Usage Guidelines

The new TPVM Debian image file is downloaded to the /tftpboot/SWBD2900 directory. If any previous image file is present, it is moved to the /support/OldTpvm directory, provided enough space is available.

Note

The snapshot feature may delete this subfolder, /support/OldTpvm, to free space disk space when required.

During download of the TPVM image file, if TPVM is running, it is not stopped till the download is complete. On completion, the running TPVM instance (if any) is stopped and then uninstalled. If the snapshot parameter is used while upgrading, then a snapshot of the running TPVM is created.

The download may fail due to networking issues or not having enough free space on the device.

If SLX OS configuration database has TPVM configurations set, specially config deploy, then the upgrade process shall further install the new TPVM Debian image file, start the instance, and also apply other TPVM related persisted configurations from the SLX configuration database.

The default behavior of the tpvm upgrade command is to perform a full upgrade of the TPVM instance. To perform an incremental upgrade, you must use the incremental keyword explicitly. While performing the incremental upgrade, the Ubuntu Packages, TPVM script files, and XML files will be upgraded.

Incremental upgrade fails under the following conditions:

The current installed instance of TPVM is not running.
The installed TPVM version is lesser than version 4.5.0. In this case, you must perform a full TPVM install.
At least 1Gb of space is not available on the TPVM.

Note

When you downgrade the existing TPVM version to a version that is lower than SLXOS version 20.4.1, then you will have to remove the IPv6 configurations before downgrading. Appropriate warning will be displayed.

Examples

This example shows the command to perform a full upgrade of TPVM.

SLX# tpvm upgrade directory /proj/tpvm_upgrade/ filename tpvm-4.5.0-0.amd64.deb host 10.10.10.1 user fav password testpassword protocol scp use-vrf mgmt-vrf

This example shows the command to perform an incremental installation of TPVM.

SLX# tpvm upgrade incremental directory /proj/tpvm_upgrade/ filename tpvm_inc_upg-4.5.0-0.amd64.deb host 10.10.10.1 user fav password testpassword protocol scp use-vrf mgmt-vrf