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
filter
Optional
Specification of matching hosts for which information should be returned.
If unset, the behavior is equivalent to a Host.FilterSpec with all fields unset which means all hosts match the filter.
Header Parameters
Header Parameters
string
vmware-api-session-id
Required
Required session ID, obtained by first calling Create Session API
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
