pool.dataset.destroy_snapshots

Destroy specified snapshots of a given dataset.

DEPRECATED: this method is scheduled to be removed in v26.04.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: name

name

Type: string

The dataset name to destroy snapshots for.
Parameter 2: snapshots

snapshots

Type: object

Specification of which snapshots to destroy (all, specific ones, or ranges).

 No Additional Properties

All

Type: boolean Default: false

Whether to destroy all snapshots for the dataset.

Recursive

Type: boolean Default: false

Whether to recursively destroy snapshots of child datasets.

Snapshots

Type: array Default: []

Array of specific snapshot names or snapshot range specifications to destroy.

 No Additional Items
Each item of this array must be:

PoolDatasetDestroySnapshotsArgsSnapshotSpec

Type: object
No Additional Properties

Start

Default: null

Starting snapshot name for the range. Null to start from the beginning.

Type: string
Type: null

End

Default: null

Ending snapshot name for the range. Null to continue to the end.

Type: string
Type: null
Type: string

Result

Type: array of string

Array of snapshot names that were successfully destroyed.

 No Additional Items
Each item of this array must be:
Type: string


Required roles: SNAPSHOT_WRITE