List VM
Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the VM.FilterSpec.
Request
URLURL
https://{api_host}/rest/vcenter/vm
Query Parameters
Query Parameters
filter
Optional
Specification of matching virtual machines for which information should be returned. If unset, the behavior is equivalent to a VM.FilterSpec with all fields unset which means all virtual machines 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"
Authentication
This operation uses the following authentication methods.
Response
Response
Response BodyResponse Body
200 OK returns
VMListResponseBody of type application/json
Commonly used information about the virtual machines matching the VM.FilterSpec.
{
"value": [
{
"cpu_count": 0,
"memory_size_MiB": 0,
"name": "string",
"power_state": "POWERED_OFF",
"vm": "string"
}
]
}
array of
VMSummary
value
Optional
Commonly used information about the virtual machines matching the VM.FilterSpec.
Errors
400
com.vmware.vapi.std.errors.invalid_argument : if the VM.FilterSpec.power-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 4000 virtual machines match the VM.FilterSpec.
503
com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request.
default
‘Default’ means this response is used for all HTTP codes that are not covered individually for this operation.
Code Samples
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm
Vendor Extensions
This operation contains the following vendor extensions defined in the spec:
x-vmw-doc-operation: list
On This Page
VM Operations
get
post
get
delete
post
post
post
post
post
post
post
