zfs.resource.snapshot.rollback

Rollback a ZFS dataset to a snapshot.

WARNING: This is a destructive change. All data written since the target snapshot was taken will be discarded.

Args: data: Rollback parameters containing: - path: Snapshot path to rollback to (e.g., ‘pool/dataset@snapshot’). - recursive: Destroy any snapshots and bookmarks more recent than the one specified. - recursive_clones: Like recursive, but also destroy any clones. - force: Force unmount of any clones. - recursive_rollback: Do a complete recursive rollback of each child snapshot.

Returns: None on success.

Raises: ValidationError: If snapshot not found or rollback fails.

Examples: # Basic rollback rollback({“path”: “tank/data@backup”})

# Rollback destroying more recent snapshots rollback({“path”: “tank/data@backup”, “recursive”: True})

# Rollback all child datasets rollback({“path”: “tank@backup”, “recursive_rollback”: True})

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Rollback parameters for rolling back to ZFS snapshots.

No Additional Properties

path Required

Path

Type: string

Snapshot path to rollback to (e.g., 'pool/dataset@snapshot').

Must be at least 1 characters long

recursive

Recursive

Type: boolean Default: false

Destroy any snapshots and bookmarks more recent than the one specified.

recursive_clones

Recursive Clones

Type: boolean Default: false

Like recursive, but also destroy any clones.

force

Force

Type: boolean Default: false

Force unmount of any clones.

recursive_rollback

Recursive Rollback

Type: boolean Default: false

Do a complete recursive rollback of each child snapshot. Fails if any child lacks the snapshot.

Return value

Result

Type: null

Required roles: SNAPSHOT_WRITE