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. | |
| needsCustomization | boolean | No | none | 0.9 | True if this virtual machine needs customization. | |
| nestedHypervisorEnabled | boolean | No | none | 5.1 | True if hardware-assisted CPU virtualization capabilities in the host should be exposed to the guest operating system. |
Elements
| Element | Type | Required | Modifiable | Since | Deprecated | Description |
|---|---|---|---|---|---|---|
| BootOptions | BootOptionsType | No | always | 21.0 | Boot options for this virtual machine. | |
| DateCreated | dateTime | No | none | 5.1 | Creation date/time of the vApp. | |
| Description | string | No | always | 0.9 | Optional description. | |
| Environment | Environment_Type | No | 0.9 | OVF environment section. | ||
| 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. | |
| Section | Section_Type | No | 0.9 | An OVF Section with additional custom attributes. | ||
| StorageProfile | ReferenceType | No | always | 5.1 | A reference to a storage profile to be used for this object. The specified storage profile must exist in the organization vDC that contains the object. If not specified, the default storage profile for the vDC is used. | |
| 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. | |
| VAppScopedLocalId | string | No | none | 1.0 | A unique identifier for the virtual machine in the scope of the vApp. | |
| 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. | |
| VmCapabilities | VmCapabilitiesType | No | always | 5.1 | Allows you to specify certain capabilities of this virtual machine. |
Operations
| CRUD | Operation | Description | Since | Deprecated |
|---|---|---|---|---|
| as input | PUT /vApp/vm-{id} | Modify the name or description of a VM. | 0.9 | |
| as input | POST /vApp/vm-{id}/action/reconfigureVm | Updates Vm name, Description, and any or all of the following sections.
|
5.1 |