API Guide

messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
messages [{
Array of object:
id string
This represents the key for the localized property le to be used by UI to show the localized string.
message string
Success or error message
field_name string
Field name where the error was seen
messageParams [string]
Params array to substitute in the message. This will be used by UI to substitue the params in the
Message in the localized le.
}]
}
15.9 POST /lcm/update-jobs/{id}/status
API to get status of a switch image update job.
Get the status of a switch image update job represented by the requested 'id'.
REQUEST
PATH PARAMETERS
NAME TYPE DESCRIPTION
*id string
Unique identier of the switch image update job.
RESPONSE
STATUS CODE - 200: Response to get status for a switch image update job.
RESPONSE MODEL - application/json
{
This object returns the status of switch image update job.
start_time integer
Time in seconds since epoch, when the update job started.
end_time integer
Time in seconds since epoch, when the update job ended.
status enum ALLOWED:NOT_STARTED, IN_PROGRESS,
PARTIAL_SUCCESS, SUCCESS, FAILED
Represents the overall status of the image update job.
data [{
Array of object: Represents the image update job status for a switch.
switch_member {
id string
ID of the switch.
name string
name of the switch.
}
update_progress_status enum ALLOWED:DOWNLOAD_IN_PROGRESS, INSTALL_IN_PROGRESS,
REBOOT_IN_PROGRESS, SWITCH_UNREACHABLE,
SWITCH_REACHABILITY_TIMED_OUT,
INSTALL_REQUEST_RECEIVED, SUCCESS, FAILED, NOT_SET
Represents the overall status of the image upadate process.
error enum ALLOWED:NOT_SET, MALFORMED_IMAGE_URL,
ANOTHER_INSTALL_IN_PROGRESS,
IMAGE_URL_NOT_REACHABLE, DOWNLOAD_FAILED,
EXTRACTION_FAILED, DOWNLOAD_VALIDATION_FAILED,
IMAGE_INSTALL_FAILED, IMAGE_ACTIVATION_FAILED,
IMAGE_SET_BOOT_FAILED, SWITCH_UNREACHABLE
Represents an error during image update, if the progress_status is marked as FAILED.
download_status {
Represents the status of image download.
status enum ALLOWED:NOT_SET, IDLE, DOWNLOAD_IN_PROGRESS, DOWNLOAD_FAILED,
207 of 340