Attributes
Attribute | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
name | string | No | always | 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 | True if the vApp should be deployed at instantiation. Defaults to true. | ||
powerOn | boolean | No | always | True if the vApp should be powered-on at instantiation. Defaults to true. | ||
transferFormat | string | No |
Elements
Element | Type | Required | Modifiable | Since | Deprecated | Description |
---|---|---|---|---|---|---|
AllEULAsAccepted | boolean | No | always | 0.9 | True confirms acceptance of all EULAs in an OVF. Instantiation fails if this element is missing, empty, or set to false and one or more EulaSection elements are present. | |
Description | string | No | always | Optional description. | ||
InstantiateOvfProperty | InstantiateOvfPropertyType | No | A mapping from OVF properties to instantiation values. | |||
InstantiateVmParams | InstantiateVmParamsType | No | Instantiation parameters for the VMs in the vApp. | |||
InstantiationParams | InstantiationParamsType | No | always | Instantiation parameters for the composed vApp. | ||
NetworkMapping | NetworkMappingType | No | A mapping from an OVF network name to a vCloud network name. Used to update network properties in the OVF. | |||
RemoveNonStandardOvfExtensions | boolean | No | always | 5.9 | If true, remove elements in the uploaded descriptor if they are not defined in the OVF XML namespace (http://schemas.dmtf.org/ovf/envelope/1). Default is false. | |
VAppParent | ReferenceType | No | always | Reserved. Unimplemented. | ||
VCloudExtension | VCloudExtensionType | No | always | 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 /vdc/{id}/action/instantiateOvf | Instantiate a vApp or VM from an OVF | 5.5 |