# 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.

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