VMware Cloud Director API - ImportVmAsVAppTemplateParams

VMware Cloud Director API - ImportVmAsVAppTemplateParams

ImportVmAsVAppTemplateParamsType

Element:
ImportVmAsVAppTemplateParams
Type:
ImportVmAsVAppTemplateParamsType
Namespace:
http://www.vmware.com/vcloud/extension/v1.5
Description:
Parameters to import a virtual machine as a vApp template.
Since:
1.0
Schema:
vmwextensions.xsd
Media type(s):
application/vnd.vmware.admin.importVmAsVAppTemplateParams+json
application/vnd.vmware.admin.importVmAsVAppTemplateParams+xml
Extends:
ParamsType
XML Representation:
<ImportVmAsVAppTemplateParams xmlns="http://www.vmware.com/vcloud/extension/v1.5" xmlns:vcloud_v1.5="http://www.vmware.com/vcloud/v1.5" name="xs:string" sourceMove="xs:boolean" goldMaster="xs:boolean">
    <Description> xs:string </Description>
    <VmName> xs:string </VmName>
    <VAppScopedLocalId> xs:string </VAppScopedLocalId>
    <ComputerName> xs:string </ComputerName>
    <VmMoRef> xs:string </VmMoRef>
    <vcloud_v1.5:Vdc href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:VdcStorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <vcloud_v1.5:Catalog href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</ImportVmAsVAppTemplateParams>

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.
sourceMove boolean No always 1.0 Set to true to delete the source object after the import is complete.
goldMaster boolean No always 1.5 Attribute to specify if template is gold master, the default is false.

Elements

Element Type Required Modifiable Since Deprecated Description
Catalog ReferenceType No always 1.0 Catalog in which the imported vApp template will be listed. This is optional, but either VDC or catalog must be provided.
ComputerName string No always 1.0 Computer name to be used for imported VM.
Description string No always 1.0 Optional description.
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 No always 1.0 Target vDC for imported vApp template. This is optional. If not provided, catalog's VDC will be picked randomly if catalog is not specifically using a VDC for storage.
VdcStorageProfile ReferenceType No always 5.1 Storage profile to be specified in the vApp template created by this import.
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}/importVmAsVAppTemplate Import a virtual machine from vCenter as a vCloud Director vApp template. 1.0