Classes / VM / start.html

Start the specified VM. This function can only be called with the VM is in the Halted State.

Parameters
name type description
session_id session valid session reference
vm VM The VM to start
start_paused bool Instantiate VM in paused state if set to true.
force bool Attempt to force the VM to start. If this flag is false then the VM may fail pre-boot safety checks (e.g. if the CPU the VM last booted 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.
VM_HVM_REQUIRED vm HVM is required for this operation
VM_IS_TEMPLATE vm The operation attempted is not valid for a template VM
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.
BOOTLOADER_FAILED vm, msg The bootloader returned an error
UNKNOWN_BOOTLOADER vm, bootloader The requested bootloader is unknown
NO_HOSTS_AVAILABLE There were no hosts available to complete the specified operation.
LICENCE_RESTRICTION This operation is not allowed under your license. Please contact your support representative.