Vcenter VM list

Returns information about at most 4000 visible (subject to permission checks) virtual machines in vCenter matching the Vcenter VM FilterSpec.

Request

URI

GET

https://{api_host}/api/vcenter/vm

COPY

Query Parameters

string of array

vms

Optional

Identifiers of virtual machines that can match the filter.

If missing or null or empty, virtual machines with any identifier match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: VirtualMachine. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: VirtualMachine.

string of array

names

Optional

Names that virtual machines must have to match the filter (see Vcenter VM Info.name).

If missing or null or empty, virtual machines with any name match the filter.

string of array

folders

Optional

Folders that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines in any folder match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Folder. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Folder.

string of array

datacenters

Optional

Datacenters that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines in any datacenter match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: Datacenter. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: Datacenter.

string of array

hosts

Optional

Hosts that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines on any host match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: HostSystem. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: HostSystem.

string of array

clusters

Optional

Clusters that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines in any cluster match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ClusterComputeResource. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ClusterComputeResource.

string of array

resource_pools

Optional

Resource pools that must contain the virtual machine for the virtual machine to match the filter.

If missing or null or empty, virtual machines in any resource pool match the filter.

When clients pass a value of this schema as a parameter, the property must contain identifiers for the resource type: ResourcePool. When operations return a value of this schema as a response, the property will contain identifiers for the resource type: ResourcePool.

string of array

power_states

Optional

Power states that a virtual machine must be in to match the filter (see Vcenter Vm Power Info.state.

For more information see: Vcenter Vm Power State.

If missing or null or empty, virtual machines in any power state match the filter.

Authentication

This operation uses the following authentication methods.

api_key_auth

Responses

200

Commonly used information about the virtual machines matching the Vcenter VM FilterSpec.

[
    {
        "vm": "string",
        "name": "string",
        "power_state": "string",
        "cpu_count": 0,
        "memory_size_mib": 0
    }
]

array of Vcenter VM Summary

Optional

400

if the Vcenter VM FilterSpec.power_states property contains a value that is not supported by the server.

Returns Vapi Std Errors InvalidArgument of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors InvalidArgument0

"Vapi Std Errors InvalidArgument Object"

401

if the user can not be authenticated.

Returns Vapi Std Errors Unauthenticated of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthenticated0

"Vapi Std Errors Unauthenticated Object"

string

challenge

Optional

Indicates the authentication challenges applicable to the target API provider. It can be used by a client to discover the correct authentication scheme to use. The exact syntax of the value is defined by the specific provider, the protocol and authentication schemes used.

For example, a provider using REST may adhere to the WWW-Authenticate HTTP header specification, RFC7235, section 4.1. In this case an example challenge value may be: SIGN realm="27da1358-2ba4-11e9-b210-d663bd873d93",sts="http://vcenter/sso?vsphere.local", Basic realm="vCenter"

This property was added in vSphere API 7.0.0.0.

This property is optional because it was added in a newer version than its parent node.

403

if the user doesn't have the required privileges.

Returns Vapi Std Errors Unauthorized of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors Unauthorized0

"Vapi Std Errors Unauthorized Object"

500

if more than 4000 virtual machines match the Vcenter VM FilterSpec.

Returns Vapi Std Errors UnableToAllocateResource of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors UnableToAllocateResource0

"Vapi Std Errors UnableToAllocateResource Object"

503

if the system is unable to communicate with a service to complete the request.

Returns Vapi Std Errors ServiceUnavailable of type(s) application/json

This response body class contains all of the following: InlineVapi Std Errors ServiceUnavailable0

"Vapi Std Errors ServiceUnavailable Object"

Code Samples

COPY

                    curl -H 'Authorization: <value>' https://{api_host}/api/vcenter/vm

On This Page

Description

Request

Query Parameters

Authentication

Response

200 Response Body

Errors

Vcenter Operations

Vcenter VM instantClone

Vcenter VM unregister

POST

Vcenter VM clone$Task

POST

Vcenter VM relocate$Task