This API has a deprecated equivalent from v7.0U1.
List Host
DescriptionReturns information about at most 2500 visible (subject to permission checks) hosts in vCenter matching the Host.FilterSpec.
Request
URLURL
https://{api_host}/api/vcenter/host
Query Parameters
Query Parameters
array of
string
clusters
Optional
Clusters that must contain the hosts for the hosts to match the filter.
If unset or empty, hosts in any cluster and hosts that are not in a cluster match the filter. If this field is not empty and Host.FilterSpec.standalone is true, no hosts will match the filter.
When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: ClusterComputeResource.
array of
HostConnectionState
connection_states
Optional
Connection states that a host must be in to match the filter (see Host.Summary.connection-state.
If unset or empty, hosts in any connection state match the filter.
array of
string
datacenters
Optional
Datacenters that must contain the hosts for the hosts to match the filter.
If unset or empty, hosts in any datacenter match the filter.
When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Datacenter. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Datacenter.
array of
string
folders
Optional
Folders that must contain the hosts for the hosts to match the filter.
If unset or empty, hosts in any folder match the filter.
When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: Folder. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: Folder.
array of
string
hosts
Optional
Identifiers of hosts that can match the filter.
If unset or empty, hosts with any identifier match the filter.
When clients pass a value of this structure as a parameter, the field must contain identifiers for the resource type: HostSystem. When operations return a value of this structure as a result, the field will contain identifiers for the resource type: HostSystem.
array of
string
names
Optional
Names that hosts must have to match the filter (see Host.Summary.name).
If unset or empty, hosts with any name match the filter.
boolean
standalone
Optional
If true, only hosts that are not part of a cluster can match the filter, and if false, only hosts that are are part of a cluster can match the filter.
If unset Hosts can match filter independent of whether they are part of a cluster or not. If this field is true and Host.FilterSpec.clusters os not empty, no hosts will match the filter.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
vmware-api-session-id example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
array of
HostSummary of type application/json
Commonly used information about the hosts matching the Host.FilterSpec.
[
{
"connection_state": "enum",
"host": "string",
"name": "string",
"power_state": "enum"
}
]
connection_state
Required
Connection status of the host
Possible values are: CONNECTED , DISCONNECTED , NOT_RESPONDING
string
host
Required
Identifier of the host. When clients pass a value of this structure as a parameter, the field must be an identifier for the resource type: HostSystem. When operations return a value of this structure as a result, the field will be an identifier for the resource type: HostSystem.
string
name
Required
Name of the host.
power_state
Optional
Power state of the host This field is optional and it is only relevant when the value of Host.Summary.connection-state is CONNECTED.
Possible values are: POWERED_ON , POWERED_OFF , STANDBY
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/api/vcenter/host
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the Host.FilterSpec.connection-states field contains a value that is not supported by the server.
403
com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
500
com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 2500 hosts match the Host.FilterSpec.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
Availability
Added in 7.0U2
