pool.dataset.delete

Delete dataset/zvol id.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string
Parameter 2: options

options

Type: object
No Additional Properties

Recursive

Type: boolean Default: false

Also delete/destroy all children datasets. When root dataset is specified as id with recursive, it will
destroy all the children of the root dataset present leaving root dataset intact.

Force

Type: boolean Default: false

Delete datasets even if they are busy.

Result

Type: enum (of boolean or null)

Return true on successful deletion or null if the zfs destroy command fails with "dataset does not exist".

Must be one of:
  • null
  • true


Required roles: DATASET_DELETE