API Guide

Console management

Topics:

• Get list of registered vCenters

• 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 3. HTTP response code

Code Description

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 47.

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 39.

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.

Console management 11