zfs.resource.encryption.lock ============================ Lock an encryption root that is encrypted with a passphrase. The services and shares using the resource are stopped, then the resource and its descendants are unmounted and the key is unloaded. The former mountpoint is made immutable so nothing can be written in its place while the resource is locked. Example: .. code:: json {"path": "tank/secure", "force_unmount": true} This method is a job. .. raw:: html
Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Lock parameters.

No Additional Properties

Path

Type: string

Path of the encryption root to lock. Only roots encrypted with a passphrase can be locked.

Must be at least 1 characters long

Force Unmount

Type: boolean Default: false

Forcibly unmount the resource and its descendants even if they are busy.

Result

Type: null

Returns null once the resource is locked.



*Required roles:* ZFS_RESOURCE_WRITE