ZFS-TPM-LIST(8) System Manager's Manual ZFS-TPM-LIST(8)

zfs-tpm-list — print dataset tzpfms metadata

zfs-tpm-list [-H] [-r|-d depth] [-a|-b back-end] [-u|-l] [filesystem|volume]…

Lists the following properties on encryption roots:

 
the tzpfms back-end (e.g. TPM2 for zfs-tpm2-change-key(8) or for zfs-tpm1x-change-key(8)), or "-" if none is configured
or
if either both xyz.nabijaczleweli:tzpfms.backend and xyz.nabijaczleweli:tzpfms.key are present or missing, otherwise

Incoherent datasets require immediate operator attention, with either the appropriate zfs-tpm*-clear-key program or zfs change-key and zfs inherit — if the key becomes unloaded, they will require restoration from back-up. However, this should never occur, unless something went horribly wrong with the dataset properties.

If no datasets are specified, all matching encryption roots are listed — by default, those managed by tzpfms.

Scripting mode — remove headers and separate fields by a single tab instead of columnating them with spaces.

Recurse into all descendants of specified datasets.
depth
Recurse at most depth datasets deep. Default: .

List all encryption roots, even ones not managed by tzpfms.
back-end
List only encryption roots with the specified tzpfms back-end.

List only encryption roots whose keys are unavailable.
List only encryption roots whose keys are available.

$
zfs-tpm-list NAME BACK-END KEYSTATUS COHERENT tarta-zoot TPM1.X available yes tarta-zoot/home TPM2 unavailable yes $ zfs-tpm-list -ad0 NAME BACK-END KEYSTATUS COHERENT filling - available yes $ zfs-tpm-list -b TPM2 NAME BACK-END KEYSTATUS COHERENT tarta-zoot/home TPM2 unavailable yes $ zfs-tpm-list -ra tarta-zoot NAME BACK-END KEYSTATUS COHERENT tarta-zoot TPM1.X available yes tarta-zoot/home TPM2 unavailable yes tarta-zoot/bkp - available yes tarta-zoot/vm - available yes $ zfs-tpm-list -al NAME BACK-END KEYSTATUS COHERENT filling - available yes tarta-zoot TPM1.X available yes tarta-zoot/bkp - available yes tarta-zoot/vm - available yes

To all who support further development, in particular:

https://todo.sr.ht/~nabijaczleweli/tzpfms

~nabijaczleweli/tzpfms@lists.sr.ht, archived at https://lists.sr.ht/~nabijaczleweli/tzpfms.

December 4, 2022 tzpfms 0.4.1-2-g0b6378d