pool.dataset.rename

Rename a pool dataset id.

No safety checks are performed when renaming ZFS resources. If the dataset is in use by services such as SMB, iSCSI, snapshot tasks, replication, or cloud sync, renaming may cause disruptions or service failures.

Proceed only if you are certain the ZFS resource is not in use and fully understand the risks. Set Force to continue.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: id

id

Type: string

Must be at least 1 characters long

Parameter 2: data

data

Type: object
No Additional Properties

New Name

Type: string

Must be at least 1 characters long

Recursive

Type: boolean Default: false

Force

Type: boolean Default: false

This operation does not check whether the dataset is currently in use. Renaming an active dataset may disrupt
SMB shares, iSCSI targets, snapshots, replication, and other services.

Set Force only if you understand and accept the risks.

Result

Type: null


Required roles: DATASET_WRITE