VMware Cloud Director API - VApp
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):
-
application/vnd.vmware.vcloud.vApp+xml
application/vnd.vmware.vcloud.vApp+json
- 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" id="xs:string" operationKey="xs:string"
name="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" model="xs:string"/>
<Description> xs:string </Description>
<Tasks>
<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">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<Tasks> TasksInProgressType </Tasks>
<Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</Error>
<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>
<Details> xs:string </Details>
<VcTaskList>
<VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
</VcTaskList>
<Result>
<ResultContent> ... </ResultContent>
<ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Result>
</Task>
</Tasks>
<Files>
<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">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<Tasks>
<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">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<Tasks> TasksInProgressType </Tasks>
<Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</Error>
<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>
<Details> xs:string </Details>
<VcTaskList>
<VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
</VcTaskList>
<Result>
<ResultContent> ... </ResultContent>
<ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Result>
</Task>
</Tasks>
</File>
</Files>
<VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<ovf:Section> ovf:Section_Type </ovf:Section>
<DateCreated> xs:dateTime </DateCreated>
<Owner href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<User href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Owner>
<autoNature> xs:boolean </autoNature>
<InMaintenanceMode> xs:boolean </InMaintenanceMode>
<Children>
<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" encrypted="xs:boolean"
needsCustomization="xs:boolean" nestedHypervisorEnabled="xs:boolean">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<Tasks>
<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">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<Tasks> TasksInProgressType </Tasks>
<Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</Error>
<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>
<Details> xs:string </Details>
<VcTaskList>
<VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
</VcTaskList>
<Result>
<ResultContent> ... </ResultContent>
<ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Result>
</Task>
</Tasks>
<Files>
<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">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<Tasks>
<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">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<Description> xs:string </Description>
<Tasks> TasksInProgressType </Tasks>
<Owner href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<Error stackTrace="xs:string" message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string"
vendorSpecificErrorCode="xs:string">
<TenantError message="xs:string" majorErrorCode="xs:int" minorErrorCode="xs:string" vendorSpecificErrorCode="xs:string"/>
</Error>
<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>
<Details> xs:string </Details>
<VcTaskList>
<VcTask name="xs:string" moref="xs:string" status="xs:string" description="xs:string"
errorMessage="xs:string" objectName="xs:string" objectType="xs:string" objectMoref="xs:string"
virtualCenterID="xs:string" startTime="xs:dateTime" endTime="xs:dateTime"/>
</VcTaskList>
<Result>
<ResultContent> ... </ResultContent>
<ResultReference href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</Result>
</Task>
</Tasks>
</File>
</Files>
<VAppParent href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<ovf:Section> ovf:Section_Type </ovf: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">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<MemoryHotAddEnabled> xs:boolean </MemoryHotAddEnabled>
<CpuHotAddEnabled> xs:boolean </CpuHotAddEnabled>
</VmCapabilities>
<StorageProfile href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<VdcComputePolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<ComputePolicy href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<VmPlacementPolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<VmPlacementPolicyFinal> xs:boolean </VmPlacementPolicyFinal>
<VmSizingPolicy href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
<VmSizingPolicyFinal> xs:boolean </VmSizingPolicyFinal>
</ComputePolicy>
<ComputePolicyCompliance href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<LastComplianceCheckTime> xs:dateTime </LastComplianceCheckTime>
<PolicyName> xs:string </PolicyName>
<NonComplianceMessage> xs:string </NonComplianceMessage>
</ComputePolicyCompliance>
<IsComputePolicyCompliant> xs:boolean </IsComputePolicyCompliant>
<BootOptions href="xs:anyURI" type="xs:string">
<Link href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"
rel="xs:string" model="xs:string"/>
<BootDelay> xs:long </BootDelay>
<EnterBIOSSetup> xs:boolean </EnterBIOSSetup>
<BootRetryEnabled> xs:boolean </BootRetryEnabled>
<BootRetryDelay> xs:long </BootRetryDelay>
<EfiSecureBootEnabled> xs:boolean </EfiSecureBootEnabled>
<NetworkBootProtocol> xs:string </NetworkBootProtocol>
</BootOptions>
<Media href="xs:anyURI" id="xs:string" type="xs:string" name="xs:string"/>
</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. autoNature boolean No none 22.0 True if this vApp is automatically created by vCD when a new VM is discovered in a vCenter Resource Pool attached to an Organization VDC. -
Operations
-
CRUD Operation Description Since Deprecated as input POST /vApp/{id}/action/convertStandAloneVmToVApp Convert a stand alone VM into a single VM VApp. 35.0 as output POST /admin/extension/vimServer/{id}/importVmAsVApp Import a virtual machine from vCenter as a vCloud Director vApp. 1.0 as output POST /vdc/{id}/action/cloneVApp Create a copy of a vApp. 0.9 as output POST /vdc/{id}/action/composeVApp Compose a vApp from existing virtual machines. 0.9 as output POST /vdc/{id}/action/instantiateOvf Instantiate a vApp or VM from an OVF 5.5 as output POST /vdc/{id}/action/instantiateVAppTemplate Create a vApp from a vApp template 0.9