API Guide
Table Of Contents
- OpenManage Integration for VMware vCenter Version 5.3 API Guide
- 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
- Host management
- Get subsystem health report (OMIVV Host Health)
- Host management
- Request body
- Response body
- OMIVV-Specific error codes
Example Response:
{
"componentType": "{component type}",
"elementName": "{Name of the software component}",
"installationDate": "{component installation date}",
"versionString": "{firmware version}",
"componentId": "{componenent ID}",
"deviceId": "{device ID}",
"identityInfoValue": "{component type:component ID}",
"instanceId": "{Unique identifier}",
"isEntity": "{true or false}",
"majorVersion": "{component major version}",
"minorVersion": "{component minor version}",
"releaseDate": null,
"revisionNumber": "{revison number}",
"serialNumber": "{serial number}",
"status": "{installation status}",
"subDeviceId": "{sub device ID}",
"subVendorId": "{sub vendor ID}",
"vendorId": "{vendor ID}"
For more information, see Response body on page 96.
Get host warranty
Description: Gets the host warranty.
Command or URL: /Services/InventoryService/Hosts/{id}/Warranty
Method: GET
Authorization: Bearer authentication
vCenter privileges required: Dell.Inventory.Configure Inventory
Table 61. Parameters
Parameter Value Description Default value Parameter
type
Data type
id (required) Host ID. Get the host ID from /
Services/ConsoleService/
Consoles/{Console-id}/Hosts
API. For more information, see Get
list of all hosts in vCenter on page 43.
N/A Path String
HTTP response code:
Table 62. HTTP response code
Code Description or response object
200 WarrantyInfo
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.
86
Host management