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 34. HTTP response code (continued)
Code Description or response object
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": "UpdateJob",
"status": "{job status}",
"data": {
"jobname": "{Job name}",
"jobdesc": "{Job description}",
"updateType": "{Update type}",
"schedule": {
"runNow": false,
"runLater": true,
"dateTime": "{Update job schedule date and time}"
},
"repoProfileID": "{Repository profile ID}",
"associatedEntities": [
{
"host": {
"id": "{Host ID}",
"href": "",
"objectType": "Host",
"hostip": "{Host IP}",
"hostName": "{Hostname}",
"managementIP": "{iDRAC IP}",
"serviceTag": "{Host Service Tag}",
"model": "{Server model name}",
"systemId": "{System ID}"
},
"bundleId": null,
"packageIDs": [
"{Package ID1}",
"{Package ID2}"
]
}
],
"rebootOptions": "{reboot options}",
"jobSpecificCustomConfiguration": {
"exitMaintenanceMode":{true or false},
"migratePoweredOffAndSuspendedVMs":{true or false},
"resetIDracAndDeleteJobs":{true or false},
"enterMaintenanceModetimeout":60,
“enterMaintenanceModeOption”: “{Enter maintenance mode option}”
}
}
}
For more information, see Response body on page 96.
Delete firmware update job
Description: Deletes specific firmware update job. You can delete only one job at a time.
This API enables you to delete only Successful, Failed, and Canceled firmware update jobs.
Command or URL: /Services/UpdateService/Jobs/{id}
Method: DELETE
Authorization: Bearer authentication
vCenter privileges required: Dell.Configuration.Firmware Update
Firmware update management
67