VMware Cloud Director API - MigrateParams

MigrateParamsType

Element:

MigrateParams

Type:

MigrateParamsType

Namespace:

http://www.vmware.com/vcloud/extension/v1.5

Description:

Parameters that control virtual machine migration.

Since:

5.1

Schema:

vmwextensions.xsd

Media type(s):

application/vnd.vmware.admin.migrateVmParams+xml
application/vnd.vmware.admin.migrateVmParams+json

Extends:

anyType

XML Representation:

<MigrateParams xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5">
    <vcloud_v1.5:VmRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <ResourcePoolRef>
        <vcloud_v1.5:VimServerRef href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
        <MoRef> xs:string </MoRef>
        <VimObjectType> xs:string </VimObjectType>
    </ResourcePoolRef>
    <PinToDatastore> xs:boolean </PinToDatastore>
</MigrateParams>

Elements

Element	Type	Required	Modifiable	Since	Description
PinToDatastore	boolean	No	always	36.3	Whether or not the VM(s) should be pinned to their current datastore(s). This value defaults to true.
ResourcePoolRef	VimObjectRefType (extension/v1.5)	Yes	always	5.1	Vim object reference to a resource pool to which the virtual machine will be migrated. This parameter is optional. If it is not provided, the system will automatically choose a target resource pool and migrate the VMs to it.
VmRef	ReferenceType	Yes	always	5.1	Entity object reference to a virtual machine which will be migrated. At least one Vm should be provided for migrating to the target resource pool.

Operations

CRUD	Operation	Description	Since	Deprecated
as input	POST /admin/extension/resourcePool/{id}/action/migrateVms	Migrate one or more virtual machines to a different resource pool.	5.1