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 12. 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 / timeout
Example Response:
{
"id": "{vCenter ID}",
"href": "https://{OMIVV IP}/Spectre/api/rest/v1/Services/ConsoleService/Consoles/
{vCenterID}",
"objectType": "Console",
"ip": "{vCenter IP}",
"hostname": "{vCenter hostname or FQDN}",
"registeredWithVlcm": "{vLCM registration status (true or false)},
"datacenters": [
{
"id": "{Datacenter ID}",
"href": "",
"objectType": "Datacenter",
"name": "{Datacenter name}",
"clusters": [
{
"id": "{cluster ID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/
ConsoleService/Clusters/{clusterID}",
"objectType": "ClusterMetadata",
"name": "{cluster name}"
},
{
"id": "{cluster id}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/
ConsoleService/Clusters/{clusterID}",
"objectType": "ClusterMetadata",
"name": "{Cluster name}"
}
],
"hosts": ": [
{
"id": "{Host ID}",
"href": "",
"objectType": "Host",
"hostip": "{Host IP}",
"hostName": "{Hostname or FQDN}",
"managementIP": "{iDRAC IP}",
"serviceTag": "{Host Service Tag}",
"model": "{Server Model Name}",
"systemId": "{System ID}"
}
]
}
,
For more information, see Response body on page 96.
Set vCenter context
Description: Sets the vCenter context on which user want to perform any operation.
Enter the vCenter ID received from /Services/ConsoleService/Consoles API.
Console management
45