Vcenter Host list

Returns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Vcenter Host FilterSpec.

Request

URI

GET

https://{api_host}/api/vcenter/host

COPY

Query Parameters

Vcenter Host FilterSpec

filter

Optional

Specification of matching hosts for which information should be returned.

If missing or null, the behavior is equivalent to a Vcenter Host FilterSpec with all properties missing or null which means all hosts match the filter.

string of array

hosts

Optional

Identifiers of hosts that can match the filter.

If missing or null or empty, hosts with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

string of array

names

Optional

Names that hosts must have to match the filter (see Vcenter Host Summary.name).

If missing or null or empty, hosts with any name match the filter.

string of array

folders

Optional

Folders that must contain the hosts for the hosts to match the filter.

If missing or null or empty, hosts in any folder match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

string of array

datacenters

Optional

Datacenters that must contain the hosts for the hosts to match the filter.

If missing or null or empty, hosts in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.

string of array

clusters

Optional

Clusters that must contain the hosts for the hosts to match the filter.

If missing or null or empty, hosts in any cluster and hosts that are not in a cluster match the filter. If this property is not empty and Vcenter Host FilterSpec.standalone is true, no hosts will match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.

string of array

connection_states

Optional

Connection states that a host must be in to match the filter (see Vcenter Host Summary.connection_state.

For more information see: Vcenter Host ConnectionState.

If missing or null or empty, hosts in any connection state match the filter.

string of array

host_uuids

Optional

UUID of hosts that can match the filter. Maps to "UUID" in SMBIOS: System Information (Type 1) and offset 08h

This property was added in vSphere API 9.0.0.0.

If missing or null or empty, hosts with any identifier match the filter.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

Commonly used information about the hosts matching the Vcenter Host FilterSpec.

[
    "Vcenter Host Summary Object"
]

array of Vcenter Host Summary

Optional

400

if the Vcenter Host FilterSpec.connection_states property contains a value that is not supported by the server.

Returns Vapi Std Errors InvalidArgument of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0

"Vapi Std Errors InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

500

if more than 2500 hosts match the Vcenter Host FilterSpec.

Returns Vapi Std Errors UnableToAllocateResource of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors UnableToAllocateResource0

"Vapi Std Errors UnableToAllocateResource Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0

"Vapi Std Errors ServiceUnavailable Object"

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/host

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Vcenter Operations

Vcenter Host disconnect