List VM
If vSphere APIs begin with /rest, maps are consumed and emitted as lists of objects containing a key:value pair.
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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| optional |
|
VMFilterSpec | 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
| Required | Parameter Name | Type | Description |
|---|---|---|---|
| required |
|
string | Required session ID, obtained by first calling Create Session API |
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": "enum",
"vm": "string"
}
]
}| Property Name | Type | Description |
|---|---|---|
| value | array of VMSummary |
Commonly used information about the virtual machines matching the VM.FilterSpec. |
cURL Command
curl -H "vmware-api-session-id: b00db39f948d13ea1e59b4d6fce56389" https://{api_host}/rest/vcenter/vm
Errors
| Code | Returns | Description |
|---|---|---|
| 400 | ErrorRest | com.vmware.vapi.std.errors.invalid_argument : if the VM.FilterSpec.power-states field contains a value that is not supported by the server. |
| 401 | ErrorRest | 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 | ErrorRest | com.vmware.vapi.std.errors.service_unavailable : if the system is unable to communicate with a service to complete the request. |
| 507 | ErrorRest | com.vmware.vapi.std.errors.unable_to_allocate_resource : if more than 4000 virtual machines match the VM.FilterSpec. |
| default | ErrorRest | Not available |
VM Operations
get
post
get
delete
post
post
post
post
post
post
post
