Virtual App Power Off V App Task
Stops this vApp.
The virtual machines (or child vApps) will be stopped in the order specified in the vApp configuration, if force is false. If force is set to true, all virtual machines are powered-off (in no specific order and possibly in parallel) regardless of the vApp auto-start configuration.
While a vApp is stopping, all power operations performed on sub entities are disabled through the VIM API. They will throw TaskInProgress.
Required privileges: VApp.PowerOff
The unique identifier for the managed object to which the method attaches; the serialized managed object reference for a request has the form moType/moId, in this case VirtualApp/{moId}.
The vSphere release schema. The current specification covers vSphere 8.0.3.0 APIs.
{
"force": false
}If force is false, the shutdown order in the vApp is executed. If force is true, all virtual machines are powered-off (regardless of shutdown order).
OK
{
"_typeName": "string",
"type": "string",
"value": "string"
}InvalidPowerState: if the vApp is not running
TaskInProgress: if the vApp is busy.
InvalidState: if the operation cannot be performed because of the vApp's current state. For example, if the vApp is in the process of being started.
MissingPowerOffConfiguration: if no vApp powerOff configuration has been specified.
{
"_typeName": "string",
"faultCause": "MethodFault Object",
"faultMessage": [
{
"_typeName": "string",
"key": "string",
"arg": [
{
"_typeName": "string",
"key": "string",
"value": {
"_typeName": "string"
}
}
],
"message": "string"
}
]
}