zfs.resource.snapshot.rename

Rename a ZFS snapshot.

Args: data: Rename parameters containing: - current_name: Current snapshot path (e.g., ‘pool/dataset@old_name’). - new_name: New snapshot path (e.g., ‘pool/dataset@new_name’). - recursive: Recursively rename matching snapshots in child datasets.

Returns: None on success.

Raises: ValidationError: If snapshot not found, new name already exists, or invalid paths.

Examples: # Rename a single snapshot rename({“current_name”: “tank/data@old”, “new_name”: “tank/data@new”})

# Rename recursively (all matching child snapshots) rename({ “current_name”: “tank@old”, “new_name”: “tank@new”, “recursive”: True })

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Rename parameters for renaming ZFS snapshots.

No Additional Properties

current_name Required

Current Name

Type: string

Current snapshot path (e.g., 'pool/dataset@old_name').

Must be at least 1 characters long

new_name Required

New Name

Type: string

New snapshot path (e.g., 'pool/dataset@new_name').

Must be at least 1 characters long

recursive

Recursive

Type: boolean Default: false

Recursively rename matching snapshots in child datasets.

Return value

Result

Type: null

Required roles: SNAPSHOT_WRITE