VMware Cloud Director API - TenantMigrationParams

VMware Cloud Director API - TenantMigrationParams

TenantMigrationParamsType

Element:

TenantMigrationParams

Type:

TenantMigrationParamsType

Namespace:

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

Description:

Represents parameters for moving tenant entities.

Since:

29.0

Schema:

vmwextensions.xsd

Media type(s):

application/vnd.vmware.cloud.tenantMigrationParams+json
application/vnd.vmware.cloud.tenantMigrationParams+xml

Extends:

XML Representation:

<TenantMigrationParams xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" name="xs:string">
    <Description> xs:string </Description>
    <vcloud_v1.5:orgs href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <vcloud_v1.5:Org href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </vcloud_v1.5:orgs>
    <sourceDatastores href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <vcloud_v1.5:Datastore href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </sourceDatastores>
    <targetDatastores href="xs:anyURI" type="xs:string">
        <vcloud_v1.5:Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string" model="xs:string"/>
        <vcloud_v1.5:Datastore href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </targetDatastores>
    <migrateEntireVmIfAnyComponentOnSourceDs> xs:boolean </migrateEntireVmIfAnyComponentOnSourceDs>
</TenantMigrationParams>

Attributes

Attribute	Type	Required	Modifiable	Since	Deprecated	Description
name	string	No	always	29.0		Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.

Elements

Element	Type	Required	Modifiable	Since	Deprecated	Description
Description	string	No	always	29.0		Optional description.
VCloudExtension	VCloudExtensionType	No	always	29.0		An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
migrateEntireVmIfAnyComponentOnSourceDs	boolean	No	always	38.0		If true, migrates entire VM if any component of the VM is on one of the source storage container. Defaults to false. Example: Given a VM with two disks, disk1 on a source datastore, and disk2 on a different datastore. Setting this to true will result in the whole VM being migrated. Setting it to false will result in only disk1 being migrated.
orgs	OrgsType	No	always	29.0		List of organizations to be migrated in this operation
sourceDatastores	DatastoresType	No	always	29.0		List of datastores from which organization storage resources should be migrated
targetDatastores	DatastoresType	No	always	29.0		List of datastores to which organization storage resources should be migrated

Operations

CRUD	Operation	Description	Since	Deprecated
as input	POST /admin/extension/action/migrateTenant	Initiate relocation of all entities for a given org (tenant).	29.0