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 | PUT /vApp/{id} | Modify the name or description of a vApp. | 0.9 | |
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 |