VApp

Element:

VApp

Type:

VAppType

Namespace:

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

Description:

Represents a vApp.

Since:

0.9

Schema:

vApp.xsd

Media type(s):

application/vnd.vmware.vcloud.vApp+xml

Extends:

AbstractVAppType

XML Representation:

<VApp xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:ovf="http://schemas.dmtf.org/ovf/envelope/1"
        xmlns:environment_1="http://schemas.dmtf.org/ovf/environment/1" href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
        status="xs:int" deployed="xs:boolean" ovfDescriptorUploaded="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>
    <VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
    <ovf:Section> ovf:Section_Type </ovf:Section>
    <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>
    <InMaintenanceMode> xs:boolean </InMaintenanceMode>
    <Children>
        <VApp> VAppType </VApp>
        <Vm href="xs:anyURI" type="xs:string" name="xs:string" id="xs:string"
                status="xs:int" deployed="xs:boolean" needsCustomization="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>
            <VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
            <ovf:Section> ovf:Section_Type </ovf:Section>
            <VAppScopedLocalId> xs:string </VAppScopedLocalId>
            <environment_1:Environment> environment_1:Environment_Type </environment_1:Environment>
        </Vm>
    </Children>
</VApp>

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.
deployed	boolean	No	none	1.0	Flag indicates if the vApp or VM is deployed.
ovfDescriptorUploaded	boolean	No	none	0.9	Read-only indicator that the OVF descriptor has been uploaded.

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.
VAppParent	ReferenceType	0..1	none	0.9	Reserved. Unimplemented.
Section	Section_Type	0..*		0.9	Base elements for OVF sections. This is the head of the substitution group.
Owner	OwnerType	0..1	none	0.9	vApp owner.
InMaintenanceMode	boolean	0..1		0.9	True if this vApp is in maintenance mode. Prevents users from changing vApp metadata.
Children	VAppChildrenType	0..1	none	0.9	Shows VM children of a vApp.

Operations

CRUD	Operation	Description	Since
as output	POST /admin/extension/vimServer/{id}/importVmAsVApp	Imports a vSphere server VM as vApp.	1.0
as output	POST /vdc/{id}/action/cloneVApp	Clones a vApp into new one.	0.9
as output	POST /vdc/{id}/action/composeVApp	Composes a new vApp using VMs from other vApps or vApp templates.	0.9
as output	POST /vdc/{id}/action/instantiateVAppTemplate	Instantiate a vApp template into a new vApp.	0.9