zfs.resource.snapshot.holds

Get holds on a ZFS snapshot.

Args: data: Query parameters containing: - path: Snapshot path to query (e.g., ‘pool/dataset@snapshot’).

Returns: List of hold tag names on the snapshot.

Examples: holds({“path”: “tank/data@backup”}) # Returns: [“truenas”, “replication”]

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Query parameters for getting holds on a ZFS snapshot.

No Additional Properties

path Required

Path

Type: string

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

Must be at least 1 characters long

Return value

Result

Type: array of string

List of hold tag names on the snapshot.

No Additional Items

Each item of this array must be:

Type: string

Required roles: SNAPSHOT_READ