vm.stop

Stops a VM.

For unresponsive guests who have exceeded the shutdown_timeout defined by the user and have become unresponsive, they required to be powered down using vm.poweroff. vm.stop is only going to send a shutdown signal to the guest and wait the desired shutdown_timeout value before tearing down guest vmemory.

force_after_timeout when supplied, it will initiate poweroff for the VM forcing it to exit if it has not already stopped within the specified shutdown_timeout.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer
Parameter 2: options

options

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

No Additional Properties

Force

Type: boolean Default: false

Force After Timeout

Type: boolean Default: false

Result

Type: null


Required roles: VM_WRITE