VAppTemplate

Element:
VAppTemplate
Type:
VAppTemplateType
Namespace:
http://www.vmware.com/vcloud/v1.5
Description:
Represents a vApp template.
Since:
0.9
Schema:
vAppTemplate.xsd
Media type(s):
application/vnd.vmware.vcloud.vAppTemplate+xml
Extends:
ResourceEntityType
XML Representation:
<VAppTemplate xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1" href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
        status="xs:int" ovfDescriptorUploaded="xs:boolean" goldMaster="xs:boolean">
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string"/>
    <Description> xs:string </Description>
    <Tasks>
        <Task href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
                endTime="xs:dateTime" expiryTime="xs:dateTime">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                    stackTrace="xs:string"/>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
        </Task>
    </Tasks>
    <Files>
        <File href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                size="xs:long" bytesTransferred="xs:long" checksum="xs:normalizedString">
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string"/>
            <Description> xs:string </Description>
            <Tasks>
                <Task href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                        status="xs:string" operation="xs:string" operationName="xs:string" startTime="xs:dateTime"
                        endTime="xs:dateTime" expiryTime="xs:dateTime">
                    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                            rel="xs:string"/>
                    <Description> xs:string </Description>
                    <Tasks> TasksInProgressType </Tasks>
                    <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Error message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"
                            stackTrace="xs:string"/>
                    <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
                    <Progress> xs:int </Progress>
                    <Params> ... </Params>
                </Task>
            </Tasks>
        </File>
    </Files>
    <Owner href="xs:anyURI" type="xs:string">
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string"/>
        <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    </Owner>
    <Children>
        <Vm> VAppTemplateType </Vm>
    </Children>
    <ovf:Section> ovf:Section_Type </ovf:Section>
    <VAppScopedLocalId> xs:string </VAppScopedLocalId>
</VAppTemplate>

Attributes

Attribute Type Required Modifiable Since Description
href anyURI No always 0.9 Contains the URI to the entity.
type string No always 0.9 Contains the type of the entity.
name string Yes always 0.9 The name of the entity.
id string No none 0.9 The entity identifier, expressed in URN format. The value of this attribute uniquely identifies the entity, persists for the life of the entity, and is never reused.
status int No none 0.9 Creation status of the resource entity.
ovfDescriptorUploaded boolean No none 0.9 Read only flag to indicate that the ovf descriptor is uploaded.
goldMaster boolean No always 1.5 Attribute to specify if template is gold master, the default is false.

Elements

Element Type Occurrence Modifiable Since Description
VCloudExtension VCloudExtensionType 0..* always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes.
Link LinkType 0..* none 0.9 Optional link to an entity or operation associated with this object.
Description string 0..1 always 0.9 Optional description.
Tasks TasksInProgressType 0..1 none 0.9 A list of queued, running, or recently completed tasks associated with this entity.
Files FilesListType 0..1 none 0.9 Represents a list of files to be transferred (uploaded or downloaded). Each File in the list is part of the ResourceEntity.
Owner OwnerType 0..1 none 0.9 vAppTemplate owner.
Children VAppTemplateChildrenType 0..1 none 0.9 Contains VMs which are in this vApp template.
Section Section_Type 0..* 0.9 Base elements for OVF sections. This is the head of the substitution group.
VAppScopedLocalId string 0..1 always 1.0 The vApp template scoped local ID.

Operations

CRUD Operation Description Since
as input PUT /vAppTemplate/{id} Modifies only the name/description of a vApp template. 0.9
as output POST /admin/extension/vimServer/{id}/importVmAsVAppTemplate Imports a vSphere server VM as vApp template. 1.0
as output POST /vdc/{id}/action/captureVApp Captures a vApp into vApp template. 0.9
as output POST /vdc/{id}/action/cloneVAppTemplate Clones a vApp template into new one. 0.9
as output POST /vdc/{id}/action/uploadVAppTemplate Uploading vApp template to a vDC. 0.9