API Guide

Console management
Topics:
• Get list of registered vCenters
•
Get list of all hosts in vCenter
• Get host details
• Get vCenter tree view of data center
• Set vCenter context
• Get cluster details
• Get cluster health
Get list of registered vCenters
Description: Gets the list of all the registered vCenters for the given OMIVV.
Command or URL: /Services/ConsoleService/Consoles
Method: GET
Parameters: None
Authorization: Bearer authentication
vCenter privileges required: None
HTTP response code:
Table 8. HTTP response code
Code Description or response object
200 OK
401 Authorization failure
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": "{vCenter ID}",
"href": "https://{OMIVVIP}/Spectre/api/rest/v1/Services/ConsoleService/Consoles/
{vCenter ID}",
"objectType": "ConsoleMetadata",
"hostname": "{vCenter hostname or FQDN}",
"ip": "{vCenter IP}"
}
]
For more information, see Response body on page 96.
7
42 Console management