Virtual Machine Provisioning Checker Check Migrate Task

Tests the feasibility of a proposed MigrateVM_Task operation.

Required privileges: System.View

Request

URI

POST

https://{vcenter-host}/sdk/vim25/{release}/VirtualMachineProvisioningChecker/{moId}/CheckMigrate_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 VirtualMachineProvisioningChecker/{moId}.

string

release

Required

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

Request Body

CheckMigrateRequestType of type(s) application/json

Required

{
    "vm": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "pool": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "state": "string",
    "testType": [
        "string"
    ]
}

MoRefVirtualMachine

Required

Reference to an instance of the VirtualMachine managed object.

MoRefHostSystem

host

Optional

Reference to an instance of the HostSystem managed object.

MoRefResourcePool

pool

Optional

Reference to an instance of the ResourcePool managed object.

VirtualMachinePowerState_enum

state

Optional

The PowerState type defines a simple set of states for a virtual machine: poweredOn, poweredOff, and suspended.

This type does not model substates, such as when a task is running to change the virtual machine state. If the virtual machine is in a state with a task in progress, it transitions to a new state when the task completes. For example, a virtual machine continues to be in the poweredOn state while a suspend task is running, and changes to the suspended state once the task finishes.

As a consequence of this approach, clients interested in monitoring the status of a virtual machine should typically track the activeTask data object in addition to the powerState object.

Possible values:

poweredOff: The virtual machine is currently powered off.
poweredOn: The virtual machine is currently powered on.
suspended: The virtual machine is currently suspended.

Possible values are : poweredOff, poweredOn, suspended,

array of string

testType

Optional

The set of tests to run. If this argument is not set, all tests will be run. See CheckTestTypeEnum for possible values.

Authentication

This operation uses the following authentication methods.

Session

Responses

200

Returns MoRefTask of type(s) application/json

This response body class contains all of the following: MoRefExtensibleManagedObject

{
    "_typeName": "string",
    "type": "string",
    "value": "string"
}

500

InvalidArgument: if the target host(s) and target pool for a migration are not associated with the same compute resource, or if the host parameter is left unset when the target pool is associated with a non-DRS cluster.

InvalidPowerState: if the state argument is set and at least one of the specified virtual machines is not in that power state.

Returns InvalidState of type(s) application/json

This response body class contains all of the following: VimFault

{
    "_typeName": "string",
    "faultCause": "MethodFault Object",
    "faultMessage": [
        {
            "_typeName": "string",
            "key": "string",
            "arg": [
                {
                    "_typeName": "string",
                    "key": "string",
                    "value": {
                        "_typeName": "string"
                    }
                }
            ],
            "message": "string"
        }
    ]
}

On This Page

Description

Request

Path Parameters

Request Body

Authentication

Response

200 Response Body

Errors

Virtual Machine Provisioning Checker Operations

POST

Virtual Machine Provisioning Checker Check Clone Task