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. | |
ovfDescriptorUploaded | boolean | No | none | 0.9 | True if the OVF descriptor for this template has been uploaded. | |
goldMaster | boolean | No | always | 1.5 | True if this template is a gold master. |
Elements
Element | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
Children | VAppTemplateChildrenType | No | none | 0.9 | Container for virtual machines included in this vApp template. | |
DateCreated | dateTime | No | none | 5.1 | Creation date/time of the template. | |
DefaultStorageProfile | string | No | always | 5.1 | The name of the storage profile to be used for this object. The named storage profile must exist in the organization vDC that contains the object. If not specified, the default storage profile for the vDC is used. | |
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. | |
Link | LinkType | No | none | 0.9 | A reference to an entity or operation associated with this object. | |
Owner | OwnerType | No | none | 0.9 | vAppTemplate owner. | |
Section | Section_Type | No | 0.9 | OVF sections included in this template. | ||
Tasks | TasksInProgressType | No | none | 0.9 | A list of queued, running, or recently completed tasks associated with this entity. | |
VAppScopedLocalId | string | No | always | 1.0 | A unique identifier for the Vm in the scope of the vApp template. | |
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. |
Operations
CRUD | Operation | Description | Since | Deprecated |
---|---|---|---|---|
as input | PUT /vAppTemplate/{id} | Update the name, description and gold master of a vApp template. | 0.9 | |
as output | POST /admin/extension/vimServer/{id}/importVmAsVAppTemplate | Import a virtual machine from vCenter as a vCloud Director vApp template. | 1.0 | |
as output | POST /vdc/{id}/action/captureVApp | Create a vApp template from a vApp. | 0.9 | Since 5.5 |
as output | POST /vdc/{id}/action/cloneVAppTemplate | Create a copy of a vApp template. | 0.9 | |
as output | POST /vdc/{id}/action/uploadVAppTemplate | Upload an OVF package to create a vApp template | 0.9 | Since 5.5 |