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
Authorization: Bearer authentication
vCenter privileges required: None
HTTP response code:
Table 10. HTTP response code
Code Description or response object
200 OK
401 Authorization failure
404 Resource not found
429 Too many requests
500 Internal Server error
For OMIVV-Specific error codes, see OMIVV-Specific error codes on page 112.
Example Response:
{
"id": "{Host ID}",
"href": "string",
"objectType": "string",
"hostip": "{Host IP}",
"hostName": "{Hostname}",
"managementIP": "{iDRAC IP}",
"serviceTag": "{Service Tag}",
"model": "{Server model name}",
"systemId": "{System ID}"
}
For more information, see Response body on page 96.
Get vCenter tree view of data center
Description: Gets the vCenter tree view of all the data centers, clusters, and hosts of the given vCenter ID.
This API helps you to get the host and cluster details for operations like firmware update.
All Dell EMC and OEM managed or unmanaged hosts are listed.
Command or URL: /Services/ConsoleService/Consoles/{id}
Method: GET
Authorization: Bearer authentication
Parameters:
Table 11. Parameters
Parameter Value Description Default value Parameter
type
Data type
id (required) Resource ID. Use the vCenter ID
received from the Get list of
registered vCenters API. For more
information, see Get list of registered
vCenters on page 42.
N/A Path String
For OMIVV-Specific error codes, see OMIVV-Specific error codes on page 112.
vCenter privileges required: None
HTTP response code:
44
Console management