zfs.resource.snapshot.release ============================= Release hold(s) from a ZFS snapshot. Args: data: Release parameters containing: - path: Snapshot path to release holds from (e.g., 'pool/dataset@snapshot'). - tag: Specific hold tag to release. If None, releases all holds. - recursive: Release holds from matching snapshots in child datasets. Returns: None on success. Raises: ValidationError: If snapshot not found or release fails. Examples: # Release a specific hold release({"path": "tank/data@backup", "tag": "replication"}) # Release all holds from a snapshot release({"path": "tank/data@backup"}) # Release holds recursively release({"path": "tank@backup", "tag": "backup", "recursive": True}) .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Release parameters for releasing holds on ZFS snapshots.

 No Additional Properties

Path

Type: string

Snapshot path to release holds from (e.g., 'pool/dataset@snapshot').

Must be at least 1 characters long

Tag

Default: null

Specific tag to release. If None, releases all hold tags.

Type: string
Type: null

Recursive

Type: boolean Default: false

Release holds recursively from matching snapshots in child datasets.

Result

Type: null


*Required roles:* SNAPSHOT_WRITE