VMware Cloud Director API - ImportVmAsVAppParams

VMware Cloud Director API - ImportVmAsVAppParams

ImportVmAsVAppParamsType

Element:
ImportVmAsVAppParams
Type:
ImportVmAsVAppParamsType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Parameters to import a virtual machine as a vApp.
Since:
1.0
Schema:
vmwextensions.xsd
Media type(s):
application/vnd.vmware.admin.importVmAsVAppParams+xml
application/vnd.vmware.admin.importVmAsVAppParams+json
Extends:
VAppCreationParamsType
XML Representation:
<ImportVmAsVAppParams xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
        xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" name="xs:string" deploy="xs:boolean" powerOn="xs:boolean" sourceMove="xs:boolean">
    <Description> xs:string </Description>
    <vcloud_v1.5:VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:InstantiationParams>
        <ovf:Section> ovf:Section_Type </ovf:Section>
    </vcloud_v1.5:InstantiationParams>
    <VmName> xs:string </VmName>
    <VAppScopedLocalId> xs:string </VAppScopedLocalId>
    <ComputerName> xs:string </ComputerName>
    <VmMoRef> xs:string </VmMoRef>
    <vcloud_v1.5:VdcStorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:Vdc href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <ImportedDisk instanceId="xs:string" iops="xs:long">
        <vcloud_v1.5:VdcStorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </ImportedDisk>
</ImportVmAsVAppParams>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
name string No always 1.0 Typically used to name or identify the subject of the request. For example, the name of the object being created or modified.
deploy boolean No always 1.0 True if the vApp should be deployed at instantiation. Defaults to true.
powerOn boolean No always 1.0 True if the vApp should be powered-on at instantiation. Defaults to true.
sourceMove boolean No always 1.0 Set to true to delete the source object after the import is complete.

Elements

Element Type Required Modifiable Since Deprecated Description
ComputerName string No always 1.0 Computer name to be used for imported VM.
Description string No always 1.0 Optional description.
ImportedDisk ImportedDiskType No always 5.6 Represents a disk of the VM in order to specify per-disk Storage Profile.
InstantiationParams InstantiationParamsType No always 1.0 Instantiation parameters for the composed vApp.
VAppParent ReferenceType No always 1.0 Reserved. Unimplemented.
VAppScopedLocalId string No always 1.0 vApp scoped local id to be used for imported VM.
VCloudExtension VCloudExtensionType No always 1.0 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.
Vdc ReferenceType Yes always 1.0 Target vDC for imported VM.
VdcStorageProfile ReferenceType No always 5.1 Reference to a vDC storage profile for imported VM.
VmMoRef string Yes always 1.0 Managed object reference of VM to import.
VmName string No always 1.0 Name to be used for imported VM.

Operations

CRUD Operation Description Since Deprecated
as input POST /admin/extension/vimServer/{id}/importVmAsVApp Import a virtual machine from vCenter as a vCloud Director vApp. 1.0