Classes / VM / resume_on.html

Awaken the specified VM and resume it on a particular Host. This can only be called when the specified VM is in the Suspended state.

Parameters
name type description
session_id session valid session reference
vm VM The VM to resume
host host The Host on which to resume the VM
start_paused bool Resume VM in paused state if set to true.
force bool Attempt to force the VM to resume. If this flag is false then the VM may fail pre-resume safety checks (e.g. if the CPU the VM was running on looks substantially different to the current one)
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.
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