zfs.resource.encryption.export_key

Export the hex key the system stores for an encryption root.

Passphrases are never stored, so they cannot be exported.

This method is a job.

This job CAN produce a file for download. See Downloading a File.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Export key parameters.

No Additional Properties

Path

Type: string

Path of the encryption root whose stored key is exported.

Must be at least 1 characters long

Download

Type: boolean Default: false

Write the key to the output pipe as a JSON file usable with key_file when unlocking, instead of returning it.

Result


The stored key, or null when download is set.

Type: string
Type: null


Required roles: ZFS_RESOURCE_WRITE