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
Table 32. HTTP response code (continued)
Code Description or response object
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": "{Firmware update job ID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1Services/UpdateService/Jobs/
{firmware update job ID}",
"objectType": "JOB",
"status": "{job status}"
}
]
For more information, see Response body on page 96.
Get firmware update job details (Host or Cluster)
Description: Gets the details of the given host firmware update job ID.
Command or URL: /Services/UpdateService/Jobs/{id}
Method: GET
Authorization: Bearer authentication
Parameters:
Table 33. Parameters
Param
eter
Value Description Default
value
Parameter
type
Data type
id (required) Firmware update job ID. Use the firmware update
job ID received from the Get list of host
firmware update jobs API. For more information,
see Get list of firmware update jobs (Host and
Cluster) on page 65.
N/A Path String
vCenter privileges required: Dell.Configuration.Firmware Update
HTTP response code:
Table 34. HTTP response code
Code Description or response object
200 OK
400 Operational Context is not set
401 Authorization failure
403 vCenter permission denied
404 Resource not found
429 Too many requests
66 Firmware update management