MigrateVMRequestType

MigrateVMRequestType
MigrateVMRequestType

The parameters of MigrateVM_Task.

JSON Example
{
    "pool": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "host": {
        "_typeName": "string",
        "type": "string",
        "value": "string"
    },
    "priority": "string",
    "state": "string"
}
pool
Optional

Reference to an instance of the ResourcePool managed object.

host
Optional

Reference to an instance of the HostSystem managed object.

priority
Required

MovePriority is an enumeration of values that indicate the priority of the task that moves a virtual machine from one host to another or one storage location to another.

Note this priority can affect both the source and target hosts.

Possible values:

  • lowPriority: The task of moving this virtual machine is low priority.
  • highPriority: The task of moving this virtual machine is high priority.
  • defaultPriority: The task of moving this virtual machine is the default priority.
Possible values are : lowPriority, highPriority, defaultPriority,
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,