The documentation set for this product strives to use bias-free language. For the purposes of this documentation set, bias-free is defined as language that does not imply discrimination based on age, disability, gender, racial identity, ethnic identity, sexual orientation, socioeconomic status, and intersectionality. Exceptions may be present in the documentation due to language that is hardcoded in the user interfaces of the product software, language used based on RFP documentation, or language that is used by a referenced third-party product. Learn more about how Cisco is using Inclusive Language.
This API only applies to mesh devices.
Note: Firmware upgrades are only supported on Cisco IOS.
This chapter describes the Firmware Upgrade API:
■Using the Firmware Upgrade API
■Firmware Upgrade API Method Calls
In your IoT FND NB API client application, use this IoT FND server URL to access the Firmware Upgrade API WSDL:
The following are the Firmware Upgrade API method calls:
The Firmware Upgrade API module allows client applications to start and stop firmware uploads to a group of mesh devices, check their firmware upload status, obtain firmware information by firmware group, setup a backup firmware image, and schedule a firmware reload.
Specified input parameters are not case sensitive, and are validated before further processing by IoT FND. All input parameters are character string. The utcDateAndTime format is “YYYY-MM-DD*HH:MM:SS.” Firmware Upgrade API Return Codes lists return codes sent by the Firmware Upgrade module.
|
|
---|---|
Invalid date and time format (scheduleReload). |
|
Simultaneous firmware group operations over maximum threshold. |
|
Cannot perform operation; firmware group file image only present on the nodes. |
|
Indicates a lower-layers system error, including: ■Invalid user permissions (Role Based Access Control) |
This call initiates the firmware upgrade on the specified firmware group with the specified firmware image.
startUpload Parameters describes the parameters in the interface.
|
|
|
---|---|---|
The firmware group of devices to receive the firmware upgrade. |
||
startUpload Results describes the parameters in the response.
|
|
---|---|
This call stops the firmware upgrade in progress on the specified firmware group.
stopUpload Parameters describes the parameters in the interface.
|
|
|
---|---|---|
The firmware group of devices to receive the firmware upgrade. |
stopUpload Results describes the parameters in the response.
|
|
---|---|
This call returns a list of value pairs indicating the number of devices in the specified firmware group with a partial firmware upload.
getFirmwareUploadStatus Parameters describes the parameters in the interface.
|
|
|
---|---|---|
The firmware group of devices to receive the firmware upgrade. |
getFirmwareUploadStatus Results describes the parameters in the response.
|
|
---|---|
This call returns a list with the name, version and number of devices that are running, uploaded and have a backup with this firmware version. The action status and scheduled reload date and time also return.
getFirmwareImageListInfo Parameters describes the parameters in the interface.
|
|
|
---|---|---|
The firmware group of devices to receive the firmware upgrade. |
getFirmwareImageListInfo Results describes the parameters in the response.
|
|
---|---|
This call sets the specified firmware image as the backup for the specified firmware group.
setBackupFirmwareImage Parameters describes the parameters in the interface.
|
|
|
---|---|---|
The firmware group of devices to receive the firmware upgrade. |
||
setBackupFirmwareImage Results describes the parameters in the response.
|
|
---|---|
This call sets the date and time for a firmware upgrade of the specified firmware image and group.
scheduleReload Parameters describes the parameters in the interface.
|
|
|
---|---|---|
The firmware group of devices to receive the firmware upgrade. |
||
scheduleReload Results describes the parameters in the response.
|
|
---|---|