Attempt to cleanly shutdown the specified VM. (Note: this may not be supported---e.g. if a guest agent is not installed). This can only be called when the specified VM is in the Running state.
| Parameters | ||
| name | type | description |
| session_id | session | valid session reference |
| vm | VM | The VM to shutdown |
| Errors | ||
| name | arguments | description |
| VM_BAD_POWER_STATE | vm, expected, actual | You attempted an operation on a VM that was not in an appropriate power state at the time; for example, you attempted to start a VM that was already running. The parameters returned are the VM's handle, and the expected and actual VM state at the time of the call. |
| OTHER_OPERATION_IN_PROGRESS | class, object | Another operation involving the object is currently in progress |
| OPERATION_NOT_ALLOWED | reason | You attempted an operation that was not allowed. |
| VM_IS_TEMPLATE | vm | The operation attempted is not valid for a template VM |
- Message has both a synchronous and asynchronous version
- This is a custom message