vm.device.delete

Delete a VM device of id.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: integer

ID of the VM device to delete.
Parameter 2: options

options

Type: object
Default:
{ "force": false, "raw_file": false, "zvol": false }

Options controlling the device deletion process.

 No Additional Properties

Force

Type: boolean Default: false

Force deletion even if the device is in use.

Raw File

Type: boolean Default: false

Delete the underlying raw disk file when removing the device.

Zvol

Type: boolean Default: false

Delete the underlying ZFS volume when removing the device.

Result

Type: boolean

Whether the VM device was successfully deleted.


Required roles: VM_DEVICE_WRITE