nvme/nvme-cli
1
0
Fork 0
Code Issues Activity

Merging upstream version 2.4+really2.4.

Browse source 
Signed-off-by: Daniel Baumann <daniel@debian.org>
This commit is contained in:
Daniel Baumann 2025-02-16 12:23:16 +01:00
parent f52576e699
commit be98c20625
Signed by: daniel
GPG key ID: FBB4F0E80A80222F
458 changed files with 7148 additions and 5151 deletions
Download patch file Download diff file Expand all files Collapse all files

4
Documentation/nvme-admin-passthru.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-admin-passthru
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ADMIN\-PASSTHR" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ADMIN\-PASSTHR" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-admin-passthru.html
View file

@ -998,7 +998,7 @@ Or if you want to save that structure to a file:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-ana-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-ana-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ANA\-LOG" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ANA\-LOG" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-ana-log.html
View file

@ -823,7 +823,7 @@ Print the ANA log page in a human readable format:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-attach-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-attach-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ATTACH\-NS" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ATTACH\-NS" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-attach-ns.html
View file

@ -817,7 +817,7 @@ controller identifiers.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-boot-part-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-boot-part-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-BOOT\-PART\-LO" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-BOOT\-PART\-LO" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-boot-part-log.html
View file

@ -835,7 +835,7 @@ Retrieve Boot Partition data to boot_part_log.bin
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-capacity-mgmt.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-capacity-mgmt
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CAPACITY\-MGMT" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CAPACITY\-MGMT" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-capacity-mgmt.html
View file

@ -839,7 +839,7 @@ device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></di
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-changed-ns-list-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-changed-ns-list-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CHANGED\-NS\-L" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CHANGED\-NS\-L" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-changed-ns-list-log.html
View file

@ -835,7 +835,7 @@ Print the raw Changed Namespace List log to a file:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

34
Documentation/nvme-check-tls-key.txt
View file

@ -8,18 +8,42 @@ nvme-check-tls-key - Check a generated NVMe TLS PSK
SYNOPSIS
--------
[verse]
'nvme check-tls-key' [--key=<key> ]
'nvme check-tls-key' [--keyring=<name> | -k <name> ]
[--keytype=<type> | -t <type> ]
[--hostnqn=<nqn> | -n <nqn> ]
[--subsysnqn=<nqn> | -c <nqn> ]
[--keydata=<key> | -d <key> ]
DESCRIPTION
-----------
Checks if the key is a valid NVMe TLS PSK in the PSK interchange format
NVMeTLSkey-1:01:VRLbtnN9AQb2WXW3c9+wEf/DRLz0QuLdbYvEhwtdWwNf9LrZ:
'NVMeTLSkey-1:01:<base64-encoded data>:', and stores the derived 'retained'
TLS key in the keyring if the subsystem NQN is specified.
OPTIONS
-------
-k <key>::
--key=<key>::
-k <name>::
--keyring=<name>::
Name of the keyring into which the 'retained' TLS key should be
stored. Default is '.nvme'.
-t <type>::
--keytype=<type>::
Type of the key for resulting TLS key.
Default is 'psk'.
-n <nqn>::
--hostnqn=<nqn>::
Host NVMe Qualified Name (NQN) to be used to derive the
'retained' TLS key
-c <nqn>::
--subsysnqn=<nqn>::
Subsystem NVMe Qualified Name (NQN) to be used to derive the
'retained' TLS key
-d <key>::
--keydata=<key>::
Key to be checked.
EXAMPLES

4
Documentation/nvme-cmdset-ind-id-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-cmdset-ind-id-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CMDSET\-IND\-I" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CMDSET\-IND\-I" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-cmdset-ind-id-ns.html
View file

@ -879,7 +879,7 @@ Have the program return the raw structure in binary:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

12
Documentation/nvme-compare.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-compare
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-COMPARE" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-COMPARE" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -51,7 +51,7 @@ nvme-compare \- Send an NVMe Compare command, provide results
[\-\-dry\-run | \-w]
[\-\-latency | \-t]
[\-\-storage\-tag<storage\-tag> | \-g <storage\-tag>]
[\-\-storage\-tag\-check<storage\-tag\-check> | \-C <storage\-tag\-check>]
[\-\-storage\-tag\-check | \-C]
[\-\-force]
.fi
.SH "DESCRIPTION"
@ -206,14 +206,14 @@ be set\&. Otherwise \-\-dry\-run option will be
Print out the latency the IOCTL took (in us)\&.
.RE
.PP
\-\-storage\-tag=<storage\-tag>, \-g <storage\-tag>
\-g <storage\-tag>, \-\-storage\-tag=<storage\-tag>
.RS 4
Variable Sized Expected Logical Block Storage Tag(ELBST)\&.
.RE
.PP
\-\-storage\-tag\-check=<storage\-tag\-check>, \-C <storage\-tag\-check>
\-C, \-\-storage\-tag\-check
.RS 4
This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&.
This flag enables Storage Tag field checking as part of end\-to\-end data protection processing\&.
.RE
.PP
\-\-force

14
Documentation/nvme-compare.html
View file

@ -768,7 +768,7 @@ nvme-compare(1) Manual Page
[--dry-run | -w]
[--latency | -t]
[--storage-tag&lt;storage-tag&gt; | -g &lt;storage-tag&gt;]
[--storage-tag-check&lt;storage-tag-check&gt; | -C &lt;storage-tag-check&gt;]
[--storage-tag-check | -C]
[--force]</pre>
<div class="attribution">
</div></div>
@ -1044,10 +1044,10 @@ metadata is passes.</p></td>
</p>
</dd>
<dt class="hdlist1">
--storage-tag=&lt;storage-tag&gt;
-g &lt;storage-tag&gt;
</dt>
<dt class="hdlist1">
-g &lt;storage-tag&gt;
--storage-tag=&lt;storage-tag&gt;
</dt>
<dd>
<p>
@ -1055,14 +1055,14 @@ metadata is passes.</p></td>
</p>
</dd>
<dt class="hdlist1">
--storage-tag-check=&lt;storage-tag-check&gt;
-C
</dt>
<dt class="hdlist1">
-C &lt;storage-tag-check&gt;
--storage-tag-check
</dt>
<dd>
<p>
This bit specifies the Storage Tag field shall be checked as part of end-to-end
This flag enables Storage Tag field checking as part of end-to-end
data protection processing.
</p>
</dd>
@ -1095,7 +1095,7 @@ metadata is passes.</p></td>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

10
Documentation/nvme-compare.txt
View file

@ -27,7 +27,7 @@ SYNOPSIS
[--dry-run | -w]
[--latency | -t]
[--storage-tag<storage-tag> | -g <storage-tag>]
[--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]
[--storage-tag-check | -C]
[--force]
DESCRIPTION
@ -141,13 +141,13 @@ metadata is passes.
--latency::
Print out the latency the IOCTL took (in us).
--storage-tag=<storage-tag>::
-g <storage-tag>::
--storage-tag=<storage-tag>::
Variable Sized Expected Logical Block Storage Tag(ELBST).
--storage-tag-check=<storage-tag-check>::
-C <storage-tag-check>::
This bit specifies the Storage Tag field shall be checked as part of end-to-end
-C::
--storage-tag-check::
This flag enables Storage Tag field checking as part of end-to-end
data protection processing.
--force::

54
Documentation/nvme-connect-all.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-connect-all
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CONNECT\-ALL" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CONNECT\-ALL" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -42,17 +42,21 @@ nvme-connect-all \- Discover and Connect to Fabrics controllers\&.
[\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
[\-\-hostid=<hostid> | \-I <hostid>]
[\-\-raw=<filename> | \-r <filename>]
[\-\-device=<device> | \-d <device>]
[\-\-cfg\-file=<cfg> | \-C <cfg>]
[\-\-keep\-alive\-tmo=<#> | \-k <#>]
[\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
[\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
[\-\-hdr\-digest | \-g]
[\-\-data\-digest | \-G]
[\-\-nr\-io\-queues=<#> | \-i <#>]
[\-\-nr\-write\-queues=<#> | \-W <#>]
[\-\-nr\-poll\-queues=<#> | \-P <#>]
[\-\-queue\-size=<#> | \-Q <#>]
[\-\-keyring=<#> ]
[\-\-tls_key=<#> ]
[\-\-hdr\-digest | \-g]
[\-\-data\-digest | \-G]
[\-\-persistent | \-p]
[\-\-tls ]
[\-\-quiet | \-S]
[\-\-dump\-config | \-O]
.fi
@ -151,6 +155,11 @@ command and dump it to a raw binary file\&. By default
will dump the output to stdout\&.
.RE
.PP
\-d <device>, \-\-device=<device>
.RS 4
This field takes a device as input\&. It must be a persistent device associated with a Discovery Controller previously created by the command "connect\-all" or "discover"\&. <device> follows the format nvme*, eg\&. nvme0, nvme1\&.
.RE
.PP
\-C <cfg>, \-\-config\-file=<cfg>
.RS 4
Use the specified JSON configuration file instead of the default /usr/local/etc/nvme/config\&.json file or
@ -174,16 +183,6 @@ Overrides the default delay (in seconds) before reconnect is attempted after a c
Overrides the default controller loss timeout period (in seconds)\&.
.RE
.PP
\-g, \-\-hdr\-digest
.RS 4
Generates/verifies header digest (TCP)\&.
.RE
.PP
\-G, \-\-data\-digest
.RS 4
Generates/verifies data digest (TCP)\&.
.RE
.PP
\-i <#>, \-\-nr\-io\-queues=<#>
.RS 4
Overrides the default number of I/O queues create by the driver\&. This option will be ignored for discovery, but will be passed on to the subsequent connect call\&.
@ -204,11 +203,36 @@ Adds additional queues that will be used for polling latency sensitive I/O\&.
Overrides the default number of elements in the I/O queues created by the driver\&. This option will be ignored for discovery, but will be passed on to the subsequent connect call\&.
.RE
.PP
\-\-keyring=<#>
.RS 4
Keyring for TLS key lookup\&.
.RE
.PP
\-\-tls_key=<#>
.RS 4
TLS key for the connection (TCP)\&.
.RE
.PP
\-g, \-\-hdr\-digest
.RS 4
Generates/verifies header digest (TCP)\&.
.RE
.PP
\-G, \-\-data\-digest
.RS 4
Generates/verifies data digest (TCP)\&.
.RE
.PP
\-p, \-\-persistent
.RS 4
Don\(cqt remove the discovery controller after retrieving the discovery log page\&.
.RE
.PP
\-\-tls
.RS 4
Enable TLS encryption (TCP)\&.
.RE
.PP
\-S, \-\-quiet
.RS 4
Suppress error messages\&.

94
Documentation/nvme-connect-all.html
View file

@ -759,17 +759,21 @@ nvme-connect-all(1) Manual Page
[--hostnqn=&lt;hostnqn&gt; | -q &lt;hostnqn&gt;]
[--hostid=&lt;hostid&gt; | -I &lt;hostid&gt;]
[--raw=&lt;filename&gt; | -r &lt;filename&gt;]
[--device=&lt;device&gt; | -d &lt;device&gt;]
[--cfg-file=&lt;cfg&gt; | -C &lt;cfg&gt;]
[--keep-alive-tmo=&lt;#&gt; | -k &lt;#&gt;]
[--keep-alive-tmo=&lt;sec&gt; | -k &lt;sec&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;]
[--hdr-digest | -g]
[--data-digest | -G]
[--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;]
[--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;]
[--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;]
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;]
[--keyring=&lt;#&gt; ]
[--tls_key=&lt;#&gt; ]
[--hdr-digest | -g]
[--data-digest | -G]
[--persistent | -p]
[--tls ]
[--quiet | -S]
[--dump-config | -O]</pre>
<div class="attribution">
@ -945,6 +949,20 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-d &lt;device&gt;
</dt>
<dt class="hdlist1">
--device=&lt;device&gt;
</dt>
<dd>
<p>
This field takes a device as input. It must be a persistent device
associated with a Discovery Controller previously created by the
command "connect-all" or "discover". &lt;device&gt; follows the format
nvme*, eg. nvme0, nvme1.
</p>
</dd>
<dt class="hdlist1">
-C &lt;cfg&gt;
</dt>
<dt class="hdlist1">
@ -996,28 +1014,6 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-g
</dt>
<dt class="hdlist1">
--hdr-digest
</dt>
<dd>
<p>
Generates/verifies header digest (TCP).
</p>
</dd>
<dt class="hdlist1">
-G
</dt>
<dt class="hdlist1">
--data-digest
</dt>
<dd>
<p>
Generates/verifies data digest (TCP).
</p>
</dd>
<dt class="hdlist1">
-i &lt;#&gt;
</dt>
<dt class="hdlist1">
@ -1066,6 +1062,44 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
--keyring=&lt;#&gt;
</dt>
<dd>
<p>
Keyring for TLS key lookup.
</p>
</dd>
<dt class="hdlist1">
--tls_key=&lt;#&gt;
</dt>
<dd>
<p>
TLS key for the connection (TCP).
</p>
</dd>
<dt class="hdlist1">
-g
</dt>
<dt class="hdlist1">
--hdr-digest
</dt>
<dd>
<p>
Generates/verifies header digest (TCP).
</p>
</dd>
<dt class="hdlist1">
-G
</dt>
<dt class="hdlist1">
--data-digest
</dt>
<dd>
<p>
Generates/verifies data digest (TCP).
</p>
</dd>
<dt class="hdlist1">
-p
</dt>
<dt class="hdlist1">
@ -1078,6 +1112,14 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
--tls
</dt>
<dd>
<p>
Enable TLS encryption (TCP).
</p>
</dd>
<dt class="hdlist1">
-S
</dt>
<dt class="hdlist1">
@ -1156,7 +1198,7 @@ nvme-connect(1)</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

42
Documentation/nvme-connect-all.txt
View file

@ -18,17 +18,21 @@ SYNOPSIS
[--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
[--device=<device> | -d <device>]
[--cfg-file=<cfg> | -C <cfg>]
[--keep-alive-tmo=<#> | -k <#>]
[--keep-alive-tmo=<sec> | -k <sec>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
[--hdr-digest | -g]
[--data-digest | -G]
[--nr-io-queues=<#> | -i <#>]
[--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
[--queue-size=<#> | -Q <#>]
[--keyring=<#> ]
[--tls_key=<#> ]
[--hdr-digest | -g]
[--data-digest | -G]
[--persistent | -p]
[--tls ]
[--quiet | -S]
[--dump-config | -O]
@ -114,6 +118,13 @@ OPTIONS
and dump it to a raw binary file. By default 'nvme connect-all' will
dump the output to stdout.
-d <device>::
--device=<device>::
This field takes a device as input. It must be a persistent device
associated with a Discovery Controller previously created by the
command "connect-all" or "discover". <device> follows the format
nvme*, eg. nvme0, nvme1.
-C <cfg>::
--config-file=<cfg>::
Use the specified JSON configuration file instead of the
@ -137,14 +148,6 @@ OPTIONS
--ctrl-loss-tmo=<#>::
Overrides the default controller loss timeout period (in seconds).
-g::
--hdr-digest::
Generates/verifies header digest (TCP).
-G::
--data-digest::
Generates/verifies data digest (TCP).
-i <#>::
--nr-io-queues=<#>::
Overrides the default number of I/O queues create by the driver.
@ -165,11 +168,28 @@ OPTIONS
by the driver. This option will be ignored for discovery, but will be
passed on to the subsequent connect call.
--keyring=<#>::
Keyring for TLS key lookup.
--tls_key=<#>::
TLS key for the connection (TCP).
-g::
--hdr-digest::
Generates/verifies header digest (TCP).
-G::
--data-digest::
Generates/verifies data digest (TCP).
-p::
--persistent::
Don't remove the discovery controller after retrieving the discovery
log page.
--tls::
Enable TLS encryption (TCP).
-S::
--quiet::
Suppress error messages.

28
Documentation/nvme-connect.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-connect
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CONNECT" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CONNECT" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -51,10 +51,14 @@ nvme-connect \- Connect to a Fabrics controller\&.
[\-\-keep\-alive\-tmo=<#> | \-k <#>]
[\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
[\-\-tos=<#> | \-T <#>]
[\-\-keyring=<#> ]
[\-\-tls_key=<#> ]
[\-\-duplicate\-connect | \-D]
[\-\-disable\-sqflow | \-d]
[\-\-hdr\-digest | \-g]
[\-\-data\-digest | \-G]
[\-\-tls ]
[\-\-dump\-config | \-O]
[\-\-output\-format=<fmt> | \-o <fmt>]
.fi
@ -193,6 +197,21 @@ Overrides the default delay (in seconds) before reconnect is attempted after a c
Overrides the default controller loss timeout period (in seconds)\&.
.RE
.PP
\-T <#>, \-\-tos=<#>
.RS 4
Type of service for the connection (TCP)
.RE
.PP
\-\-keyring=<#>
.RS 4
Keyring for TLS key lookup\&.
.RE
.PP
\-\-tls_key=<#>
.RS 4
TLS key for the connection (TCP)\&.
.RE
.PP
\-D, \-\-duplicate\-connect
.RS 4
Allows duplicated connections between same transport host and subsystem port\&.
@ -213,6 +232,11 @@ Generates/verifies header digest (TCP)\&.
Generates/verifies data digest (TCP)\&.
.RE
.PP
\-\-tls
.RS 4
Enable TLS encryption (TCP)\&.
.RE
.PP
\-O, \-\-dump\-config
.RS 4
Print out resulting JSON configuration file to stdout\&.

41
Documentation/nvme-connect.html
View file

@ -768,10 +768,14 @@ nvme-connect(1) Manual Page
[--keep-alive-tmo=&lt;#&gt; | -k &lt;#&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;]
[--tos=&lt;#&gt; | -T &lt;#&gt;]
[--keyring=&lt;#&gt; ]
[--tls_key=&lt;#&gt; ]
[--duplicate-connect | -D]
[--disable-sqflow | -d]
[--hdr-digest | -g]
[--data-digest | -G]
[--tls ]
[--dump-config | -O]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]</pre>
<div class="attribution">
@ -1047,6 +1051,33 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-T &lt;#&gt;
</dt>
<dt class="hdlist1">
--tos=&lt;#&gt;
</dt>
<dd>
<p>
Type of service for the connection (TCP)
</p>
</dd>
<dt class="hdlist1">
--keyring=&lt;#&gt;
</dt>
<dd>
<p>
Keyring for TLS key lookup.
</p>
</dd>
<dt class="hdlist1">
--tls_key=&lt;#&gt;
</dt>
<dd>
<p>
TLS key for the connection (TCP).
</p>
</dd>
<dt class="hdlist1">
-D
</dt>
<dt class="hdlist1">
@ -1093,6 +1124,14 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
--tls
</dt>
<dd>
<p>
Enable TLS encryption (TCP).
</p>
</dd>
<dt class="hdlist1">
-O
</dt>
<dt class="hdlist1">
@ -1162,7 +1201,7 @@ and <a href="mailto:hch@lst.de">Christoph Hellwig</a></p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

17
Documentation/nvme-connect.txt
View file

@ -27,10 +27,14 @@ SYNOPSIS
[--keep-alive-tmo=<#> | -k <#>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
[--tos=<#> | -T <#>]
[--keyring=<#> ]
[--tls_key=<#> ]
[--duplicate-connect | -D]
[--disable-sqflow | -d]
[--hdr-digest | -g]
[--data-digest | -G]
[--tls ]
[--dump-config | -O]
[--output-format=<fmt> | -o <fmt>]
@ -150,6 +154,16 @@ OPTIONS
--ctrl-loss-tmo=<#>::
Overrides the default controller loss timeout period (in seconds).
-T <#>::
--tos=<#>::
Type of service for the connection (TCP)
--keyring=<#>::
Keyring for TLS key lookup.
--tls_key=<#>::
TLS key for the connection (TCP).
-D::
--duplicate-connect::
Allows duplicated connections between same transport host and subsystem
@ -168,6 +182,9 @@ OPTIONS
--data-digest::
Generates/verifies data digest (TCP).
--tls::
Enable TLS encryption (TCP).
-O::
--dump-config::
Print out resulting JSON configuration file to stdout.

4
Documentation/nvme-copy.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-copy
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-COPY" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-COPY" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-copy.html
View file

@ -982,7 +982,7 @@ logical block ranges to a single consecutive destination logical block range.</p
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-create-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-create-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-CREATE\-NS" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-CREATE\-NS" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-create-ns.html
View file

@ -952,7 +952,7 @@ Create a namespace:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-delete-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-id-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ID\-NS" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ID\-NS" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-delete-ns.html
View file

@ -799,7 +799,7 @@ The <code>'--namespace-id'</code> option is mandatory.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-dera-stat.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-dera-stat
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DERA\-STAT" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DERA\-STAT" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-dera-stat.html
View file

@ -797,7 +797,7 @@ Print the Dera Device status and Additional SMART log page in a human readable f
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-detach-ns.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-detach-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DETACH\-NS" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DETACH\-NS" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-detach-ns.html
View file

@ -810,7 +810,7 @@ controller identifiers.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-device-self-test.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-device-self-test
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DEVICE\-SELF\-" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DEVICE\-SELF\-" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-device-self-test.html
View file

@ -848,7 +848,7 @@ Abort the device self-test operation in the namespace-id 1:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-dim.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-dim
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DIM" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DIM" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-dim.html
View file

@ -863,7 +863,7 @@ Deregister from Central Discovery Controller (CDC) associated with nvme4
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-dir-receive.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-dir-receive
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DIR\-RECEIVE" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DIR\-RECEIVE" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-dir-receive.html
View file

@ -969,7 +969,7 @@ Get streams directive status :
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-dir-send.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-dir-send
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DIR\-SEND" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DIR\-SEND" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-dir-send.html
View file

@ -982,7 +982,7 @@ Release stream ID 3 :
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-disconnect-all.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-disconnect-all
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DISCONNECT\-AL" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DISCONNECT\-AL" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-disconnect-all.html
View file

@ -795,7 +795,7 @@ Disconnect all existing nvme controllers:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-disconnect.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-disconnect
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DISCONNECT" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DISCONNECT" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-disconnect.html
View file

@ -839,7 +839,7 @@ Disconnect the controller nvme4
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

54
Documentation/nvme-discover.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-discover
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DISCOVER" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DISCOVER" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -47,14 +47,17 @@ nvme-discover \- Send Get Log Page request to Discovery Controller\&.
[\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
[\-\-reconnect\-delay=<#> | \-c <#>]
[\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
[\-\-hdr_digest | \-g]
[\-\-data_digest | \-G]
[\-\-nr\-io\-queues=<#> | \-i <#>]
[\-\-nr\-write\-queues=<#> | \-W <#>]
[\-\-nr\-poll\-queues=<#> | \-P <#>]
[\-\-queue\-size=<#> | \-Q <#>]
[\-\-keyring=<#> ]
[\-\-tls_key=<#> ]
[\-\-hdr\-digest | \-g]
[\-\-data\-digest | \-G]
[\-\-persistent | \-p]
[\-\-quiet | \-S]
[\-\-tls ]
[\-\-dump\-config | \-O]
[\-\-output\-format=<fmt> | \-o <fmt>]
[\-\-force]
@ -122,7 +125,7 @@ This field specifies the name for the NVMe subsystem to connect to\&.
.PP
\-a <traddr>, \-\-traddr=<traddr>
.RS 4
This field specifies the network address of the Discovery Controller\&. For transports using IP addressing (e\&.g\&. rdma) this should be an IP\-based (ex\&. IPv4) address\&.
This field specifies the network address of the Discovery Controller\&. For transports using IP addressing (e\&.g\&. rdma) this should be an IP\-based address (ex\&. IPv4)\&.
.RE
.PP
\-s <trsvcid>, \-\-trsvcid=<trsvcid>
@ -161,7 +164,7 @@ will dump the output to stdout\&.
.PP
\-d <device>, \-\-device=<device>
.RS 4
This field takes a device as input\&. Device is in the format of nvme*, eg\&. nvme0, nvme1
This field takes a device as input\&. It must be a persistent device associated with a Discovery Controller previously created by the command "connect\-all" or "discover"\&. <device> follows the format nvme*, eg\&. nvme0, nvme1\&.
.RE
.PP
\-C <cfg>, \-\-config\-file=<cfg>
@ -174,7 +177,7 @@ to not read in an existing configuration file\&. The JSON configuration file for
.PP
\-k <#>, \-\-keep\-alive\-tmo=<#>
.RS 4
Overrides the default timeout (in seconds) for keep alive\&. This option will be ignored for the discovery, and it is only implemented for completeness\&.
Overrides the default keep alive timeout (in seconds)\&. This option will be ignored for discovery, and it is only implemented for completeness\&.
.RE
.PP
\-c <#>, \-\-reconnect\-delay=<#>
@ -187,16 +190,6 @@ Overrides the default delay (in seconds) before reconnect is attempted after a c
Overrides the default controller loss timeout period (in seconds)\&.
.RE
.PP
\-g, \-\-hdr_digest
.RS 4
Generates/verifies header digest (TCP)\&.
.RE
.PP
\-G, \-\-data_digest
.RS 4
Generates/verifies data digest (TCP)\&.
.RE
.PP
\-i <#>, \-\-nr\-io\-queues=<#>
.RS 4
Overrides the default number of I/O queues create by the driver\&. This option will be ignored for the discovery, and it is only implemented for completeness\&.
@ -217,9 +210,34 @@ Adds additional queues that will be used for polling latency sensitive I/O\&.
Overrides the default number of elements in the I/O queues created by the driver which can be found at drivers/nvme/host/fabrics\&.h\&. This option will be ignored for the discovery, and it is only implemented for completeness\&.
.RE
.PP
\-\-keyring=<#>
.RS 4
Keyring for TLS key lookup\&.
.RE
.PP
\-\-tls_key=<#>
.RS 4
TLS key for the connection (TCP)\&.
.RE
.PP
\-g, \-\-hdr\-digest
.RS 4
Generates/verifies header digest (TCP)\&.
.RE
.PP
\-G, \-\-data\-digest
.RS 4
Generates/verifies data digest (TCP)\&.
.RE
.PP
\-p, \-\-persistent
.RS 4
Persistent discovery connection\&.
Don\(cqt remove the discovery controller after retrieving the discovery log page\&.
.RE
.PP
\-\-tls
.RS 4
Enable TLS encryption (TCP)\&.
.RE
.PP
\-S, \-\-quiet

92
Documentation/nvme-discover.html
View file

@ -764,14 +764,17 @@ nvme-discover(1) Manual Page
[--keep-alive-tmo=&lt;sec&gt; | -k &lt;sec&gt;]
[--reconnect-delay=&lt;#&gt; | -c &lt;#&gt;]
[--ctrl-loss-tmo=&lt;#&gt; | -l &lt;#&gt;]
[--hdr_digest | -g]
[--data_digest | -G]
[--nr-io-queues=&lt;#&gt; | -i &lt;#&gt;]
[--nr-write-queues=&lt;#&gt; | -W &lt;#&gt;]
[--nr-poll-queues=&lt;#&gt; | -P &lt;#&gt;]
[--queue-size=&lt;#&gt; | -Q &lt;#&gt;]
[--keyring=&lt;#&gt; ]
[--tls_key=&lt;#&gt; ]
[--hdr-digest | -g]
[--data-digest | -G]
[--persistent | -p]
[--quiet | -S]
[--tls ]
[--dump-config | -O]
[--output-format=&lt;fmt&gt; | -o &lt;fmt&gt;]
[--force]</pre>
@ -885,7 +888,7 @@ cellspacing="0" cellpadding="4">
<p>
This field specifies the network address of the Discovery Controller.
For transports using IP addressing (e.g. rdma) this should be an
IP-based (ex. IPv4) address.
IP-based address (ex. IPv4).
</p>
</dd>
<dt class="hdlist1">
@ -974,8 +977,10 @@ cellspacing="0" cellpadding="4">
</dt>
<dd>
<p>
This field takes a device as input. Device is in the format of nvme*,
eg. nvme0, nvme1
This field takes a device as input. It must be a persistent device
associated with a Discovery Controller previously created by the
command "connect-all" or "discover". &lt;device&gt; follows the format
nvme*, eg. nvme0, nvme1.
</p>
</dd>
<dt class="hdlist1">
@ -1001,8 +1006,8 @@ cellspacing="0" cellpadding="4">
</dt>
<dd>
<p>
Overrides the default timeout (in seconds) for keep alive.
This option will be ignored for the discovery, and it is only
Overrides the default keep alive timeout (in seconds). This
option will be ignored for discovery, and it is only
implemented for completeness.
</p>
</dd>
@ -1030,28 +1035,6 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
-g
</dt>
<dt class="hdlist1">
--hdr_digest
</dt>
<dd>
<p>
Generates/verifies header digest (TCP).
</p>
</dd>
<dt class="hdlist1">
-G
</dt>
<dt class="hdlist1">
--data_digest
</dt>
<dd>
<p>
Generates/verifies data digest (TCP).
</p>
</dd>
<dt class="hdlist1">
-i &lt;#&gt;
</dt>
<dt class="hdlist1">
@ -1101,6 +1084,44 @@ cellspacing="0" cellpadding="4">
</p>
</dd>
<dt class="hdlist1">
--keyring=&lt;#&gt;
</dt>
<dd>
<p>
Keyring for TLS key lookup.
</p>
</dd>
<dt class="hdlist1">
--tls_key=&lt;#&gt;
</dt>
<dd>
<p>
TLS key for the connection (TCP).
</p>
</dd>
<dt class="hdlist1">
-g
</dt>
<dt class="hdlist1">
--hdr-digest
</dt>
<dd>
<p>
Generates/verifies header digest (TCP).
</p>
</dd>
<dt class="hdlist1">
-G
</dt>
<dt class="hdlist1">
--data-digest
</dt>
<dd>
<p>
Generates/verifies data digest (TCP).
</p>
</dd>
<dt class="hdlist1">
-p
</dt>
<dt class="hdlist1">
@ -1108,7 +1129,16 @@ cellspacing="0" cellpadding="4">
</dt>
<dd>
<p>
Persistent discovery connection.
Don&#8217;t remove the discovery controller after retrieving the discovery
log page.
</p>
</dd>
<dt class="hdlist1">
--tls
</dt>
<dd>
<p>
Enable TLS encryption (TCP).
</p>
</dd>
<dt class="hdlist1">
@ -1218,7 +1248,7 @@ nvme-connect-all(1)</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

47
Documentation/nvme-discover.txt
View file

@ -23,14 +23,17 @@ SYNOPSIS
[--keep-alive-tmo=<sec> | -k <sec>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
[--hdr_digest | -g]
[--data_digest | -G]
[--nr-io-queues=<#> | -i <#>]
[--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
[--queue-size=<#> | -Q <#>]
[--keyring=<#> ]
[--tls_key=<#> ]
[--hdr-digest | -g]
[--data-digest | -G]
[--persistent | -p]
[--quiet | -S]
[--tls ]
[--dump-config | -O]
[--output-format=<fmt> | -o <fmt>]
[--force]
@ -97,7 +100,7 @@ OPTIONS
--traddr=<traddr>::
This field specifies the network address of the Discovery Controller.
For transports using IP addressing (e.g. rdma) this should be an
IP-based (ex. IPv4) address.
IP-based address (ex. IPv4).
-s <trsvcid>::
--trsvcid=<trsvcid>::
@ -137,8 +140,10 @@ OPTIONS
-d <device>::
--device=<device>::
This field takes a device as input. Device is in the format of nvme*,
eg. nvme0, nvme1
This field takes a device as input. It must be a persistent device
associated with a Discovery Controller previously created by the
command "connect-all" or "discover". <device> follows the format
nvme*, eg. nvme0, nvme1.
-C <cfg>::
--config-file=<cfg>::
@ -150,8 +155,8 @@ OPTIONS
-k <#>::
--keep-alive-tmo=<#>::
Overrides the default timeout (in seconds) for keep alive.
This option will be ignored for the discovery, and it is only
Overrides the default keep alive timeout (in seconds). This
option will be ignored for discovery, and it is only
implemented for completeness.
-c <#>::
@ -163,14 +168,6 @@ OPTIONS
--ctrl-loss-tmo=<#>::
Overrides the default controller loss timeout period (in seconds).
-g::
--hdr_digest::
Generates/verifies header digest (TCP).
-G::
--data_digest::
Generates/verifies data digest (TCP).
-i <#>::
--nr-io-queues=<#>::
Overrides the default number of I/O queues create by the driver.
@ -192,9 +189,27 @@ OPTIONS
This option will be ignored for the discovery, and it is only
implemented for completeness.
--keyring=<#>::
Keyring for TLS key lookup.
--tls_key=<#>::
TLS key for the connection (TCP).
-g::
--hdr-digest::
Generates/verifies header digest (TCP).
-G::
--data-digest::
Generates/verifies data digest (TCP).
-p::
--persistent::
Persistent discovery connection.
Don't remove the discovery controller after retrieving the discovery
log page.
--tls::
Enable TLS encryption (TCP).
-S::
--quiet::

4
Documentation/nvme-dsm.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-dsm
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-DSM" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-DSM" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-dsm.html
View file

@ -893,7 +893,7 @@ any settings from the flags may have provided.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-effects-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-effects-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-EFFECTS\-LOG" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-EFFECTS\-LOG" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-effects-log.html
View file

@ -847,7 +847,7 @@ Have the program return the raw structure in binary:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-endurance-event-agg-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-endurance-event-agg-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ENDURANCE\-EVE" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ENDURANCE\-EVE" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-endurance-event-agg-log.html
View file

@ -851,7 +851,7 @@ Print the raw Endurance log to a file:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-endurance-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-endurance-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ENDURANCE\-LOG" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ENDURANCE\-LOG" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-endurance-log.html
View file

@ -834,7 +834,7 @@ Print the raw Endurance log to a file:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-error-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-error-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-ERROR\-LOG" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-ERROR\-LOG" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-error-log.html
View file

@ -849,7 +849,7 @@ Print the raw output to a file:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fdp-configs.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-configs
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FDP\-CONFIGS" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FDP\-CONFIGS" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fdp-configs.html
View file

@ -827,7 +827,7 @@ the possible configurations for Flexible Data Placement.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fdp-events.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-events
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FDP\-EVENTS" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FDP\-EVENTS" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fdp-events.html
View file

@ -827,7 +827,7 @@ Units and media usage in an Endurance Group.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fdp-set-events.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-set-events
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FDP\-SET\-EVEN" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FDP\-SET\-EVEN" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fdp-set-events.html
View file

@ -817,7 +817,7 @@ Handle.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fdp-stats.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FDP\-STATS" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FDP\-STATS" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fdp-stats.html
View file

@ -815,7 +815,7 @@ the life of the FDP configuration in an Endurance Group.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fdp-status.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-status
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FDP\-STATUS" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FDP\-STATUS" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fdp-status.html
View file

@ -815,7 +815,7 @@ are accessible by the specified namespace.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fdp-update.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-update
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FDP\-UPDATE" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FDP\-UPDATE" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fdp-update.html
View file

@ -802,7 +802,7 @@ a different Reclaim Unit accessible by the specified namespace.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fdp-usage.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fdp-usage
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FDP\-USAGE" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FDP\-USAGE" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fdp-usage.html
View file

@ -816,7 +816,7 @@ Endurance Group.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fid-support-effects-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fid-support-effects-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FID\-SUPPORT\-" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FID\-SUPPORT\-" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fid-support-effects-log.html
View file

@ -814,7 +814,7 @@ raw buffer may be printed to stdout.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-flush.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-flush
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FLUSH" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FLUSH" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-flush.html
View file

@ -800,7 +800,7 @@ any namespace.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-format.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-format
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FORMAT" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FORMAT" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-format.html
View file

@ -1035,7 +1035,7 @@ information:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fw-commit.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fw-commit
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FW\-COMMIT" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FW\-COMMIT" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fw-commit.html
View file

@ -905,7 +905,7 @@ commit the last downloaded fw to slot 1.
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fw-download.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fw-download
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FW\-DOWNLOAD" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FW\-DOWNLOAD" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fw-download.html
View file

@ -852,7 +852,7 @@ Transfer a firmware size 128KiB at a time:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-fw-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-fw-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-FW\-LOG" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-FW\-LOG" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-fw-log.html
View file

@ -835,7 +835,7 @@ Print the log firmware to a file:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-gen-hostnqn.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-gen-hostnqn
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GEN\-HOSTNQN" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-GEN\-HOSTNQN" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-gen-hostnqn.html
View file

@ -785,7 +785,7 @@ and prints it to stdout.</p></div>
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

49
Documentation/nvme-gen-tls-key.txt
View file

@ -8,18 +8,52 @@ nvme-gen-tls-key - Generate a NVMe TLS PSK
SYNOPSIS
--------
[verse]
'nvme gen-tls-key' [--hmac=<hmac-id> | -h <hmac-id>]
'nvme gen-tls-key' [--keyring=<name> | -k <name>]
[--keytype=<type> | -t <type> ]
[--hostnqn=<nqn> | -n <nqn>]
[--subsysnqn=<nqn> | -c <nqn>]
[--hmac=<hmac-id> | -h <hmac-id>]
[--secret=<secret> | -s <secret> ]
[--insert | -i ]
DESCRIPTION
-----------
Generate a base64-encoded NVMe TLS pre-shared key (PSK) in
the PSK interchange format
NVMeTLSkey-1:01:VRLbtnN9AQb2WXW3c9+wEf/DRLz0QuLdbYvEhwtdWwNf9LrZ:
and prints it to stdout.
Generate a base64-encoded NVMe TLS pre-shared key (PSK).
The resulting key is either printed in the PSK interchange format
'NVMeTLSkey-1:01:<base64 encoded data>:',
inserted as a 'retained' key into the specified keyring, or both.
When the PSK should be inserted into the keyring a 'retained' key
is derived from the secret key material, and the resulting 'retained'
key is stored with the identity
'NVMe0R0<hmac> <host NQN> <subsystem NQN>'
in the keyring.
The 'retained' key is derived from the secret key material,
the specified subsystem NQN, and the host NQN.
Once the 'retained' key is stored in the keyring the original
secret key material cannot be retrieved.
OPTIONS
-------
-k <name>::
--keyring=<name>::
Name of the keyring into which the 'retained' TLS key should be
stored. Default is '.nvme'.
-t <type>::
--keytype=<type>::
Type of the key for resulting TLS key.
Default is 'psk'.
-n <nqn>::
--hostnqn=<nqn>::
Host NVMe Qualified Name (NQN) to be used to derive the
'retained' TLS key
-c <nqn>::
--subsysnqn=<nqn>::
Subsystem NVMe Qualified Name (NQN) to be used to derive the
'retained' TLS key
-h <hmac-id>::
--hmac=<hmac-id>::
Select a HMAC algorithm to use. Possible values are:
@ -31,6 +65,11 @@ OPTIONS
Secret value (in hexadecimal) to be used for the key. If none are
provided a random value is used.
-i::
--insert::
Insert the resulting TLS key into the keyring without printing out
the key in PSK interchange format.
EXAMPLES
--------
No Examples

4
Documentation/nvme-get-feature.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-get-feature
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GET\-FEATURE" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-GET\-FEATURE" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-get-feature.html
View file

@ -977,7 +977,7 @@ format:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-get-lba-status.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-get-lba-status
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GET\-LBA\-STAT" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-GET\-LBA\-STAT" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-get-lba-status.html
View file

@ -896,7 +896,7 @@ Get LBA Status of the namespace 1 from SLBA 10 for the max Dwords of 0x1000
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

10
Documentation/nvme-get-log.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-get-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GET\-LOG" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-GET\-LOG" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
@ -43,6 +43,7 @@ nvme-get-log \- Retrieves a log page from an NVMe device
[\-\-rae | \-r]
[\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
[\-\-ot=<offset_type> | \-O <offset_type>]
[\-\-xfer\-len=<length> | \-x <length>]
.fi
.SH "DESCRIPTION"
.sp
@ -107,6 +108,11 @@ This field specifies the identifier of command set\&. if not issued, NVM Command
.RS 4
This field specifies the offset type\&. If set to false, the Log Page Offset Lower field and the Log Page Offset Upper field specify the byte offset into the log page to be returned\&. If set to true, the Log Page Offset Lower field and the Log Page Offset Upper field specify the index into the list of data structures in the log page to be returned\&. The default is byte offset\&. If the option is specified the index mode is used\&.
.RE
.PP
\-x <length>
.RS 4
\-\-xfer\-len <length>: Specify the read chunk size\&. The length argument is expected to be a multiple of 4096\&. The default size is 4096\&.
.RE
.SH "EXAMPLES"
.sp
.RS 4

15
Documentation/nvme-get-log.html
View file

@ -759,7 +759,8 @@ nvme-get-log(1) Manual Page
[--lsi=&lt;field&gt; | -S &lt;field&gt;]
[--rae | -r]
[--csi=&lt;command_set_identifier&gt; | -y &lt;command_set_identifier&gt;]
[--ot=&lt;offset_type&gt; | -O &lt;offset_type&gt;]</pre>
[--ot=&lt;offset_type&gt; | -O &lt;offset_type&gt;]
[--xfer-len=&lt;length&gt; | -x &lt;length&gt;]</pre>
<div class="attribution">
</div></div>
</div>
@ -918,6 +919,16 @@ program to parse.</p></div>
the index mode is used.
</p>
</dd>
<dt class="hdlist1">
-x &lt;length&gt;
</dt>
<dd>
<p>
--xfer-len &lt;length&gt;:
Specify the read chunk size. The length argument is expected to be
a multiple of 4096. The default size is 4096.
</p>
</dd>
</dl></div>
</div>
</div>
@ -962,7 +973,7 @@ Have the program return the raw log page in binary:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

6
Documentation/nvme-get-log.txt
View file

@ -19,6 +19,7 @@ SYNOPSIS
[--rae | -r]
[--csi=<command_set_identifier> | -y <command_set_identifier>]
[--ot=<offset_type> | -O <offset_type>]
[--xfer-len=<length> | -x <length>]
DESCRIPTION
-----------
@ -95,6 +96,11 @@ OPTIONS
The default is byte offset. If the option is specified
the index mode is used.
-x <length>::
--xfer-len <length>:
Specify the read chunk size. The length argument is expected to be
a multiple of 4096. The default size is 4096.
EXAMPLES
--------
* Get 512 bytes from log page 2

4
Documentation/nvme-get-ns-id.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-get-ns-id
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GET\-NS\-ID" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-GET\-NS\-ID" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-get-ns-id.html
View file

@ -794,7 +794,7 @@ Shows the namespace id for the given block device:
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-get-property.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-get-property
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-GET\-PROPERTY" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-GET\-PROPERTY" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

2
Documentation/nvme-get-property.html
View file

@ -843,7 +843,7 @@ Then look for NVMe Fabrics command (0x7f) at trace
<div id="footer">
<div id="footer-text">
Last updated
2023-01-30 14:14:16 CET
2023-03-31 16:17:28 CEST
</div>
</div>
</body>

4
Documentation/nvme-help.1
View file

@ -2,12 +2,12 @@
.\" Title: nvme-help
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\" Date: 01/30/2023
.\" Date: 03/31/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
.TH "NVME\-HELP" "1" "01/30/2023" "NVMe" "NVMe Manual"
.TH "NVME\-HELP" "1" "03/31/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------

Some files were not shown because too many files have changed in this diff Show more