zfs.resource.snapshot.rename ============================ Rename a ZFS snapshot. The new name must stay on the same dataset. .. warning:: No check is made whether the snapshot is in use. Replication, snapshot tasks and anything else that finds snapshots by name may break when one is renamed. Proceed only if you are certain the snapshot is not in use. A validation error is raised when: - ``force`` is not set (``EINVAL``) - ``current_name`` or ``new_name`` is not a snapshot path, or ``new_name`` is on a different dataset (``EINVAL``) - the snapshot does not exist (``ENOENT``) - ``new_name`` already exists (``EEXIST``) - either name is a protected path (``EACCES``) Examples: Rename a single snapshot: .. code:: json {"current_name": "tank/data@old", "new_name": "tank/data@new", "force": true} Rename matching snapshots in child datasets: .. code:: json {"current_name": "tank@old", "new_name": "tank@new", "recursive": true, "force": true} .. raw:: html
Rename parameters for renaming ZFS snapshots.
No Additional PropertiesCurrent snapshot path (e.g., 'pool/dataset@old_name').
Must be at least 1 characters long
New snapshot path (e.g., 'pool/dataset@new_name').
Must be at least 1 characters long
Recursively rename matching snapshots in child datasets.