API Guide

HTTP response code:
Table 21. HTTP response code
Code Description
202 OK
400 Operational Context not set
401 Authorization failure
403 VCenter permission denied
429 Too many requests
500 Internal Server error / timeout
For OMIVV-Specific error codes, see OMIVV-Specific error codes on page 47.
Example Response:
{
"id": "{JOB ID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/UpdateService/Jobs/{job ID}",
"objectType": "Job",
"status": "{Job status}"
}
For more information, see Response body on page 39.
Create cluster level firmware update jobs
Description: Creates the firmware update job for a cluster managed by OMIVV. You can update both vSAN and vSphere
clusters.
Driver update is not supported.
It may take few seconds to create the firmware update job for large number of hosts.
Command or URL: Services/UpdateService/Jobs
Method: POST
Request body:
{
"jobname":"{job name}",
"jobdesc":"{job description}",
"updateType":"{Update type (firmware)}",
"updateTargetType":"CLUSTER",
"schedule":{
"runLater":{Scheduled to run at a specified time (true or false),
"dateTime":"{Firmware update job schedule (Firmware update job schedule
(date and time format:YYYY-MM-DDTHH:MM:SSZ, 24 hour UTC time)}"
"runNow":{Run firmware update job now (true or false)},
},
"firmwareRepoProfileID":"{Firmware repository profile ID}",
"rebootOptions":"{Reboot options}",
"preCheck":{Check prerequisites before upate(true or false),
"firmwareUpdateTargets":[
{
"hostId":"{Host ID}",
"clusterId":"{Cluster ID, only for cluster update}",
"bundleId":"{Bundle ID}",
"packageIDs":["Package ID1", "Package ID2"]
}],
"jobSpecificCustomConfiguration":{
"exitMaintenanceMode":{true or false},
"migratePoweredOffAndSuspendedVMs":{true or false},
28
Firmware update management