# vm.delete

Delete a VM.

Type: object

##

Type: array
No Additional Items

#### Tuple Validation

##### Parameter 1: id

#### id

Type: integer

ID of the virtual machine to delete.

##### Parameter 2: options

#### options

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

Options controlling the VM deletion process.

No Additional Properties

##

#### Zvols

Type: boolean Default: false

Delete associated ZFS volumes when deleting the VM.

##

#### Force

Type: boolean Default: false

Force deletion even if the VM is currently running.

##

#### Result

Type: boolean

Whether the virtual machine was successfully deleted.

Required roles: VM_WRITE