API Guide
Table Of Contents
- OpenManage Integration for VMware vCenter Version 5.3 API Guide
- Contents
- Overview
- Get started
- Security
- Use cases
- Session management
- License management
- Console management
- Repository profile management
- Cluster profile management
- Firmware repository inventory management
- Firmware inventory management
- Firmware update management
- System profile management
- Drift management
- Get subsystem health report (OMIVV Host Health)
- Host management
- Request body
- Response body
- OMIVV-Specific error codes
"exitMaintenanceMode":{true or false},
"migratePoweredOffAndSuspendedVMs":{true or false},
"resetIDracAndDeleteJobs":{true or false},
"enterMaintenanceModetimeout":60,
“enterMaintenanceModeOption”: “{enter maintenance mode option}”
}
}
For more information about request body parameters, see Request body on page 92.
Authorization: Bearer authentication
Parameters: None
vCenter privileges required: Dell.Configuration.Firmware Update
HTTP response code:
Table 31. HTTP response code
Code Description or response object
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 112.
Example Response:
{
"id": "{JOB ID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/UpdateService/Jobs/{job ID}",
"objectType": "Job",
"status": "Scheduled"
}
For more information, see Response body on page 96.
Get list of firmware update jobs (Host and Cluster)
Description: Gets all the host and cluster firmware update jobs.
Command or URL: /Services/UpdateService/Jobs
Method: GET
Authorization: Bearer authentication
Parameters: None
vCenter privileges required: Dell.Configuration.Firmware Update
HTTP response code:
Table 32. HTTP response code
Code Description or response object
200 OK
Firmware update management 65