vm.stop

Stops a VM.

Unless force is set, a suspended VM is resumed and the guest is sent a shutdown request. If the guest is still running after shutdown_timeout seconds, the VM is powered off when force_after_timeout is set, otherwise the job fails and the VM keeps running. Use vm.poweroff to power it off immediately.

This method is a job.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the virtual machine to stop.

Parameter 2: options

options

Type: object
Default:
{ "force": false, "force_after_timeout": false }

Options controlling the VM stop process.

No Additional Properties

Force

Type: boolean Default: false

Whether to force immediate shutdown without graceful shutdown attempt.

Force After Timeout

Type: boolean Default: false

Whether to force shutdown if graceful shutdown times out.

Result

Type: null

Returns null on successful VM stop initiation.



Required roles: VM_WRITE