VAppType

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):
None
Extends:
AbstractVAppType
XML Representation:
<VApp xmlns="http://www.vmware.com/vcloud/v1.5" xmlns:envelope_1="http://schemas.dmtf.org/ovf/envelope/1"
        xmlns:environment_1="http://schemas.dmtf.org/ovf/environment/1" href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
        name="xs:string" status="xs:int" deployed="xs:boolean" ovfDescriptorUploaded="xs:boolean">
    <VCloudExtension required="xs:boolean"/>
    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
            rel="xs:string">
        <VCloudExtension required="xs:boolean"/>
    </Link>
    <Description> xs:string </Description>
    <Tasks>
        <VCloudExtension required="xs:boolean"/>
        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                cancelRequested="xs:boolean">
            <VCloudExtension required="xs:boolean"/>
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </Link>
            <Description> xs:string </Description>
            <Tasks> TasksInProgressType </Tasks>
            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </Owner>
            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                    vendorSpecificErrorCode="xs:string">
                <VCloudExtension required="xs:boolean"/>
                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
                    <VCloudExtension required="xs:boolean"/>
                </TenantError>
            </Error>
            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </User>
            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </Organization>
            <Progress> xs:int </Progress>
            <Params> ... </Params>
            <Details> xs:string </Details>
        </Task>
    </Tasks>
    <Files>
        <VCloudExtension required="xs:boolean"/>
        <File href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" size="xs:long" bytesTransferred="xs:long" checksum="xs:normalizedString">
            <VCloudExtension required="xs:boolean"/>
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </Link>
            <Description> xs:string </Description>
            <Tasks>
                <VCloudExtension required="xs:boolean"/>
                <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                        name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                        serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                        cancelRequested="xs:boolean">
                    <VCloudExtension required="xs:boolean"/>
                    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                            rel="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </Link>
                    <Description> xs:string </Description>
                    <Tasks> TasksInProgressType </Tasks>
                    <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </Owner>
                    <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                            vendorSpecificErrorCode="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                        <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
                            <VCloudExtension required="xs:boolean"/>
                        </TenantError>
                    </Error>
                    <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </User>
                    <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </Organization>
                    <Progress> xs:int </Progress>
                    <Params> ... </Params>
                    <Details> xs:string </Details>
                </Task>
            </Tasks>
        </File>
    </Files>
    <VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
        <VCloudExtension required="xs:boolean"/>
    </VAppParent>
    <envelope_1:Section> envelope_1:Section_Type </envelope_1:Section>
    <DateCreated> xs:dateTime </DateCreated>
    <Owner href="xs:anyURI" type="xs:string">
        <VCloudExtension required="xs:boolean"/>
        <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                rel="xs:string">
            <VCloudExtension required="xs:boolean"/>
        </Link>
        <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
            <VCloudExtension required="xs:boolean"/>
        </User>
    </Owner>
    <InMaintenanceMode> xs:boolean </InMaintenanceMode>
    <Children>
        <VCloudExtension required="xs:boolean"/>
        <VApp> VAppType </VApp>
        <Vm href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                name="xs:string" status="xs:int" deployed="xs:boolean" needsCustomization="xs:boolean"
                nestedHypervisorEnabled="xs:boolean">
            <VCloudExtension required="xs:boolean"/>
            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                    rel="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </Link>
            <Description> xs:string </Description>
            <Tasks>
                <VCloudExtension required="xs:boolean"/>
                <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                        name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                        serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                        cancelRequested="xs:boolean">
                    <VCloudExtension required="xs:boolean"/>
                    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                            rel="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </Link>
                    <Description> xs:string </Description>
                    <Tasks> TasksInProgressType </Tasks>
                    <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </Owner>
                    <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                            vendorSpecificErrorCode="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                        <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
                            <VCloudExtension required="xs:boolean"/>
                        </TenantError>
                    </Error>
                    <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </User>
                    <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </Organization>
                    <Progress> xs:int </Progress>
                    <Params> ... </Params>
                    <Details> xs:string </Details>
                </Task>
            </Tasks>
            <Files>
                <VCloudExtension required="xs:boolean"/>
                <File href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                        name="xs:string" size="xs:long" bytesTransferred="xs:long" checksum="xs:normalizedString">
                    <VCloudExtension required="xs:boolean"/>
                    <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                            rel="xs:string">
                        <VCloudExtension required="xs:boolean"/>
                    </Link>
                    <Description> xs:string </Description>
                    <Tasks>
                        <VCloudExtension required="xs:boolean"/>
                        <Task href="xs:anyURI" type="xs:string" id="xs:string" operationKey="xs:string"
                                name="xs:string" status="xs:string" operation="xs:string" operationName="xs:string"
                                serviceNamespace="xs:string" startTime="xs:dateTime" endTime="xs:dateTime" expiryTime="xs:dateTime"
                                cancelRequested="xs:boolean">
                            <VCloudExtension required="xs:boolean"/>
                            <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                                    rel="xs:string">
                                <VCloudExtension required="xs:boolean"/>
                            </Link>
                            <Description> xs:string </Description>
                            <Tasks> TasksInProgressType </Tasks>
                            <Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                                <VCloudExtension required="xs:boolean"/>
                            </Owner>
                            <Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
                                    vendorSpecificErrorCode="xs:string">
                                <VCloudExtension required="xs:boolean"/>
                                <TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string">
                                    <VCloudExtension required="xs:boolean"/>
                                </TenantError>
                            </Error>
                            <User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                                <VCloudExtension required="xs:boolean"/>
                            </User>
                            <Organization href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                                <VCloudExtension required="xs:boolean"/>
                            </Organization>
                            <Progress> xs:int </Progress>
                            <Params> ... </Params>
                            <Details> xs:string </Details>
                        </Task>
                    </Tasks>
                </File>
            </Files>
            <VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </VAppParent>
            <envelope_1:Section> envelope_1:Section_Type </envelope_1:Section>
            <DateCreated> xs:dateTime </DateCreated>
            <VAppScopedLocalId> xs:string </VAppScopedLocalId>
            <environment_1:Environment> environment_1:Environment_Type </environment_1:Environment>
            <VmCapabilities href="xs:anyURI" type="xs:string">
                <VCloudExtension required="xs:boolean"/>
                <Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
                        rel="xs:string">
                    <VCloudExtension required="xs:boolean"/>
                </Link>
                <MemoryHotAddEnabled> xs:boolean </MemoryHotAddEnabled>
                <CpuHotAddEnabled> xs:boolean </CpuHotAddEnabled>
            </VmCapabilities>
            <StorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string">
                <VCloudExtension required="xs:boolean"/>
            </StorageProfile>
        </Vm>
    </Children>
</VApp>

Attributes

Attribute Type Required Modifiable Since Deprecated Description
href anyURI No always 0.9 The URI of the entity.
type string No always 0.9 The MIME type 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.
operationKey string No create 5.1 Optional unique identifier to support idempotent semantics for create and delete operations.
name string Yes always 0.9 The name of the entity.
status int No none 0.9 Creation status of the resource entity.
deployed boolean No none 1.0 True if the virtual machine is deployed.
ovfDescriptorUploaded boolean No none 0.9 Read-only indicator that the OVF descriptor for this vApp has been uploaded.

Elements

Element Type Required Modifiable Since Deprecated Description
Children VAppChildrenType No none 0.9 Container for virtual machines included in this vApp.
DateCreated dateTime No none 5.1 Creation date/time of the vApp.
Description string No always 0.9 Optional description.
Files FilesListType No none 0.9 Represents a list of files to be transferred (uploaded or downloaded). Each File in the list is part of the ResourceEntity.
InMaintenanceMode boolean No 0.9 True if this vApp is in maintenance mode. Prevents users from changing vApp metadata.
Link LinkType No none 0.9 A reference to an entity or operation associated with this object.
Owner OwnerType No none 0.9 vApp owner.
Section Section_Type No 0.9 An OVF Section with additional custom attributes.
Tasks TasksInProgressType No none 0.9 A list of queued, running, or recently completed tasks associated with this entity.
VAppParent ReferenceType No none 0.9 Reserved. Unimplemented.
VCloudExtension VCloudExtensionType No always 0.9 An optional extension element that can contain an arbitrary number of elements and attributes. Not related to extension services.

Top of page Attributes Elements    
Home
Frames
User
Operations Elements Types Queries
Admin
Operations Elements Types Queries
Extension
Operations Elements Types Queries
All
Operations Elements Types Queries