GET Vsphere Vc Hostname Hosts Esxi Host

GET Vsphere Vc Hostname Hosts Esxi Host

Get ESXi host with the specified hostname in the specified vSphere Server along with it's configuration details.

Request
URI
GET
https://{api_host}/api/v1/vsphere/{vcHostname}/hosts/{esxiHost}
COPY
Path Parameters
string
esxiHost
Required

Hostname of ESXi host

string
vcHostname
Required

vCenter Server hostname

Authentication
This operation uses the following authentication methods.
Responses
200

Successfully retrieved ESXi host with the specified hostname and it's configuration details.

{
    "host": {
        "hostname": "example-esxi-hostname",
        "os": "VMware ESXi",
        "version": "5.0.1",
        "build": "12345",
        "configured": true,
        "syslogProtocol": "tcp",
        "unsupported": false,
        "disconnected": true
    }
}
object
host
Optional

host


401

The request was refused because it lacks valid authentication credentials. This can happen if the Authorization header was missing, or if it contained an invalid session ID.

Obtain a new session ID and retry the request, or make an unauthenticated request without the Authorization header.

"Invalid session ID"

404

Specified ESXi host is not available under specified vSphere instance.

Configuration with specified vCenter Server hostname does not exist.

Operation doesn't return any data structure

440

The request was refused because the session ID has expired. Obtain a new session ID from /api/v1/sessions.

"Login Timeout"

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/v1/vsphere/{vcHostname}/hosts/{esxiHost}
On This Page
Vsphere Operations
GET
GET Vsphere
POST
POST Vsphere
GET
GET Vsphere Vc Hostname
PUT
PUT Vsphere Vc Hostname
DELETE
DELETE Vsphere Vc Hostname
GET
GET Vsphere Vc Hostname Hosts
PUT
PUT Vsphere Vc Hostname Hosts
GET
GET Vsphere Vc Hostname Hosts Esxi Host
PUT
PUT Vsphere Vc Hostname Hosts Esxi Host
POST
POST Vsphere Testconnection