pool.dataset.delete =================== Delete dataset/zvol `id`. .. examples(websocket):: Delete "tank/myuser" dataset. :::javascript { "id": "6841f242-840a-11e6-a437-00e04d680384", "msg": "method", "method": "pool.dataset.delete", "params": ["tank/myuser"] } .. raw:: html
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