Attributes
Attribute | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
name | string | No | always | 1.0 | Typically used to name or identify the subject of the request. For example, the name of the object being created or modified. | |
deploy | boolean | No | always | 1.0 | True if the vApp should be deployed at instantiation. Defaults to true. | |
powerOn | boolean | No | always | 1.0 | True if the vApp should be powered-on at instantiation. Defaults to true. | |
linkedClone | boolean | No | always | 1.0 | Reserved. Unimplemented. |
Elements
Element | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
AllEULAsAccepted | boolean | No | always | 0.9 | True confirms acceptance of all EULAs in a vApp template. Instantiation fails if this element is missing, empty, or set to false and one or more EulaSection elements are present. | |
CreateItem | VmType | No | none | 30.0 | Read-only information about a VM added during vApp composition or recomposition. | |
DeleteItem | ReferenceType | No | always | 1.0 | Reference to a Vm to be deleted during recomposition. | |
Description | string | No | always | 1.0 | Optional description. | |
InstantiationParams | InstantiationParamsType | No | always | 1.0 | Instantiation parameters for the composed vApp. | |
ReconfigureItem | VmType | No | always | 5.7 | Existing Vm to be reconfigured during recomposition. | |
SourcedItem | SourcedCompositionItemParamType | No | always | 1.0 |
Composition item. One of: vApp vAppTemplate Vm Vms must be powered off and cannot have an independent disk attached. |
|
VAppParent | ReferenceType | No | always | 1.0 | Reserved. Unimplemented. | |
VCloudExtension | VCloudExtensionType | No | always | 1.0 | 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 | POST /vApp/{id}/action/recomposeVApp | Recompose a vApp to add or remove VMs. | 1.0 |