system firmware update

Updates system firmware.

Syntax

system firmware update {{scp:// | sftp:// } username:password@ hostname[:port]/filepath }} | {{ http:// | https:// } username:password@ hostname[:port]/filepath }} ]

Parameters

scp://: Specifies use of the Session Control Protocol (SCP).
sftp://: Specifies use of Secure File Transfer Protocol (SFTP).
http: Specifies use of HTTP.
https: Specifies use of HTTP secure.
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 by IPv4 address. IPv6 is not 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.

Versioning format is YearBorn.Major.Minor.Patch. If there are no errors during install, the system reboots and the firmware update is active.

There is no auto-commit after firmware update.

If you are satisfied with the new update, run the system firmware commit command when the system reboots to commit the new firmware version.
If the new firmware does not come up properly, you must run the system firmware rollback and remove the new image from the device.

Table 1. Error Messages
Error	Reason
`Error: filename.bin is not a valid URL format`	URL in command is poorly formed or missing.
`Error: No such host test.example.com`	DNS resolution is not configured on the device or the address is poorly formed.
`Error: Host IP not reachable`	Host is down or IPv4 address entered incorrectly.
`Error: Invalid user credentials`	User does not have permissions or credentials were typed incorrectly.
`Error: File abc.txt is not the correct format for service images`	Valid file format is binary.
`Activate failed with error: Activation failed - Checksum mismatch for /var/data/firmware/TierraOS-xx.x.x.x-NPB.bin`	Checksum does not match.

Examples

The following examples update system firmware.

device# system firmware update http://1.1.1.1:8000/path/TierraOS-21.1.0.0-NPB.bin

device# system firmware update scp://test:pass@1.1.1.1/path/TierraOS-21.1.0.0-NPB.bin 

device# system firmware update sftp://test:pass@1.1.1.1/path/TierraOS-21.1.0.0-NPB.bin

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: 
scp://user:pass@host[:port]/filepath/filename 
sftp://user:pass@host[:port]/filepath/filename 
http://[user:pass@]domain[:port]/filepath/filename 
https://[user:pass@]domain[:port]/filepath/filename

Image cannot be downloaded:

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

Firmware version is already running:

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

Checksum of the image does not match:

device# NPB# system firmware update http://1.1.1.1:8000/path/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