VMware Cloud Director API - UndeployVAppParams
UndeployVAppParamsType
- Element:
- UndeployVAppParams
- Type:
- UndeployVAppParamsType
- Namespace:
- http://www.vmware.com/vcloud/v1.5
- Description:
- Parameters to an undeploy vApp request.
- Since:
- 0.9
- Schema:
- vApp.xsd
- Media type(s):
-
application/vnd.vmware.vcloud.undeployVAppParams+xml
application/vnd.vmware.vcloud.undeployVAppParams+json
- Extends:
- VCloudExtensibleType
- XML Representation:
-
<UndeployVAppParams xmlns="http://www.vmware.com/vcloud/v1.5">
<UndeployPowerAction> xs:string </UndeployPowerAction>
</UndeployVAppParams>
-
Elements
-
Element Type Required Modifiable Since Deprecated Description UndeployPowerAction string No always 1.5 The specified action is applied to all virtual machines in the vApp. All values other than default ignore actions, order, and delay specified in the StartupSection. One of:
powerOff (Power off the virtual machines. This is the default action if this attribute is missing or empty)
suspend (Suspend the virtual machines)
shutdown (Shut down the virtual machines)
force (Attempt to power off the virtual machines. Failures in undeploying the virtual machine or associated networks are ignored. All references to the vApp and its virtual machines are removed from the database)
default (Use the actions, order, and delay specified in the StartupSection).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 POST /vApp/{id}/action/undeploy Undeploy a vApp/VM. 0.9