zfs.resource.promote

Promote a cloned ZFS resource so that it no longer depends on the snapshot it was cloned from.

The origin snapshot and every snapshot older than it move to the promoted resource, which makes the resource it was cloned from the dependent one instead. This is how a clone is made destroyable independently of its origin.

A validation error is raised when the resource does not exist (ENOENT), is not a clone (EINVAL) or is a protected path (EACCES).

Example:

{"path": "tank/clone"}

Type: object

Call parameters

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Promote parameters for promoting a ZFS clone.

No Additional Properties

path Required

Path

Type: string

Path of the cloned zfs resource to be promoted.

Must be at least 1 characters long

Return value

Result

Type: null

Required roles: ZFS_RESOURCE_WRITE