system firmware update

Updates the system firmware.

Parameters

FLASH-FILE

Specifies the flash file path in format flash://firmware/filename.

USB-FILE

Specifies the USB file path in format usb://file-name.

SCP-FILE

Specifies the SCP file path in format scp://username:password@host[:port]/filepath.

SFTP-FILE

Specifies the SFTP file path in format sftp://username:password@host[:port]/filepath.

HTTP-FILE

Specifies the HTTP file path in format http://[username:password@]host[:port]/filepath.

HTTPS-FILE

Specifies the HTTPS file path in format https://[username:password@]host[:port]/filepath.

username

Account name of the authorized user.

password

Password of the authorized user.

Note

As a best practice, do not list the password in the command line for security purposes. The user will be prompted for the password.

hostname

Specifies the server by name or IP address. Both IPv4 and IPv6 are supported.

Hostname usage requires that DNS resolution is configured on the device.

port

Specifies the port number, which must be preceded by a colon. If the port is not included, the default port is assumed.

filepath

Specifies the path to the file.

Modes

Exec mode

Usage Guidelines

This command is available only to users with admin role.

Host IP must be in the format of a valid IPv4 address.

Firmware images are .bin files with the version format, YearBorn.Major.Minor.Patch.

There is no auto-commit after firmware update.

• After the firmware update, use the system firmware commit command to commit the new firmware version.
• Use the system firmware rollback command to remove the new image from the device.

Example

The following examples show error messages for system firmware update.

Invalid URL format:

device# system firmware update temp.bin 
temp.bin is not a valid URL format 
 
Usage:
usb://<filename> 
flash://firmware/<filename> 
scp://<username>:<password>@<host>[:port]/<filepath> 
sftp://<username>:<password>@<host>[:port]/<filepath> 
http://[username:password@]<host>[:port]/<filepath> 
https://[username:password@]<host>[:port]/<filepath> 

Invalid host name or IP address:

device# system firmware update http://test.example.com:8000/home/test/filename.bin 
Error: No such host test.example.com

# system firmware update http://1.1.1.1:8081/home/test/filename.bin 
Error: Host IP not reachable

Invalid image file name:

device# system firmware update http://test.example.com:9000/home/test/filename.bin 
Error: Input File does not exist

Invalid user credentials:

device# system firmware update scp://test:test@1.1.1.1/home/test/filename.bin 
Error: Invalid user credentials 

Invalid file type:

device# system firmware update scp://test:test@1.1.1.1/home/test/abc.txt 
Error: File abc.txt is not the correct format for firmware images 

Firmware version already installed:

device# system firmware update http://1.1.1.1:8000/home/test/TierraOS-21.1.0.0-NPB.bin 
Activate failed with error: Activation failed -  version TierraOS-21.1.0.0-NPB is already running 

Checksum mismatch:

device# system firmware update http://1.1.1.1:8000/home/test/TierraOS-21.1.0.0-NPB.bin  
Activate failed with error: Activation failed -  Checksum mismatch for /var/data/firmware/ TierraOS-21.1.0.0-NPB.bin  

Invalid firmware directory:

device# system firmware update flash://ms-images/TierraOS-21.1.1.0-NPB.bin 
Firmware files should be in firmware directory and Microservices in ms-images directory

Pre-install script failure:

device# system firmware update http://1.1.1.1:8000/home/test/TierraOS-21.1.1.0-NPB.bin  
Activate failed with error: Activation failed -  PreInstall script failed with exit status 1 

Downgrade validation failure:

device# system firmware update http://1.1.1.1:8000/home/test/TierraOS-21.1.1.0-NPB.bin  
Activate failed with error: Activation failed -  Downgrade validator failed with exit status 1 

DB conversion failure:

device# system firmware update http://1.1.1.1:8000/home/test/TierraOS-21.1.0.0-NPB.bin  
Activate failed with error: Activation failed -  DB conversion failed with exit status 1 

Invalid image file:

device# system firmware update flash://firmware/TierraOS-21.1.1.0-NPB.bin 
File flash://firmware/TierraOS-21.1.10-NPB.bin does not exist 

USB not enabled:

device# system firmware update usb://TierraOS-21.1.1.0-NPB.bin 
Error: USB not enabled