mirror of
https://git.sr.ht/~nabijaczleweli/tzpfms
synced 2025-04-21 09:47:35 +03:00
174 lines
7.4 KiB
HTML
174 lines
7.4 KiB
HTML
<!DOCTYPE html>
|
|
<html>
|
|
<!-- This is an automatically generated file. Do not edit.
|
|
SPDX-License-Identifier: MIT
|
|
-->
|
|
<head>
|
|
<meta charset="utf-8"/>
|
|
<meta name="viewport" content="width=device-width, initial-scale=1.0"/>
|
|
<link rel="stylesheet" href="style.css" type="text/css" media="all"/>
|
|
<title>ZFS-TPM-LIST(8)</title>
|
|
</head>
|
|
<body>
|
|
<table class="head">
|
|
<tr>
|
|
<td class="head-ltitle">ZFS-TPM-LIST(8)</td>
|
|
<td class="head-vol">System Manager's Manual</td>
|
|
<td class="head-rtitle">ZFS-TPM-LIST(8)</td>
|
|
</tr>
|
|
</table>
|
|
<div class="manual-text">
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="NAME"><a class="permalink" href="#NAME">NAME</a></h1>
|
|
<p class="Pp"><code class="Nm">zfs-tpm-list</code> —
|
|
<span class="Nd">print dataset tzpfms metadata</span></p>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="SYNOPSIS"><a class="permalink" href="#SYNOPSIS">SYNOPSIS</a></h1>
|
|
<table class="Nm">
|
|
<tr>
|
|
<td><code class="Nm">zfs-tpm-list</code></td>
|
|
<td>[<code class="Fl">-H</code>]
|
|
[<code class="Fl">-r</code>|<code class="Fl">-d</code>
|
|
<var class="Ar">depth</var>]
|
|
[<code class="Fl">-a</code>|<code class="Fl">-b</code>
|
|
<var class="Ar">back-end</var>]
|
|
[<code class="Fl">-u</code>|<code class="Fl">-l</code>]
|
|
[<var class="Ar">filesystem</var>|<var class="Ar">volume</var>]…</td>
|
|
</tr>
|
|
</table>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="DESCRIPTION"><a class="permalink" href="#DESCRIPTION">DESCRIPTION</a></h1>
|
|
<p class="Pp">Lists the following properties on encryption roots:</p>
|
|
<div class="Bd-indent">
|
|
<dl class="Bl-tag Bl-compact">
|
|
<dt id="name"><a class="permalink" href="#name"><code class="Li">name</code></a></dt>
|
|
<dd style="width: auto;"> </dd>
|
|
<dt id="back-end"><a class="permalink" href="#back-end"><code class="Li">back-end</code></a></dt>
|
|
<dd>the <code class="Nm">tzpfms</code> back-end (e.g. <b class="Sy">TPM2</b>
|
|
<span class="No">for</span>
|
|
<a class="Xr" href="zfs-tpm2-change-key.8.html">zfs-tpm2-change-key(8)</a>
|
|
or
|
|
<a class="permalink" href="#TPM1.X"><b class="Sy" id="TPM1.X">TPM1.X</b></a>
|
|
<span class="No">for</span>
|
|
<a class="Xr" href="zfs-tpm1x-change-key.8.html">zfs-tpm1x-change-key(8)</a>),
|
|
or "<b class="Sy">-</b>" if none is configured</dd>
|
|
<dt id="keystatus"><a class="permalink" href="#keystatus"><code class="Li">keystatus</code></a></dt>
|
|
<dd><a class="permalink" href="#available"><b class="Sy" id="available">available</b></a>
|
|
or
|
|
<a class="permalink" href="#unavailable"><b class="Sy" id="unavailable">unavailable</b></a></dd>
|
|
<dt id="coherent"><a class="permalink" href="#coherent"><code class="Li">coherent</code></a></dt>
|
|
<dd><a class="permalink" href="#yes"><b class="Sy" id="yes">yes</b></a> if
|
|
either both <code class="Li">xyz.nabijaczleweli:tzpfms.backend</code> and
|
|
<code class="Li">xyz.nabijaczleweli:tzpfms.key</code> are present or
|
|
missing, <a class="permalink" href="#no"><b class="Sy" id="no">no</b></a>
|
|
otherwise</dd>
|
|
</dl>
|
|
</div>
|
|
<p class="Pp">Incoherent datasets require immediate operator attention, with
|
|
either the appropriate <code class="Nm">zfs-tpm*-clear-key</code> program or
|
|
<code class="Nm">zfs</code> <code class="Cm">change-key</code> and
|
|
<code class="Nm">zfs</code> <code class="Cm">inherit</code> — 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.</p>
|
|
<p class="Pp">If no datasets are specified, all matching encryption roots are
|
|
listed — by default, those managed by
|
|
<code class="Nm">tzpfms</code>.</p>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="OPTIONS"><a class="permalink" href="#OPTIONS">OPTIONS</a></h1>
|
|
<dl class="Bl-tag Bl-compact">
|
|
<dt id="H"><a class="permalink" href="#H"><code class="Fl">-H</code></a></dt>
|
|
<dd>Scripting mode — remove headers and separate fields by a single tab
|
|
instead of columnating them with spaces.
|
|
<p class="Pp"></p>
|
|
</dd>
|
|
<dt id="r"><a class="permalink" href="#r"><code class="Fl">-r</code></a></dt>
|
|
<dd>Recurse into all descendants of specified datasets.</dd>
|
|
<dt id="d"><a class="permalink" href="#d"><code class="Fl">-d</code></a>
|
|
<var class="Ar">depth</var></dt>
|
|
<dd>Recurse at most <var class="Ar">depth</var> datasets deep. Default:
|
|
<a class="permalink" href="#0"><b class="Sy" id="0">0</b></a>.
|
|
<p class="Pp"></p>
|
|
</dd>
|
|
<dt id="a"><a class="permalink" href="#a"><code class="Fl">-a</code></a></dt>
|
|
<dd>List all encryption roots, even ones not managed by
|
|
<code class="Nm">tzpfms</code>.</dd>
|
|
<dt id="b"><a class="permalink" href="#b"><code class="Fl">-b</code></a>
|
|
<var class="Ar">back-end</var></dt>
|
|
<dd>List only encryption roots with the specified
|
|
<code class="Nm">tzpfms</code> <var class="Ar">back-end</var>.
|
|
<p class="Pp"></p>
|
|
</dd>
|
|
<dt id="u"><a class="permalink" href="#u"><code class="Fl">-u</code></a></dt>
|
|
<dd>List only encryption roots whose keys are unavailable.</dd>
|
|
<dt id="l"><a class="permalink" href="#l"><code class="Fl">-l</code></a></dt>
|
|
<dd>List only encryption roots whose keys are available.</dd>
|
|
</dl>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="EXAMPLES"><a class="permalink" href="#EXAMPLES">EXAMPLES</a></h1>
|
|
<div class="Bd Li">
|
|
<pre><code class="Li">$</code> <code class="Nm"></code></pre>
|
|
zfs-tpm-list
|
|
NAME BACK-END KEYSTATUS COHERENT
|
|
tarta-zoot TPM1.X available yes
|
|
tarta-zoot/home TPM2 unavailable yes
|
|
|
|
<code class="Li">$</code> <code class="Nm"></code>zfs-tpm-list
|
|
<code class="Fl">-ad0</code>
|
|
NAME BACK-END KEYSTATUS COHERENT
|
|
filling - available yes
|
|
|
|
<code class="Li">$</code> <code class="Nm"></code>zfs-tpm-list
|
|
<code class="Fl">-b</code> <b class="Sy">TPM2</b>
|
|
NAME BACK-END KEYSTATUS COHERENT
|
|
tarta-zoot/home TPM2 unavailable yes
|
|
|
|
<code class="Li">$</code> <code class="Nm"></code>zfs-tpm-list
|
|
<code class="Fl">-ra</code> <var class="Ar">tarta-zoot</var>
|
|
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
|
|
|
|
<code class="Li">$</code> <code class="Nm"></code>zfs-tpm-list
|
|
<code class="Fl">-al</code>
|
|
NAME BACK-END KEYSTATUS COHERENT
|
|
filling - available yes
|
|
tarta-zoot TPM1.X available yes
|
|
tarta-zoot/bkp - available yes
|
|
tarta-zoot/vm - available yes</div>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="SPECIAL_THANKS"><a class="permalink" href="#SPECIAL_THANKS">SPECIAL
|
|
THANKS</a></h1>
|
|
<p class="Pp">To all who support further development, in particular:</p>
|
|
<ul class="Bl-bullet Bd-indent Bl-compact">
|
|
<li>ThePhD</li>
|
|
<li>Embark Studios</li>
|
|
<li>Jasper Bekkers</li>
|
|
<li>EvModder</li>
|
|
</ul>
|
|
</section>
|
|
<section class="Sh">
|
|
<h1 class="Sh" id="REPORTING_BUGS"><a class="permalink" href="#REPORTING_BUGS">REPORTING
|
|
BUGS</a></h1>
|
|
<p class="Pp"><a class="Lk" href="https://todo.sr.ht/~nabijaczleweli/tzpfms">https://todo.sr.ht/~nabijaczleweli/tzpfms</a></p>
|
|
<p class="Pp"><a class="Mt" href="mailto:~nabijaczleweli/tzpfms@lists.sr.ht">~nabijaczleweli/tzpfms@lists.sr.ht</a>,
|
|
archived at
|
|
<a class="Lk" href="https://lists.sr.ht/~nabijaczleweli/tzpfms">https://lists.sr.ht/~nabijaczleweli/tzpfms</a>.</p>
|
|
</section>
|
|
</div>
|
|
<table class="foot">
|
|
<tr>
|
|
<td class="foot-date">December 4, 2022</td>
|
|
<td class="foot-os">tzpfms 0.4.1-1-gfd16dbb</td>
|
|
</tr>
|
|
</table>
|
|
</body>
|
|
</html>
|