pool.dataset.destroy_snapshots

Destroy specified snapshots of a given dataset.

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

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: name

name

Type: string

Parameter 2: snapshots

snapshots

Type: object
No Additional Properties

all

All

Type: boolean Default: false

recursive

Recursive

Type: boolean Default: false

snapshots

Snapshots

Type: array Default: []
No Additional Items

Each item of this array must be:

Any of

• PoolDatasetDestroySnapshotsArgsSnapshotSpec
• Option 2

PoolDatasetDestroySnapshotsArgsSnapshotSpec

Type: object
No Additional Properties

start

Start

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

end

End

Default: null

Any of

• Option 1
• Option 2

Type: string

Type: null

Type: string

Return value

Result

Type: array of string
No Additional Items

Each item of this array must be:

Type: string

Required roles: SNAPSHOT_WRITE