API Guide

15. LIFE CYCLE MANAGEMENT
15.1 GET /lcm/update-jobs
API to get all switch image update jobs
This api will return all the switch image update jobs present in the system
REQUEST
No request parameters
RESPONSE
STATUS CODE - 200: Response to get all switch image update jobs
RESPONSE MODEL - application/json
{
This object represent the list of switch image server update jobs.
data [{
Array of object:
id string
unique ID of this switch image update job.
name string
name of this switch image update job.
description string
description of the switch image update job.
job_type enum ALLOWED:SCHEDULED, NOW, NOT_SET
Whether the job is to be scheduled or executed now. This will be popluated once the job is
deployed.
scheduled_at integer
Time in the future that this job needs to be executed, if scheduled, represented in seconds
since epoch. This will be popluated once the job is deployed.
os_image_version string
OS image version that will be installed on the switches.
image_file_name string
Filename of the image.
job_state enum ALLOWED:DRAFT, PENDING_APPROVAL, APPROVED, SCHEDULED,
IN_PROGRESS, DONE, FAILED, NOT_SET, PARTIAL_SUCCESS
State of the image update job.
start_time integer
The overall start time for the update job, in seconds since epoch.
end_time integer
The overall end time for the update job, in seconds since epoch.
switch_group {
The switch group on which the job will be deployed. Once the job is approved, the group wont be returned, but it's switch members will be
returned.
id string
Id of the switch / switch group whose image need to be updated.
name string
Name of the switch / switch group whose image need to be updated.
}
switch_members [{
Array of object:
id string
name string
}]
image_server {
id string
Id of the image server object.
name string
Name of the image server object.
}
user_info {
This object describes the user information with respect to object like who created or updated the object
created_by string
Name of the user who created the object.
created_at integer
creation date of this object
last_updated_by string
Name of the user who last updated this object
last_updated_at integer
last update date of this object
}
193 of 340