zfs.resource.encryption.unlock_summary

Report, for every encryption root at or below path, whether an unlock with the given keys would succeed.

Keys and passphrases are supplied as for zfs.resource.encryption.unlock and are only checked; nothing is unlocked. unlock_successful accounts for a locked parent and for something already present at the mount path, and is always set for an encryption root that is already unlocked.

This method is a job.

This job CAN be used with file upload. See Uploading a File.

Type: object

Type: array
No Additional Items

Tuple Validation

Parameter 1: data

data

Type: object

Unlock summary parameters.

No Additional Properties

Path

Type: string

Path whose encryption roots, including itself, are summarized.

Must be at least 1 characters long

Force

Type: boolean Default: false

Assume an occupied mount path would be renamed, as force does for an unlock.

Key File

Type: boolean Default: false

Read keys from a JSON file uploaded to the input pipe, in the format written by zfs.resource.encryption.export_keys.

Keys

Type: array of object Default: []

Keys or passphrases to check for individual encryption roots.

No Additional Items
Each item of this array must be:

ZFSResourceEncryptionUnlockSummaryKey

Type: object
No Additional Properties

Path

Type: string

Path of the encryption root the key or passphrase belongs to.

Must be at least 1 characters long

Key

Default: null

A 64-character hex-encoded key for path. Must not be combined with passphrase.

Type: string

Must be at least 64 characters long

Must be at most 64 characters long

Type: null

Passphrase

Default: null

The passphrase for path. Must not be combined with key.

Type: string

Must be at least 1 characters long

Type: null

Force

Type: boolean Default: false

Rename whatever already occupies the mount path of path instead of failing because it exists and is not empty.

Result

Type: array of object

One entry per encryption root, parents before their descendants.

No Additional Items
Each item of this array must be:

ZFSResourceEncryptionUnlockSummaryEntry

Type: object
No Additional Properties

Path

Type: string

Path of the encryption root.

Key Format

Type: enum (of string)

Format of the encryption root's key.

Must be one of:
  • "hex"
  • "raw"
  • "passphrase"

Key Present In Database

Type: boolean

Whether the system has a stored key for the encryption root.

Valid Key

Type: boolean

Whether the supplied or stored key opens the encryption root.

Locked

Type: boolean

Whether the encryption root is currently locked.

Unlock Error


Why an unlock would fail, or null if it would succeed.

Type: string
Type: null

Unlock Successful

Type: boolean

Whether an unlock with the same parameters would succeed.



Required roles: ZFS_RESOURCE_READ