GET Vsphere UUID Hosts

GET Vsphere UUID Hosts

Get ESXi hosts of the vCenter Server with the specified UUID along with their configuration details.

Request
URI
GET
https://{api_host}/api/v2/vsphere/{UUID}/hosts
COPY
Path Parameters
string
UUID
Required

vCenter Server UUID


Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved the list of ESXi hosts and their configuration details.

{
    "hosts": [
        {
            "hostname": "example-esxi-hostname",
            "os": "VMware ESXi",
            "version": "5.0.1",
            "build": "12345",
            "configured": true,
            "syslogProtocol": "tcp",
            "unsupported": false,
            "disconnected": true
        },
        {
            "hostname": "example-esxi-hostname1",
            "os": "VMware ESXi",
            "version": "5.0.1",
            "build": "12345",
            "configured": false,
            "syslogProtocol": "udp",
            "unsupported": false,
            "disconnected": false
        }
    ]
}
array of object
hosts
Optional

hosts


401
Operation doesn't return any data structure

404

Configuration with specified vCenter Server UUID does not exist.

Operation doesn't return any data structure

440
Operation doesn't return any data structure

500

Internal error while processing the client request

Returns error of type(s) application/json
{
    "errorMessage": "The operation failed due to an internal error."
}
string
errorMessage
Required

A message describing the error.

string
errorCode
Optional

A code representing the type of error.

Possible values are : LIMIT_ERROR, FIELD_ERROR, TEST_ERROR, JSON_FORMAT_ERROR, LICENSE_ERROR, VSPHERE_INTEGRATION_ERROR, VROPS_INTEGRATION_ERROR, UPGRADE_ERROR, SEARCH_ERROR, AGENT_ERROR, RBAC_COMMON_ERROR, RBAC_USERS_ERROR, RBAC_GROUPS_ERROR, RBAC_ADGROUPS_ERROR, RBAC_DATASETS_ERROR, RBAC_VIDM_GROUPS_ERROR, RBAC_VIDB_GROUPS_ERROR, SECURITY_ERROR, DEPLOYMENT_ERROR, SUPPORT_BUNDLE_ERROR, LOAD_BALANCER_ERROR, VIDM_ERROR, VIDB_ERROR, QUERY_ERROR, SSL_CERTIFICATE_ERROR, PROXY_ERROR,
object
errorDetails
Optional

Dynamic error details, where the field name can vary depending on the request field and error code.


Code Samples
COPY
                    curl -H 'Authorization: <value>' https://{api_host}/api/v2/vsphere/{UUID}/hosts