Datacenter Power On Multi VM Task

Datacenter Power On Multi VM Task

Powers on multiple virtual machines in a data center.

If the virtual machines are suspended, this method resumes execution from the suspend point. The virtual machines can belong to different clusters in the data center.

If any virtual machine in the list is manually managed by DRS, or DRS has to migrate any manually managed virtual machine or power on any manually managed host in order to power on these virtual machines, a DRS recommendation will be generated, and the users need to manually apply the recommendation for actually powering on these virtual machines. Otherwise, all the virtual machine will be automatically powered on. The virtual machines on stand alone hosts or DRS disabled will be powered-on on the current host. The DRS automatically managed virtual machines will be powered-on on the recommended hosts.

When powering on a virtual machine in a cluster, the system might do an implicit relocation of the virtual machine to another host.

Required privileges: System.View

Request
URI
POST
https://{vcenter-host}/sdk/vim25/{release}/Datacenter/{moId}/PowerOnMultiVM_Task
COPY
Path Parameters
string
moId
Required

The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case Datacenter/{moId}.

string
release
Required

The vSphere release schema. The current specification covers vSphere 8.0.2.0 APIs.


Request Body
PowerOnMultiVMRequestType of type(s) application/json
Required
{
    "vm": [
        {
            "_typeName": "string",
            "type": "string",
            "value": "string"
        }
    ],
    "option": [
        {
            "_typeName": "string",
            "key": "string",
            "value": {
                "_typeName": "string"
            }
        }
    ]
}
vm
Required

The virtual machines to power on.

Required privileges: VirtualMachine.Interact.PowerOn

option
Optional

An array of OptionValue options for this power-on session. The names and values of the options are defined in ClusterPowerOnVmOptionEnum.

Authentication
This operation uses the following authentication methods.
Responses
200

This method returns a Task object with which to monitor the operation, and also a ClusterPowerOnVmResult object.

Returns MoRefTask of type(s) application/json
This response body class contains all of the following: MoRefExtensibleManagedObject
{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}