vm.start

Start a VM.

options.overcommit defaults to false, meaning VMs are not allowed to start if there is not enough available memory to hold all configured VMs. If true, VM starts even if there is not enough memory for all configured VMs.

Error codes:

ENOMEM(12): not enough free memory to run the VM without overcommit

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the virtual machine to start.
Parameter 2: options

options

Type: object Default: {"overcommit": false}

Options controlling the VM start process.

 No Additional Properties

Overcommit

Type: boolean Default: false

Whether to allow memory overcommitment when starting the VM.

Result

Type: null

Returns null on successful VM start initiation.


Required roles: VM_WRITE