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}/rest/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, acquired from Create Session API under CIS product
vmware-api-session-id Example
b00db39f948d13ea1e59b4d6fce56389
Response
Response
Response BodyResponse Body
200 OK returns
HostListResponseBody
of type application/json
Commonly used information about the hosts matching the Host.FilterSpec.
{
"value": [
{
"connection_state": "enum",
"host": "string",
"name": "string",
"power_state": "enum"
}
]
}
array of
HostSummary
value
Optional
Commonly used information about the hosts matching the Host.FilterSpec.
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/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.
401
com.vmware.vapi.std.errors.unauthenticated : if the user can not be authenticated. | com.vmware.vapi.std.errors.unauthorized : if the user doesn't have the required privileges.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
507
com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 2500 hosts match the Host.FilterSpec.
default
'Default' means this response is used for all HTTP codes that are not covered individually for this operation.
