.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ADMIN\-PASSTHR" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ADMIN\-PASSTHR" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme\-admin\-passthru\fR <device> [\-\-opcode=<opcode> | \-o <opcode>]
- [\-\-flags=<flags> | \-f <flags>] [\-rsvd=<rsvd> | \-R <rsvd>]
- [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-cdw2=<cdw2> | \-2 <cdw2>]
- [\-\-cdw3=<cdw3> | \-3 <cdw3>] [\-\-cdw10=<cdw10> | \-4 <cdw4>]
- [\-\-cdw11=<cdw11> | \-5 <cdw5>] [\-\-cdw12=<cdw12> | \-6 <cdw6>]
- [\-\-cdw13=<cdw13> | \-7 <cdw7>] [\-\-cdw14=<cdw14> | \-8 <cdw8>]
- [\-\-cdw15=<cdw15> | \-9 <cdw9>]
- [\-\-data\-len=<data\-len> | \-l <data\-len>]
- [\-\-metadata\-len=<len> | \-m <len>]
- [\-\-input\-file=<file> | \-i <file>]
- [\-\-read | \-r ] [\-\-write | \-w]
- [\-\-timeout=<to> | \-t <to>]
- [\-\-show\-command | \-s]
- [\-\-dry\-run | \-d]
- [\-\-raw\-binary | \-b]
- [\-\-prefill=<prefill> | \-p <prefill>]
- [\-\-latency | \-T]
+\fInvme\-admin\-passthru\fR <device> [\-\-opcode=<opcode> | \-O <opcode>]
+ [\-\-flags=<flags> | \-f <flags>] [\-rsvd=<rsvd> | \-R <rsvd>]
+ [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-cdw2=<cdw2> | \-2 <cdw2>]
+ [\-\-cdw3=<cdw3> | \-3 <cdw3>] [\-\-cdw10=<cdw10> | \-4 <cdw4>]
+ [\-\-cdw11=<cdw11> | \-5 <cdw5>] [\-\-cdw12=<cdw12> | \-6 <cdw6>]
+ [\-\-cdw13=<cdw13> | \-7 <cdw7>] [\-\-cdw14=<cdw14> | \-8 <cdw8>]
+ [\-\-cdw15=<cdw15> | \-9 <cdw9>]
+ [\-\-data\-len=<data\-len> | \-l <data\-len>]
+ [\-\-metadata\-len=<len> | \-m <len>]
+ [\-\-input\-file=<file> | \-i <file>]
+ [\-\-read | \-r] [\-\-write | \-w]
+ [\-\-timeout=<to> | \-t <to>]
+ [\-\-show\-command | \-s]
+ [\-\-dry\-run | \-d]
+ [\-\-raw\-binary | \-b]
+ [\-\-prefill=<prefill> | \-p <prefill>]
+ [\-\-latency | \-T]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the returned structure (if applicable) may be returned in one of several ways depending on the option flags; the structure may printed by the program as a hex dump, or may be returned as a raw buffer printed to stdout for another program to parse\&.
.SH "OPTIONS"
.PP
-\-o <opcode>, \-\-opcode=<opcode>
+\-O <opcode>, \-\-opcode=<opcode>
.RS 4
The NVMe opcode to send to the device in the command
.RE
.RS 4
Print out the latency the IOCTL took (in us)\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme-admin-passthru</em> <device> [--opcode=<opcode> | -o <opcode>]\r
- [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]\r
- [--namespace-id=<nsid> | -n <nsid>] [--cdw2=<cdw2> | -2 <cdw2>]\r
- [--cdw3=<cdw3> | -3 <cdw3>] [--cdw10=<cdw10> | -4 <cdw4>]\r
- [--cdw11=<cdw11> | -5 <cdw5>] [--cdw12=<cdw12> | -6 <cdw6>]\r
- [--cdw13=<cdw13> | -7 <cdw7>] [--cdw14=<cdw14> | -8 <cdw8>]\r
- [--cdw15=<cdw15> | -9 <cdw9>]\r
- [--data-len=<data-len> | -l <data-len>]\r
- [--metadata-len=<len> | -m <len>]\r
- [--input-file=<file> | -i <file>]\r
- [--read | -r ] [--write | -w]\r
- [--timeout=<to> | -t <to>]\r
- [--show-command | -s]\r
- [--dry-run | -d]\r
- [--raw-binary | -b]\r
- [--prefill=<prefill> | -p <prefill>]\r
- [--latency | -T]</pre>\r
+<pre class="content"><em>nvme-admin-passthru</em> <device> [--opcode=<opcode> | -O <opcode>]\r
+ [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]\r
+ [--namespace-id=<nsid> | -n <nsid>] [--cdw2=<cdw2> | -2 <cdw2>]\r
+ [--cdw3=<cdw3> | -3 <cdw3>] [--cdw10=<cdw10> | -4 <cdw4>]\r
+ [--cdw11=<cdw11> | -5 <cdw5>] [--cdw12=<cdw12> | -6 <cdw6>]\r
+ [--cdw13=<cdw13> | -7 <cdw7>] [--cdw14=<cdw14> | -8 <cdw8>]\r
+ [--cdw15=<cdw15> | -9 <cdw9>]\r
+ [--data-len=<data-len> | -l <data-len>]\r
+ [--metadata-len=<len> | -m <len>]\r
+ [--input-file=<file> | -i <file>]\r
+ [--read | -r] [--write | -w]\r
+ [--timeout=<to> | -t <to>]\r
+ [--show-command | -s]\r
+ [--dry-run | -d]\r
+ [--raw-binary | -b]\r
+ [--prefill=<prefill> | -p <prefill>]\r
+ [--latency | -T]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <opcode>\r
+-O <opcode>\r
</dt>\r
<dt class="hdlist1">\r
--opcode=<opcode>\r
Print out the latency the IOCTL took (in us).\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ANA\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ANA\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme ana\-log\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme ana\-log\fR <device> [\-\-groups | \-g]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Return the list of ANA groups without the namespace listing\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme ana-log</em> <device> [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme ana-log</em> <device> [--groups | -g]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Return the list of ANA groups without the namespace listing.\r
+ Return the list of ANA groups without the namespace listing.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ATTACH\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ATTACH\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.nf
\fInvme attach\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
The comma separated list of controller identifiers to attach the namespace too\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.if n \{\
.RS 4
.\}
.nf
-# nvme attach\-ns /dev/nvme1 \-n 0x2 \-c 0x21
+# nvme attach\-ns /dev/nvme1 \-n 0x2 \-c 0x21
.fi
.if n \{\
.RE
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme attach-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--controllers=<ctrl-list,> | -c <ctrl-list,>]</pre>\r
+ [--controllers=<ctrl-list,> | -c <ctrl-list,>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
the namespace too.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
</div></div>\r
<div class="literalblock">\r
<div class="content">\r
-<pre><code># nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21</code></pre>\r
+<pre><code># nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21</code></pre>\r
</div></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-BOOT\-PART\-LO" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-BOOT\-PART\-LO" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme boot\-part\-log\fR <device> [\-\-lsp=<field> | \-s <field>]
- [\-\-output\-file=<file> | \-o <file>]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-output\-file=<file> | \-f <file>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The log specified field of LID\&.
.RE
.PP
-\-o <file>, \-\-output\-file=<file>
+\-f <file>, \-\-output\-file=<file>
.RS 4
File name to which raw binary data will be saved to\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme boot-part-log</em> <device> [--lsp=<field> | -s <field>]\r
- [--output-file=<file> | -o <file>]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--output-file=<file> | -f <file>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <file>\r
+-f <file>\r
</dt>\r
<dt class="hdlist1">\r
--output-file=<file>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-CAPACITY\-MGMT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CAPACITY\-MGMT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme capacity\-mgmt\fR <device> [\-\-operation=<operation> | \-o <operation>]
+\fInvme capacity\-mgmt\fR <device> [\-\-operation=<operation> | \-O <operation>]
[\-\-element\-id=<element\-id> | \-i <element\-id>]
[\-\-cap\-lower=<cap\-lower> | \-l <cap\-lower>]
[\-\-cap\-upper=<cap\-upper> | \-u <cap\-upper>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
.SH "OPTIONS"
.PP
-\-o <operation>, \-\-operation=<operation>
+\-O <operation>, \-\-operation=<operation>
.RS 4
Operation to be performed by the controller
.RE
.RS 4
Most significant 32 bits of the capacity in bytes of the Endurance Group or NVM Set to be created
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples provided yet\&.
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>nvme-capacity-mgmt -\r
- Send capacity management command to configure/create/delete Endurance Groups or NVM Sets, returns results.\r
+ Send capacity management command to configure/create/delete Endurance Groups or NVM Sets, returns results.\r
</p>\r
</div>\r
</div>\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme capacity-mgmt</em> <device> [--operation=<operation> | -o <operation>]\r
+<pre class="content"><em>nvme capacity-mgmt</em> <device> [--operation=<operation> | -O <operation>]\r
[--element-id=<element-id> | -i <element-id>]\r
[--cap-lower=<cap-lower> | -l <cap-lower>]\r
- [--cap-upper=<cap-upper> | -u <cap-upper>]</pre>\r
+ [--cap-upper=<cap-upper> | -u <cap-upper>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <operation>\r
+-O <operation>\r
</dt>\r
<dt class="hdlist1">\r
--operation=<operation>\r
</dt>\r
<dd>\r
<p>\r
- Operation to be performed by the controller\r
+ Operation to be performed by the controller\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Value specific to the value of the Operation field.\r
+ Value specific to the value of the Operation field.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<dd>\r
<p>\r
Least significant 32 bits of the capacity in bytes of the Endurance Group or\r
- NVM Set to be created\r
+ NVM Set to be created\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<dd>\r
<p>\r
Most significant 32 bits of the capacity in bytes of the Endurance Group or\r
- NVM Set to be created\r
+ NVM Set to be created\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-CHANGED\-NS\-L" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CHANGED\-NS\-L" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme changed\-ns\-list\-log\fR <device> [\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw Changed Namespace List log buffer to stdout\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>nvme-changed-ns-list-log -\r
- Send NVMe Changed Namespace List log page request, returns result and log.\r
+ Send NVMe Changed Namespace List log page request, returns result and log.\r
</p>\r
</div>\r
</div>\r
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme changed-ns-list-log</em> <device> [--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-CMDSET\-IND\-I" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CMDSET\-IND\-I" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme cmdset\-ind\-id\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-b | \-\-raw\-binary]
- [\-\-human\-readable | \-H]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-raw\-binary | \-b] [\-\-human\-readable | \-H]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
This option will parse and format many of the bit fields into human\-readable formats\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme cmdset-ind-id-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [-b | --raw-binary]\r
- [--human-readable | -H]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--raw-binary | -b] [--human-readable | -H]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-COMPARE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-COMPARE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-dir\-type=<type> | \-T <type>]
[\-\-dir\-spec=<spec> | \-S <spec>]
[\-\-dsm=<dsm> | \-D <dsm>]
- [\-\-show\-command | \-v]
+ [\-\-show\-command | \-V]
[\-\-dry\-run | \-w]
[\-\-latency | \-t]
[\-\-storage\-tag<storage\-tag> | \-g <storage\-tag>]
[\-\-storage\-tag\-check | \-C]
[\-\-force]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
\-p <prinfo>, \-\-prinfo=<prinfo>
.RS 4
Protection Information and check field\&.
-.RE
-.sp
-+
.TS
allbox tab(:);
lt lt
lt lt
lt lt.
T{
-.sp
Bit
T}:T{
-.sp
Description
T}
T{
-.sp
3
T}:T{
-.sp
PRACT: Protection Information Action\&. When set to 1, PI is stripped/inserted on read/write when the block format\(cqs metadata size is 8\&. When set to 0, metadata is passes\&.
T}
T{
-.sp
2:0
T}:T{
-.sp
PRCHK: Protection Information Check:
T}
T{
-.sp
2
T}:T{
-.sp
Set to 1 enables checking the guard tag
T}
T{
-.sp
1
T}:T{
-.sp
Set to 1 enables checking the application tag
T}
T{
-.sp
0
T}:T{
-.sp
Set to 1 enables checking the reference tag
T}
.TE
.sp 1
+.RE
.PP
\-m <appmask>, \-\-app\-tag\-mask=<appmask>
.RS 4
The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&.
.RE
.PP
-\-v, \-\-show\-cmd
+\-V, \-\-show\-cmd
.RS 4
Print out the command to be sent\&.
.RE
.RS 4
Ignore namespace is currently busy and performed the operation even though\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
[--dir-type=<type> | -T <type>]\r
[--dir-spec=<spec> | -S <spec>]\r
[--dsm=<dsm> | -D <dsm>]\r
- [--show-command | -v]\r
+ [--show-command | -V]\r
[--dry-run | -w]\r
[--latency | -t]\r
[--storage-tag<storage-tag> | -g <storage-tag>]\r
[--storage-tag-check | -C]\r
- [--force]</pre>\r
+ [--force]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<p>\r
Protection Information and check field.\r
</p>\r
-</dd>\r
-</dl></div>\r
-<div class="paragraph"><p>+</p></div>\r
<div class="tableblock">\r
<table rules="all"\r
width="100%"\r
</tbody>\r
</table>\r
</div>\r
-<div class="dlist"><dl>\r
+</dd>\r
<dt class="hdlist1">\r
-m <appmask>\r
</dt>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--v\r
+-V\r
</dt>\r
<dt class="hdlist1">\r
--show-cmd\r
</dt>\r
<dd>\r
<p>\r
- Ignore namespace is currently busy and performed the operation\r
- even though.\r
+ Ignore namespace is currently busy and performed the operation\r
+ even though.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-CONNECT\-ALL" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CONNECT\-ALL" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme connect\-all\fR
- [\-\-transport=<trtype> | \-t <trtype>]
- [\-\-nqn=<subnqn> | \-n <subnqn>]
- [\-\-traddr=<traddr> | \-a <traddr>]
- [\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
- [\-\-host\-traddr=<traddr> | \-w <traddr>]
- [\-\-host\-iface=<iface> | \-f <iface>]
- [\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
- [\-\-hostid=<hostid> | \-I <hostid>]
- [\-\-raw=<filename> | \-r <filename>]
- [\-\-device=<device> | \-d <device>]
- [\-\-cfg\-file=<cfg> | \-C <cfg>]
- [\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
- [\-\-reconnect\-delay=<#> | \-c <#>]
- [\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
- [\-\-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]
- [\-\-nbft]
- [\-\-no\-nbft]
- [\-\-nbft\-path=<STR>]
- [\-\-context=<STR>]
+\fInvme connect\-all\fR [\-\-transport=<trtype> | \-t <trtype>]
+ [\-\-nqn=<subnqn> | \-n <subnqn>]
+ [\-\-traddr=<traddr> | \-a <traddr>]
+ [\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
+ [\-\-host\-traddr=<traddr> | \-w <traddr>]
+ [\-\-host\-iface=<iface> | \-f <iface>]
+ [\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
+ [\-\-hostid=<hostid> | \-I <hostid>]
+ [\-\-raw=<filename> | \-r <filename>]
+ [\-\-device=<device> | \-d <device>]
+ [\-\-cfg\-file=<cfg> | \-C <cfg>]
+ [\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
+ [\-\-reconnect\-delay=<#> | \-c <#>]
+ [\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
+ [\-\-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] [\-\-nbft] [\-\-no\-nbft]
+ [\-\-nbft\-path=<STR>] [\-\-context=<STR>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
.RS 4
.\}
.nf
-# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the
+# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the
# Discovery Controller\*(Aqs two ports (some resources may only
-# be accessible on a single port)\&. Note an official
+# be accessible on a single port)\&. Note an official
# nqn (Host) name defined in the NVMe specification is being used
# in this example\&.
\-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme connect-all</em>\r
- [--transport=<trtype> | -t <trtype>]\r
- [--nqn=<subnqn> | -n <subnqn>]\r
- [--traddr=<traddr> | -a <traddr>]\r
- [--trsvcid=<trsvcid> | -s <trsvcid>]\r
- [--host-traddr=<traddr> | -w <traddr>]\r
- [--host-iface=<iface> | -f <iface>]\r
- [--hostnqn=<hostnqn> | -q <hostnqn>]\r
- [--hostid=<hostid> | -I <hostid>]\r
- [--raw=<filename> | -r <filename>]\r
- [--device=<device> | -d <device>]\r
- [--cfg-file=<cfg> | -C <cfg>]\r
- [--keep-alive-tmo=<sec> | -k <sec>]\r
- [--reconnect-delay=<#> | -c <#>]\r
- [--ctrl-loss-tmo=<#> | -l <#>]\r
- [--nr-io-queues=<#> | -i <#>]\r
- [--nr-write-queues=<#> | -W <#>]\r
- [--nr-poll-queues=<#> | -P <#>]\r
- [--queue-size=<#> | -Q <#>]\r
- [--keyring=<#> ]\r
- [--tls_key=<#> ]\r
- [--hdr-digest | -g]\r
- [--data-digest | -G]\r
- [--persistent | -p]\r
- [--tls ]\r
- [--quiet | -S]\r
- [--dump-config | -O]\r
- [--nbft]\r
- [--no-nbft]\r
- [--nbft-path=<STR>]\r
- [--context=<STR>]</pre>\r
+<pre class="content"><em>nvme connect-all</em> [--transport=<trtype> | -t <trtype>]\r
+ [--nqn=<subnqn> | -n <subnqn>]\r
+ [--traddr=<traddr> | -a <traddr>]\r
+ [--trsvcid=<trsvcid> | -s <trsvcid>]\r
+ [--host-traddr=<traddr> | -w <traddr>]\r
+ [--host-iface=<iface> | -f <iface>]\r
+ [--hostnqn=<hostnqn> | -q <hostnqn>]\r
+ [--hostid=<hostid> | -I <hostid>]\r
+ [--raw=<filename> | -r <filename>]\r
+ [--device=<device> | -d <device>]\r
+ [--cfg-file=<cfg> | -C <cfg>]\r
+ [--keep-alive-tmo=<sec> | -k <sec>]\r
+ [--reconnect-delay=<#> | -c <#>]\r
+ [--ctrl-loss-tmo=<#> | -l <#>]\r
+ [--nr-io-queues=<#> | -i <#>]\r
+ [--nr-write-queues=<#> | -W <#>]\r
+ [--nr-poll-queues=<#> | -P <#>]\r
+ [--queue-size=<#> | -Q <#>] [--keyring=<#>]\r
+ [--tls_key=<#>] [--hdr-digest | -g] [--data-digest | -G]\r
+ [--persistent | -p] [--tls] [--quiet | -S]\r
+ [--dump-config | -O] [--nbft] [--no-nbft]\r
+ [--nbft-path=<STR>] [--context=<STR>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<dd>\r
<p>\r
This field specifies the network fabric being used for\r
- a NVMe-over-Fabrics network. Current string values include:\r
+ a NVMe-over-Fabrics network. Current string values include:\r
</p>\r
<div class="tableblock">\r
<table rules="all"\r
</dt>\r
<dd>\r
<p>\r
- This field specifies the transport service id. For transports using IP\r
+ This field specifies the transport service id. For transports using IP\r
addressing (e.g. rdma) this field is the port number. By default, the IP\r
port number for the RDMA transport is 4420.\r
</p>\r
the management of the global resources.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
</p>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><code># Machine default 'nvme discover' commands. Query the\r
+<pre><code># Machine default 'nvme discover' commands. Query the\r
# Discovery Controller's two ports (some resources may only\r
-# be accessible on a single port). Note an official\r
+# be accessible on a single port). Note an official\r
# nqn (Host) name defined in the NVMe specification is being used\r
# in this example.\r
-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-connect
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-CONNECT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CONNECT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme connect\fR
- [\-\-transport=<trtype> | \-t <trtype>]
- [\-\-nqn=<subnqn> | \-n <subnqn>]
- [\-\-traddr=<traddr> | \-a <traddr>]
- [\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
- [\-\-host\-traddr=<traddr> | \-w <traddr>]
- [\-\-host\-iface=<iface> | \-f <iface>]
- [\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
- [\-\-hostid=<hostid> | \-I <hostid>]
- [\-\-config\-file=<cfg> | \-J <cfg> ]
- [\-\-dhchap\-secret=<secret> | \-S <secret>]
- [\-\-dhchap\-ctrl\-secret=<secret> | \-C <secret>]
- [\-\-nr\-io\-queues=<#> | \-i <#>]
- [\-\-nr\-write\-queues=<#> | \-W <#>]
- [\-\-nr\-poll\-queues=<#> | \-P <#>]
- [\-\-queue\-size=<#> | \-Q <#>]
- [\-\-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>]
- [\-\-context=<id> ]
+\fInvme connect\fR [\-\-transport=<trtype> | \-t <trtype>]
+ [\-\-nqn=<subnqn> | \-n <subnqn>]
+ [\-\-traddr=<traddr> | \-a <traddr>]
+ [\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
+ [\-\-host\-traddr=<traddr> | \-w <traddr>]
+ [\-\-host\-iface=<iface> | \-f <iface>]
+ [\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
+ [\-\-hostid=<hostid> | \-I <hostid>]
+ [\-\-config\-file=<cfg> | \-J <cfg>]
+ [\-\-dhchap\-secret=<secret> | \-S <secret>]
+ [\-\-dhchap\-ctrl\-secret=<secret> | \-C <secret>]
+ [\-\-nr\-io\-queues=<#> | \-i <#>]
+ [\-\-nr\-write\-queues=<#> | \-W <#>]
+ [\-\-nr\-poll\-queues=<#> | \-P <#>]
+ [\-\-queue\-size=<#> | \-Q <#>]
+ [\-\-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] [\-\-application=<id>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
\-S <secret>, \-\-dhchap\-secret=<secret>
.RS 4
NVMe In\-band authentication secret; needs to be in ASCII format as specified in NVMe 2\&.0 section 8\&.13\&.5\&.8
-\fISecret representation\fR\&. If this option is not specified, the default is read from /usr/local/etc/nvme/hostkey\&. If that does not exist no in\-band authentication is attempted\&.
+\fISecret representation\fR\&.
.RE
.PP
\-C <secret>, \-\-dhchap\-ctrl\-secret=<secret>
Print out resulting JSON configuration file to stdout\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-\-context <STR>
+.RS 4
+Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&.
+.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
-\fInormal\fR
+\fInormal\fR,
+\fIjson\fR
or
-\fIjson\fR\&. Only one output format can be used at a time\&. When this option is specified, the device associated with the connection will be printed\&. Nothing is printed otherwise\&.
+\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
-\-\-context <STR>
+\-v, \-\-verbose
.RS 4
-Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&.
+Increase the information detail in the output\&.
.RE
.SH "EXAMPLES"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme connect</em>\r
- [--transport=<trtype> | -t <trtype>]\r
- [--nqn=<subnqn> | -n <subnqn>]\r
- [--traddr=<traddr> | -a <traddr>]\r
- [--trsvcid=<trsvcid> | -s <trsvcid>]\r
- [--host-traddr=<traddr> | -w <traddr>]\r
- [--host-iface=<iface> | -f <iface>]\r
- [--hostnqn=<hostnqn> | -q <hostnqn>]\r
- [--hostid=<hostid> | -I <hostid>]\r
- [--config-file=<cfg> | -J <cfg> ]\r
- [--dhchap-secret=<secret> | -S <secret>]\r
- [--dhchap-ctrl-secret=<secret> | -C <secret>]\r
- [--nr-io-queues=<#> | -i <#>]\r
- [--nr-write-queues=<#> | -W <#>]\r
- [--nr-poll-queues=<#> | -P <#>]\r
- [--queue-size=<#> | -Q <#>]\r
- [--keep-alive-tmo=<#> | -k <#>]\r
- [--reconnect-delay=<#> | -c <#>]\r
- [--ctrl-loss-tmo=<#> | -l <#>]\r
- [--tos=<#> | -T <#>]\r
- [--keyring=<#> ]\r
- [--tls_key=<#> ]\r
- [--duplicate-connect | -D]\r
- [--disable-sqflow | -d]\r
- [--hdr-digest | -g]\r
- [--data-digest | -G]\r
- [--tls ]\r
- [--dump-config | -O]\r
- [--output-format=<fmt> | -o <fmt>]\r
- [--application=<id> ]</pre>\r
+<pre class="content"><em>nvme connect</em> [--transport=<trtype> | -t <trtype>]\r
+ [--nqn=<subnqn> | -n <subnqn>]\r
+ [--traddr=<traddr> | -a <traddr>]\r
+ [--trsvcid=<trsvcid> | -s <trsvcid>]\r
+ [--host-traddr=<traddr> | -w <traddr>]\r
+ [--host-iface=<iface> | -f <iface>]\r
+ [--hostnqn=<hostnqn> | -q <hostnqn>]\r
+ [--hostid=<hostid> | -I <hostid>]\r
+ [--config-file=<cfg> | -J <cfg>]\r
+ [--dhchap-secret=<secret> | -S <secret>]\r
+ [--dhchap-ctrl-secret=<secret> | -C <secret>]\r
+ [--nr-io-queues=<#> | -i <#>]\r
+ [--nr-write-queues=<#> | -W <#>]\r
+ [--nr-poll-queues=<#> | -P <#>]\r
+ [--queue-size=<#> | -Q <#>]\r
+ [--keep-alive-tmo=<#> | -k <#>]\r
+ [--reconnect-delay=<#> | -c <#>]\r
+ [--ctrl-loss-tmo=<#> | -l <#>] [--tos=<#> | -T <#>]\r
+ [--keyring=<#>] [--tls_key=<#>]\r
+ [--duplicate-connect | -D] [--disable-sqflow | -d]\r
+ [--hdr-digest | -g] [--data-digest | -G] [--tls]\r
+ [--dump-config | -O] [--application=<id>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<dd>\r
<p>\r
This field specifies the network fabric being used for\r
- a NVMe-over-Fabrics network. Current string values include:\r
+ a NVMe-over-Fabrics network. Current string values include:\r
</p>\r
<div class="tableblock">\r
<table rules="all"\r
</dt>\r
<dd>\r
<p>\r
- This field specifies the transport service id. For transports using IP\r
+ This field specifies the transport service id. For transports using IP\r
addressing (e.g. rdma) this field is the port number. By default, the IP\r
port number for the RDMA transport is 4420.\r
</p>\r
<p>\r
NVMe In-band authentication secret; needs to be in ASCII format as\r
specified in NVMe 2.0 section 8.13.5.8 <em>Secret representation</em>.\r
- If this option is not specified, the default is read from\r
- /usr/local/etc/nvme/hostkey. If that does not exist no in-band authentication\r
- is attempted.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+--context <STR>\r
</dt>\r
+<dd>\r
+<p>\r
+ Set the execution context to <STR>. This allows to coordinate\r
+ the management of the global resources.\r
+</p>\r
+</dd>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em> or <em>json</em>. Only one output format can\r
- be used at a time. When this option is specified, the device associated with\r
- the connection will be printed. Nothing is printed otherwise.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---context <STR>\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
</dt>\r
<dd>\r
<p>\r
- Set the execution context to <STR>. This allows to coordinate\r
- the management of the global resources.\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-COPY" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-COPY" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
\fInvme\-copy\fR <device> [\-\-sdlba=<sdlba> | \-d <sdlba>]
[\-\-blocks=<nlb\-list,> | \-b <nlb\-list,>]
[\-\-slbs=<slbas,> | \-s <slbas,>]
+ [\-\-snsids=<snsids,> | \-N <snsids,>]
+ [\-\-sopts=<sopts,> | \-O <sopts,>]
[\-\-limited\-retry | \-l]
[\-\-force\-unit\-access | \-f]
[\-\-prinfow=<prinfow> | \-p <prinfow>]
[\-\-dir\-type=<type> | \-T <type>]
[\-\-dir\-spec=<spec> | \-S <spec>]
[\-\-format=<entry\-format> | \-F <entry\-format>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The Copy command is used by the host to copy data from one or more source logical block ranges to a single consecutive destination logical block range\&.
.SH "OPTIONS"
.PP
-\-\-sdlba=<sdlba>, \-d <sdlba>
+\-d <sdlba>, \-\-sdlba=<sdlba>
.RS 4
64\-bit addr of first destination logical block
.RE
.PP
-\-\-blocks=<nlb\-list,>, \-b <nlb\-list,>
+\-b <nlb\-list,>, \-\-blocks=<nlb\-list,>
.RS 4
Comma separated list of the number of blocks in each range
.RE
.PP
-\-\-slbs=<slbas,>, \-s <slbas,>
+\-s <slbas,>, \-\-slbs=<slbas,>
.RS 4
Comma separated list of the starting blocks in each range
.RE
.PP
-\-\-limited\-retry, \-l
+\-\-snsids=<snsids,>, \-N <snsids,>
+.RS 4
+Comma separated list of the source namespace identifiers in each range
+.RE
+.PP
+\-\-sopts=<sopts,>, \-O <sopts,>
+.RS 4
+Comma separated list of the source options in each range
+.RE
+.PP
+\-l, \-\-limited\-retry
.RS 4
Sets the limited retry flag\&.
.RE
.PP
-\-\-force\-unit\-access, \-f
+\-f, \-\-force\-unit\-access
.RS 4
Set the force\-unit access flag\&.
.RE
.PP
-\-
\-prinfow=<prinfow>, \-p <prinfow>
+\-
p <prinfow>, \-\-prinfow=<prinfow>
.RS 4
Protection Information field write definition\&.
.RE
.PP
-\-
\-prinfor=<prinfor>, \-P <prinfor>
+\-
P <prinfor>, \-\-prinfor=<prinfor>
.RS 4
Protection Information field read definition\&.
.RE
.PP
-\-\-ref\-tag=<reftag>, \-r <reftag>
+\-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4
initial lba reference tag\&.
.RE
.PP
-\-\-expected\-ref\-tags=<reftag,>, \-R <reftag,>
+\-R <reftag,>, \-\-expected\-ref\-tags=<reftag,>
.RS 4
expected lba reference tags (comma\-separated list)\&.
.RE
.PP
-\-
\-app\-tag=<apptag>, \-a <apptag>
+\-
a <apptag>, \-\-app\-tag=<apptag>
.RS 4
lba app tag
.RE
.PP
-\-
\-expected\-app\-tags=<apptag,>, \-A <apptag,>
+\-
A <apptag,>, \-\-expected\-app\-tags=<apptag,>
.RS 4
expected lba app tags (comma\-separated list)
.RE
.PP
-\-
\-app\-mask=<appmask>, \-m <appmask>
+\-
m <appmask>, \-\-app\-mask=<appmask>
.RS 4
lba tag mask
.RE
.PP
-\-
\-expected\-app\-masks=<appmask,>, \-M <appmask,>
+\-
M <appmask,>, \-\-expected\-app\-masks=<appmask,>
.RS 4
expected lba tag masks (comma\-separated list)
.RE
.PP
-\-\-dir\-type=<type>, \-T <type>
+\-T <type>, \-\-dir\-type=<type>
.RS 4
Optional directive type\&. The nvme\-cli only enforces the value be in the defined range for the directive type, though the NVMe specification (1\&.3a) defines only one directive, 01h, for write stream identifiers\&.
.RE
.PP
-\-\-dir\-spec=<spec>, \-S <spec>
+\-S <spec>, \-\-dir\-spec=<spec>
.RS 4
Optional field for directive specifics\&. When used with write streams, this value is defined to be the write stream identifier\&. The nvme\-cli will not validate the stream requested is within the controller\(cqs capabilities\&.
.RE
.PP
-\-\-format=<entry\-format>, \-F <entry\-format>
+\-F <entry\-format>, \-\-format=<entry\-format>
.RS 4
source range entry format
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
<pre class="content"><em>nvme-copy</em> <device> [--sdlba=<sdlba> | -d <sdlba>]\r
[--blocks=<nlb-list,> | -b <nlb-list,>]\r
[--slbs=<slbas,> | -s <slbas,>]\r
+ [--snsids=<snsids,> | -N <snsids,>]\r
+ [--sopts=<sopts,> | -O <sopts,>]\r
[--limited-retry | -l]\r
[--force-unit-access | -f]\r
[--prinfow=<prinfow> | -p <prinfow>]\r
[--expected-app-masks=<appmask,> | -M <appmask,>]\r
[--dir-type=<type> | -T <type>]\r
[--dir-spec=<spec> | -S <spec>]\r
- [--format=<entry-format> | -F <entry-format>]</pre>\r
+ [--format=<entry-format> | -F <entry-format>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
---sdlba=<sdlba>\r
+-d <sdlba>\r
</dt>\r
<dt class="hdlist1">\r
--d <sdlba>\r
+--sdlba=<sdlba>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---blocks=<nlb-list,>\r
+-b <nlb-list,>\r
</dt>\r
<dt class="hdlist1">\r
--b <nlb-list,>\r
+--blocks=<nlb-list,>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---slbs=<slbas,>\r
+-s <slbas,>\r
</dt>\r
<dt class="hdlist1">\r
--s <slbas,>\r
+--slbs=<slbas,>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---limited-retry\r
+--snsids=<snsids,>\r
+</dt>\r
+<dt class="hdlist1">\r
+-N <snsids,>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Comma separated list of the source namespace identifiers in each range\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+--sopts=<sopts,>\r
</dt>\r
<dt class="hdlist1">\r
+-O <sopts,>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Comma separated list of the source options in each range\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
-l\r
</dt>\r
+<dt class="hdlist1">\r
+--limited-retry\r
+</dt>\r
<dd>\r
<p>\r
Sets the limited retry flag.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---force-unit-access\r
+-f\r
</dt>\r
<dt class="hdlist1">\r
--f\r
+--force-unit-access\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---prinfow=<prinfow>\r
+-p <prinfow>\r
</dt>\r
<dt class="hdlist1">\r
--p <prinfow>\r
+--prinfow=<prinfow>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---prinfor=<prinfor>\r
+-P <prinfor>\r
</dt>\r
<dt class="hdlist1">\r
--P <prinfor>\r
+--prinfor=<prinfor>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---ref-tag=<reftag>\r
+-r <reftag>\r
</dt>\r
<dt class="hdlist1">\r
--r <reftag>\r
+--ref-tag=<reftag>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---expected-ref-tags=<reftag,>\r
+-R <reftag,>\r
</dt>\r
<dt class="hdlist1">\r
--R <reftag,>\r
+--expected-ref-tags=<reftag,>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag=<apptag>\r
+-a <apptag>\r
</dt>\r
<dt class="hdlist1">\r
--a <apptag>\r
+--app-tag=<apptag>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---expected-app-tags=<apptag,>\r
+-A <apptag,>\r
</dt>\r
<dt class="hdlist1">\r
--A <apptag,>\r
+--expected-app-tags=<apptag,>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-mask=<appmask>\r
+-m <appmask>\r
</dt>\r
<dt class="hdlist1">\r
--m <appmask>\r
+--app-mask=<appmask>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---expected-app-masks=<appmask,>\r
+-M <appmask,>\r
</dt>\r
<dt class="hdlist1">\r
--M <appmask,>\r
+--expected-app-masks=<appmask,>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---dir-type=<type>\r
+-T <type>\r
</dt>\r
<dt class="hdlist1">\r
--T <type>\r
+--dir-type=<type>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---dir-spec=<spec>\r
+-S <spec>\r
</dt>\r
<dt class="hdlist1">\r
--S <spec>\r
+--dir-spec=<spec>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---format=<entry-format>\r
+-F <entry-format>\r
</dt>\r
<dt class="hdlist1">\r
--F <entry-format>\r
+--format=<entry-format>\r
</dt>\r
<dd>\r
<p>\r
source range entry format\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-CREATE\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-CREATE\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-nmic=<nmic> | \-m <nmic>]
[\-\-anagrp\-id=<anagrpid> | \-a <anagrpid>]
[\-\-nvmset\-id=<nvmsetid> | \-i <nvmsetid>]
+ [\-\-endg\-id=<endgid> | \-e <endgid>]
[\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
[\-\-lbstm=<lbstm> | \-l <lbstm>]
[\-\-nphndls=<nphndls> | \-n <nphndls>]
[\-\-ncap\-si=<ncap\-si> | \-C <ncap\-si>]
[\-\-azr | \-z]
[\-\-rar=<rar> | \-r <rar>]
- [\-\-ror=<ror> | \-o <ror>]
+ [\-\-ror=<ror> | \-O <ror>]
[\-\-rnumzrwa=<rnumzrwa> | \-u <rnumzrwa>]
[\-\-phndls=<placement\-handle\-list,> | \-p <placement\-handle\-list,>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
This field specifies the identifier of the NVM Set\&.
.RE
.PP
+\-e <endgid>, \-\-endg\-id=<endgid>
+.RS 4
+This field specifies the identifier of the endurance group\&.
+.RE
+.PP
\-y <command_set_identifier>, \-\-csi=<command_set_identifier>
.RS 4
This field specifies the identifier of command set\&. if not issued, NVM Command Set will be selected\&.
Requested Active Resources\&. This field specifies the number of active resources to be allocated to the created namespace\&.
.RE
.PP
-\-o <ror>, \-\-ror=<ror>
+\-O <ror>, \-\-ror=<ror>
.RS 4
Requested Open Resources\&. This field specifies the number of open resources to be allocated to the created namespace\&.
.RE
.RS 4
The comma separated list of Reclaim Unit Handle Identifier to be associated with each Placement Handle\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
[--ncap-si=<ncap-si> | -C <ncap-si>]\r
[--azr | -z]\r
[--rar=<rar> | -r <rar>]\r
- [--ror=<ror> | -o <ror>]\r
+ [--ror=<ror> | -O <ror>]\r
[--rnumzrwa=<rnumzrwa> | -u <rnumzrwa>]\r
- [--phndls=<placement-handle-list,> | -p <placement-handle-list,>]</pre>\r
+ [--phndls=<placement-handle-list,> | -p <placement-handle-list,>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<dd>\r
<p>\r
Target block size the new namespace should be formatted as. Potential FLBAS\r
- values will be values will be scanned and the lowest numbered will be\r
- selected for the create-ns operation. Conflicts with --flbas argument.\r
+ values will be values will be scanned and the lowest numbered will be\r
+ selected for the create-ns operation. Conflicts with --flbas argument.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <ror>\r
+-O <ror>\r
</dt>\r
<dt class="hdlist1">\r
--ror=<ror>\r
with each Placement Handle.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme delete\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
The namespace identifier to delete\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme delete-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]</pre>\r
+<pre class="content"><em>nvme delete-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
The namespace identifier to delete.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DERA\-STAT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DERA\-STAT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DETACH\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DETACH\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.nf
\fInvme detach\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-controllers=<ctrl\-list,> | \-c <ctrl\-list,>
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The namespace identifier to detach\&.
.RE
.PP
-\-c <ctrl\-list,>, \-controllers=<ctrl\-list,>
+\-c <ctrl\-list,>, \-\-controllers=<ctrl\-list,>
.RS 4
The comma separated list of controller identifiers to detach the namespace from\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme detach-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--controllers=<ctrl-list,> | -c <ctrl-list,></pre>\r
+ [--controllers=<ctrl-list,> | -c <ctrl-list,>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
-c <ctrl-list,>\r
</dt>\r
<dt class="hdlist1">\r
--controllers=<ctrl-list,>\r
+--controllers=<ctrl-list,>\r
</dt>\r
<dd>\r
<p>\r
the namespace from.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DEVICE\-SELF\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DEVICE\-SELF\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme device\-self\-test\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-self\-test\-code=<NUM> | \-s <NUM>] [\-\-wait | \-w]
+ [\-\-self\-test\-code=<NUM> | \-s <NUM>] [\-\-wait | \-w]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Wait for the device self test to complete before exiting The device self\-test is aborted by SIGINT signal interrupt for the wait The option is ignored if the abort self\-test code option specified\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme device-self-test</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--self-test-code=<NUM> | -s <NUM>] [--wait | -w]</pre>\r
+ [--self-test-code=<NUM> | -s <NUM>] [--wait | -w]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
The option is ignored if the abort self-test code option specified.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DIM" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DIM" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme dim\fR
- [\-\-task=<task> | \-t <task>]
- [\-\-nqn=<nqn> | \-n <nqn>]
- [\-\-device=<device> | \-d <device>]
+\fInvme dim\fR [\-\-task=<task> | \-t <task>] [\-\-nqn=<nqn> | \-n <nqn>]
+ [\-\-device=<device> | \-d <device>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
The DIM command will be sent to the Discovery Controllers (DC) associated with this NVMe device handle\&. A list of comma\-separated device handles can be supplied to apply the command to more than one DC\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme dim</em>\r
- [--task=<task> | -t <task>]\r
- [--nqn=<nqn> | -n <nqn>]\r
- [--device=<device> | -d <device>]</pre>\r
+<pre class="content"><em>nvme dim</em> [--task=<task> | -t <task>] [--nqn=<nqn> | -n <nqn>]\r
+ [--device=<device> | -d <device>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
be supplied to apply the command to more than one DC.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DIR\-RECEIVE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DIR\-RECEIVE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme dir\-receive\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-data\-len=<data\-len> | \-l <data\-len>]
- [\-\-dir\-type=<dtype> | \-D <dtype>]
- [\-\-dir\-spec=<dspec> | \-S <dspec>]
- [\-\-dir\-oper=<doper> | \-O <doper>]
- [\-\-req\-resource=<nsr> | \-r <nsr>]
- [\-\-human\-readable | \-H]
- [\-\-raw\-binary | \-b]
+ [\-\-data\-len=<data\-len> | \-l <data\-len>]
+ [\-\-dir\-type=<dtype> | \-D <dtype>]
+ [\-\-dir\-spec=<dspec> | \-S <dspec>]
+ [\-\-dir\-oper=<doper> | \-O <doper>]
+ [\-\-req\-resource=<nsr> | \-r <nsr>]
+ [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
\-r <nsr>, \-\-req\-resource=<nsr>
.RS 4
Directive requested resource count
-.RE
-.sp
-+
.TS
allbox tab(:);
lt lt
lt lt
lt lt.
T{
-.sp
Select
T}:T{
-.sp
Description
T}
T{
-.sp
0
T}:T{
-.sp
Current
T}
T{
-.sp
1
T}:T{
-.sp
Default
T}
T{
-.sp
2
T}:T{
-.sp
Saved
T}
T{
-.sp
3
T}:T{
-.sp
Supported capabilities
T}
T{
-.sp
4\(en7
T}:T{
-.sp
Reserved
T}
.TE
.sp 1
+.RE
.PP
\-l <data\-len>, \-\-data\-len=<data\-len>
.RS 4
.RS 4
Print the decoded receive buffer to stdout if the command returns a structure\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme dir-receive</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--data-len=<data-len> | -l <data-len>]\r
- [--dir-type=<dtype> | -D <dtype>]\r
- [--dir-spec=<dspec> | -S <dspec>]\r
- [--dir-oper=<doper> | -O <doper>]\r
- [--req-resource=<nsr> | -r <nsr>]\r
- [--human-readable | -H]\r
- [--raw-binary | -b]</pre>\r
+ [--data-len=<data-len> | -l <data-len>]\r
+ [--dir-type=<dtype> | -D <dtype>]\r
+ [--dir-spec=<dspec> | -S <dspec>]\r
+ [--dir-oper=<doper> | -O <doper>]\r
+ [--req-resource=<nsr> | -r <nsr>]\r
+ [--human-readable | -H] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<p>\r
Directive requested resource count\r
</p>\r
-</dd>\r
-</dl></div>\r
-<div class="paragraph"><p>+</p></div>\r
<div class="tableblock">\r
<table rules="all"\r
width="100%"\r
</tbody>\r
</table>\r
</div>\r
-<div class="dlist"><dl>\r
+</dd>\r
<dt class="hdlist1">\r
-l <data-len>\r
</dt>\r
a structure.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DIR\-SEND" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DIR\-SEND" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme dir\-send\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-data\-len=<data\-len> | \-l <data\-len>]
- [\-\-dir\-type=<dtype> | \-D <dtype>]
- [\-\-dir\-spec=<dspec> | \-S <dspec>]
- [\-\-dir\-oper=<doper> | \-O <doper>]
- [\-\-endir=<endir> | \-e <endir>]
- [\-\-target\-dir=<tdir> | \-T <tdir>]
- [\-\-human\-readable | \-H]
- [\-\-raw\-binary | \-b]
+ [\-\-data\-len=<data\-len> | \-l <data\-len>]
+ [\-\-dir\-type=<dtype> | \-D <dtype>]
+ [\-\-dir\-spec=<dspec> | \-S <dspec>]
+ [\-\-dir\-oper=<doper> | \-O <doper>]
+ [\-\-endir=<endir> | \-e <endir>]
+ [\-\-target\-dir=<tdir> | \-T <tdir>]
+ [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
\-e <endir>, \-\-endir=<endir>
.RS 4
Target directive enable(1) or disable (0) operation
-.RE
-.sp
-+
.TS
allbox tab(:);
lt lt
lt lt
lt lt.
T{
-.sp
Select
T}:T{
-.sp
Description
T}
T{
-.sp
0
T}:T{
-.sp
Current
T}
T{
-.sp
1
T}:T{
-.sp
Default
T}
T{
-.sp
2
T}:T{
-.sp
Saved
T}
T{
-.sp
3
T}:T{
-.sp
Supported capabilities
T}
T{
-.sp
4\(en7
T}:T{
-.sp
Reserved
T}
.TE
.sp 1
+.RE
.PP
\-l <data\-len>, \-\-data\-len=<data\-len>
.RS 4
.RS 4
Print the decoded receive buffer to stdout if the command returns a structure\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme dir-send</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--data-len=<data-len> | -l <data-len>]\r
- [--dir-type=<dtype> | -D <dtype>]\r
- [--dir-spec=<dspec> | -S <dspec>]\r
- [--dir-oper=<doper> | -O <doper>]\r
- [--endir=<endir> | -e <endir>]\r
- [--target-dir=<tdir> | -T <tdir>]\r
- [--human-readable | -H]\r
- [--raw-binary | -b]</pre>\r
+ [--data-len=<data-len> | -l <data-len>]\r
+ [--dir-type=<dtype> | -D <dtype>]\r
+ [--dir-spec=<dspec> | -S <dspec>]\r
+ [--dir-oper=<doper> | -O <doper>]\r
+ [--endir=<endir> | -e <endir>]\r
+ [--target-dir=<tdir> | -T <tdir>]\r
+ [--human-readable | -H] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<p>\r
Target directive enable(1) or disable (0) operation\r
</p>\r
-</dd>\r
-</dl></div>\r
-<div class="paragraph"><p>+</p></div>\r
<div class="tableblock">\r
<table rules="all"\r
width="100%"\r
</tbody>\r
</table>\r
</div>\r
-<div class="dlist"><dl>\r
+</dd>\r
<dt class="hdlist1">\r
-l <data-len>\r
</dt>\r
a structure.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DISCONNECT\-AL" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DISCONNECT\-AL" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme disconnect\-all\fR
+\fInvme disconnect\-all\fR [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Disconnects and removes all existing NVMe over Fabrics controllers\&.
.sp
See the documentation for the nvme\-disconnect(1) command for further background\&.
+.SH "OPTIONS"
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme disconnect-all</em></pre>\r
+<pre class="content"><em>nvme disconnect-all</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</div>\r
</div>\r
<div class="sect1">\r
+<h2 id="_options">OPTIONS</h2>\r
+<div class="sectionbody">\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
+</dl></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
<h2 id="_examples">EXAMPLES</h2>\r
<div class="sectionbody">\r
<div class="ulist"><ul>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DISCONNECT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DISCONNECT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme disconnect\fR
- [\-\-nqn=<subnqn> | \-n <subnqn>]
- [\-\-device=<device> | \-d <device>]
+\fInvme disconnect\fR [\-\-nqn=<subnqn> | \-n <subnqn>]
+ [\-\-device=<device> | \-d <device>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Indicates that the controller with the specified name should be removed\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme disconnect</em>\r
- [--nqn=<subnqn> | -n <subnqn>]\r
- [--device=<device> | -d <device>]</pre>\r
+<pre class="content"><em>nvme disconnect</em> [--nqn=<subnqn> | -n <subnqn>]\r
+ [--device=<device> | -d <device>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="paragraph"><p>Disconnects and removes one or more existing NVMe over Fabrics controllers.\r
If the --nqn option is specified all controllers connecting to the Subsystem\r
-identified by subnqn will be removed. If the --device option is specified\r
+identified by subnqn will be removed. If the --device option is specified\r
the controller specified by the --device option will be removed.</p></div>\r
</div>\r
</div>\r
removed.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-discover
.\" Author: [see the "AUTHORS" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DISCOVER" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DISCOVER" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme discover\fR
- [\-\-transport=<trtype> | \-t <trtype>]
- [\-\-nqn=<subnqn> | \-n <subnqn>]
- [\-\-traddr=<traddr> | \-a <traddr>]
- [\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
- [\-\-host\-traddr=<traddr> | \-w <traddr>]
- [\-\-host\-iface=<iface> | \-f <iface>]
- [\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
- [\-\-hostid=<hostid> | \-I <hostid>]
- [\-\-raw=<filename> | \-r <filename>]
- [\-\-device=<device> | \-d <device>]
- [\-\-cfg\-file=<cfg> | \-C <cfg> ]
- [\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
- [\-\-reconnect\-delay=<#> | \-c <#>]
- [\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
- [\-\-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]
- [\-\-nbft]
- [\-\-no\-nbft]
- [\-\-nbft\-path=<STR>]
- [\-\-context=<STR>]
+\fInvme discover\fR [\-\-transport=<trtype> | \-t <trtype>]
+ [\-\-nqn=<subnqn> | \-n <subnqn>]
+ [\-\-traddr=<traddr> | \-a <traddr>]
+ [\-\-trsvcid=<trsvcid> | \-s <trsvcid>]
+ [\-\-host\-traddr=<traddr> | \-w <traddr>]
+ [\-\-host\-iface=<iface> | \-f <iface>]
+ [\-\-hostnqn=<hostnqn> | \-q <hostnqn>]
+ [\-\-hostid=<hostid> | \-I <hostid>]
+ [\-\-raw=<filename> | \-r <filename>]
+ [\-\-device=<device> | \-d <device>]
+ [\-\-cfg\-file=<cfg> | \-C <cfg>]
+ [\-\-keep\-alive\-tmo=<sec> | \-k <sec>]
+ [\-\-reconnect\-delay=<#> | \-c <#>]
+ [\-\-ctrl\-loss\-tmo=<#> | \-l <#>]
+ [\-\-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] [\-\-nbft] [\-\-no\-nbft] [\-\-nbft\-path=<STR>]
+ [\-\-context=<STR>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print out resulting JSON configuration file to stdout\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
.RS 4
Set the execution context to <STR>\&. This allows to coordinate the management of the global resources\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
.RS 4
.\}
.nf
-# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the
+# Machine default \*(Aqnvme discover\*(Aq commands\&. Query the
# Discovery Controller\*(Aqs two ports (some resources may only
-# be accessible on a single port)\&. Note an official
+# be accessible on a single port)\&. Note an official
# nqn (Host) name defined in the NVMe specification is being used
# in this example\&.
\-t rdma \-a 192\&.168\&.69\&.33 \-s 4420 \-q nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme discover</em>\r
- [--transport=<trtype> | -t <trtype>]\r
- [--nqn=<subnqn> | -n <subnqn>]\r
- [--traddr=<traddr> | -a <traddr>]\r
- [--trsvcid=<trsvcid> | -s <trsvcid>]\r
- [--host-traddr=<traddr> | -w <traddr>]\r
- [--host-iface=<iface> | -f <iface>]\r
- [--hostnqn=<hostnqn> | -q <hostnqn>]\r
- [--hostid=<hostid> | -I <hostid>]\r
- [--raw=<filename> | -r <filename>]\r
- [--device=<device> | -d <device>]\r
- [--cfg-file=<cfg> | -C <cfg> ]\r
- [--keep-alive-tmo=<sec> | -k <sec>]\r
- [--reconnect-delay=<#> | -c <#>]\r
- [--ctrl-loss-tmo=<#> | -l <#>]\r
- [--nr-io-queues=<#> | -i <#>]\r
- [--nr-write-queues=<#> | -W <#>]\r
- [--nr-poll-queues=<#> | -P <#>]\r
- [--queue-size=<#> | -Q <#>]\r
- [--keyring=<#> ]\r
- [--tls_key=<#> ]\r
- [--hdr-digest | -g]\r
- [--data-digest | -G]\r
- [--persistent | -p]\r
- [--quiet | -S]\r
- [--tls ]\r
- [--dump-config | -O]\r
- [--output-format=<fmt> | -o <fmt>]\r
- [--force]\r
- [--nbft]\r
- [--no-nbft]\r
- [--nbft-path=<STR>]\r
- [--context=<STR>]</pre>\r
+<pre class="content"><em>nvme discover</em> [--transport=<trtype> | -t <trtype>]\r
+ [--nqn=<subnqn> | -n <subnqn>]\r
+ [--traddr=<traddr> | -a <traddr>]\r
+ [--trsvcid=<trsvcid> | -s <trsvcid>]\r
+ [--host-traddr=<traddr> | -w <traddr>]\r
+ [--host-iface=<iface> | -f <iface>]\r
+ [--hostnqn=<hostnqn> | -q <hostnqn>]\r
+ [--hostid=<hostid> | -I <hostid>]\r
+ [--raw=<filename> | -r <filename>]\r
+ [--device=<device> | -d <device>]\r
+ [--cfg-file=<cfg> | -C <cfg>]\r
+ [--keep-alive-tmo=<sec> | -k <sec>]\r
+ [--reconnect-delay=<#> | -c <#>]\r
+ [--ctrl-loss-tmo=<#> | -l <#>]\r
+ [--nr-io-queues=<#> | -i <#>]\r
+ [--nr-write-queues=<#> | -W <#>]\r
+ [--nr-poll-queues=<#> | -P <#>]\r
+ [--queue-size=<#> | -Q <#>] [--keyring=<#>]\r
+ [--tls_key=<#>] [--hdr-digest | -g] [--data-digest | -G]\r
+ [--persistent | -p] [--quiet | -S] [--tls]\r
+ [--dump-config | -O] [--output-format=<fmt> | -o <fmt>]\r
+ [--force] [--nbft] [--no-nbft] [--nbft-path=<STR>]\r
+ [--context=<STR>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
Controller.</p></div>\r
<div class="paragraph"><p>If no parameters are given, then <em>nvme discover</em> will attempt to\r
find a /usr/local/etc/nvme/discovery.conf file to use to supply a list of\r
-Discovery commands to run. If no /usr/local/etc/nvme/discovery.conf file\r
+Discovery commands to run. If no /usr/local/etc/nvme/discovery.conf file\r
exists, the command will quit with an error.</p></div>\r
<div class="paragraph"><p>Otherwise, a specific Discovery Controller should be specified using the\r
--transport, --traddr, and if necessary the --trsvcid flags. A Discovery\r
<div class="paragraph"><p>The NVMe-over-Fabrics specification defines the concept of a\r
Discovery Controller that an NVMe Host can query on a fabric\r
network to discover NVMe subsystems contained in NVMe Targets\r
-which it can connect to on the network. The Discovery Controller\r
+which it can connect to on the network. The Discovery Controller\r
will return Discovery Log Pages that provide the NVMe Host\r
with specific information (such as network address and unique\r
subsystem NQN) the NVMe Host can use to issue an\r
may be used by the Discovery Controller to control what NVMe Target\r
resources are allocated to the NVMe Host for a connection.</p></div>\r
<div class="paragraph"><p>A Discovery Controller has it’s own NQN defined in the NVMe-over-Fabrics\r
-specification, <strong>nqn.2014-08.org.nvmexpress.discovery</strong>. All Discovery\r
+specification, <strong>nqn.2014-08.org.nvmexpress.discovery</strong>. All Discovery\r
Controllers must use this NQN name. This NQN is used by default by\r
nvme-cli for the <em>discover</em> command.</p></div>\r
</div>\r
<dd>\r
<p>\r
This field specifies the network fabric being used for\r
- a NVMe-over-Fabrics network. Current string values include:\r
+ a NVMe-over-Fabrics network. Current string values include:\r
</p>\r
<div class="tableblock">\r
<table rules="all"\r
</dt>\r
<dd>\r
<p>\r
- This field specifies the transport service id. For transports using IP\r
+ This field specifies the transport service id. For transports using IP\r
addressing (e.g. rdma) this field is the port number. By default, the IP\r
port number for the RDMA transport is 4420.\r
</p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
the management of the global resources.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
</p>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><code># Machine default 'nvme discover' commands. Query the\r
+<pre><code># Machine default 'nvme discover' commands. Query the\r
# Discovery Controller's two ports (some resources may only\r
-# be accessible on a single port). Note an official\r
+# be accessible on a single port). Note an official\r
# nqn (Host) name defined in the NVMe specification is being used\r
# in this example.\r
-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-DSM" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-DSM" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme dsm\fR <device> [ \-\-namespace\-id=<nsid> | \-n <nsid> ]
- [ \-\-ctx\-attrs=<attribute\-list,> | \-a <attribute\-list,> ]
- [ \-\-blocks=<nlb\-list,> | \-b <nlb\-list,> ]
- [ \-\-slbs=<slba\-list,> | \-s <slba\-list,> ]
- [ \-\-ad | \-d ] [ \-\-idw | \-w ] [ \-\-idr | \-r ]
- [ \-\-cdw11=<cdw11> | \-c <cdw11> ]
+\fInvme dsm\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-ctx\-attrs=<attribute\-list,> | \-a <attribute\-list,>]
+ [\-\-blocks=<nlb\-list,> | \-b <nlb\-list,>]
+ [\-\-slbs=<slba\-list,> | \-s <slba\-list,>]
+ [\-\-ad=<deallocate> | \-d <deallocate>]
+ [\-\-idw=<write> | \-w <write>] [\-\-idr=<read> | \-r <read>]
+ [\-\-cdw11=<cdw11> | \-c <cdw11>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
All the command command dword 11 attributes\&. Use exclusive from specifying individual attributes
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme dsm</em> <device> [ --namespace-id=<nsid> | -n <nsid> ]\r
- [ --ctx-attrs=<attribute-list,> | -a <attribute-list,> ]\r
- [ --blocks=<nlb-list,> | -b <nlb-list,> ]\r
- [ --slbs=<slba-list,> | -s <slba-list,> ]\r
- [ --ad | -d ] [ --idw | -w ] [ --idr | -r ]\r
- [ --cdw11=<cdw11> | -c <cdw11> ]</pre>\r
+<pre class="content"><em>nvme dsm</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
+ [--ctx-attrs=<attribute-list,> | -a <attribute-list,>]\r
+ [--blocks=<nlb-list,> | -b <nlb-list,>]\r
+ [--slbs=<slba-list,> | -s <slba-list,>]\r
+ [--ad=<deallocate> | -d <deallocate>]\r
+ [--idw=<write> | -w <write>] [--idr=<read> | -r <read>]\r
+ [--cdw11=<cdw11> | -c <cdw11>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
specifying individual attributes\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-EFFECTS\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-EFFECTS\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme effects\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
- [\-\-human\-readable | \-H]
- [\-\-raw\-binary | \-b]
+\fInvme effects\-log\fR <device> [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the returned command effects log structure will be printed for each command that is supported\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
-.RS 4
-This option will set the reporting format to normal, json, or binary\&. Only one output format can be used at a time\&.
-.RE
-.PP
\-H, \-\-human\-readable
.RS 4
This option will parse and format many of the bit fields into a human\-readable format\&.
.RS 4
This option will print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the human\-readable option\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme effects-log</em> <device> [--output-format=<fmt> | -o <fmt>]\r
- [--human-readable | -H]\r
- [--raw-binary | -b]</pre>\r
+<pre class="content"><em>nvme effects-log</em> <device> [--human-readable | -H] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-H\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--human-readable\r
</dt>\r
<dd>\r
<p>\r
- This option will set the reporting format to normal, json, or binary.\r
- Only one output format can be used at a time.\r
+ This option will parse and format many of the bit fields into a\r
+ human-readable format.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--H\r
+-b\r
</dt>\r
<dt class="hdlist1">\r
---human-readable\r
+--raw-binary\r
</dt>\r
<dd>\r
<p>\r
- This option will parse and format many of the bit fields into a\r
- human-readable format.\r
+ This option will print the raw buffer to stdout. Structure is not\r
+ parsed by program. This overrides the human-readable option.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--b\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---raw-binary\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- This option will print the raw buffer to stdout. Structure is not\r
- parsed by program. This overrides the human-readable option.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ENDURANCE\-EVE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ENDURANCE\-EVE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.nf
\fInvme endurance\-event\-agg\-log\fR <device> [\-\-log\-entries=<log_entries> | \-e <log_entries>]
[\-\-rae | \-r] [\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Retain an Asynchronous Event\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="verseblock">\r
<pre class="content"><em>nvme endurance-event-agg-log</em> <device> [--log-entries=<log_entries> | -e <log_entries>]\r
[--rae | -r] [--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Retrieve the Endurance Group Event Aggregate Log pending entries.\r
- This argument is mandatory and its success may depend on the device’s\r
- statistics to provide this log For More details see NVM Express 1.4 Spec.\r
- Section 5.14.1.15. The maximum number of log entries supported is 2044\r
- for the device.\r
+ Retrieve the Endurance Group Event Aggregate Log pending entries.\r
+ This argument is mandatory and its success may depend on the device’s\r
+ statistics to provide this log For More details see NVM Express 1.4 Spec.\r
+ Section 5.14.1.15. The maximum number of log entries supported is 2044\r
+ for the device.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ENDURANCE\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ENDURANCE\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme endurance\-log\fR <device> [\-\-group\-id=<group> | \-g <group>]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The endurance group identifier\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme endurance-log</em> <device> [--group-id=<group> | -g <group>]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ERROR\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ERROR\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme error\-log\fR <device> [\-\-log\-entries=<entries> | \-e <entries>]
- [\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+\fInvme error\-log\fR <device> [\-\-log\-entries=<entries> | \-e <entries>]
+ [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw error log buffer to stdout\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme error-log</em> <device> [--log-entries=<entries> | -e <entries>]\r
- [--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+<pre class="content"><em>nvme error-log</em> <device> [--log-entries=<entries> | -e <entries>]\r
+ [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FDP\-CONFIGS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FDP\-CONFIGS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme fdp configs\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>]
- [\-\-human\-readable | \-H]
- [\-\-raw\-binary | \-b]
- [\-\-output\-format=<FMT> | \-o <FMT>]
+ [\-\-human\-readable | \-H] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to the standard output stream\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme fdp configs</em> <device> [--endgrp-id=<NUM> | -e <NUM>]\r
- [--human-readable | -H]\r
- [--raw-binary | -b]\r
- [--output-format=<FMT> | -o <FMT>]</pre>\r
+ [--human-readable | -H] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FDP\-EVENTS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FDP\-EVENTS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme fdp events\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>]
- [\-\-host\-events | \-E]
- [\-\-raw\-binary | \-b]
- [\-\-output\-format=<FMT> | \-o <FMT>]
+\fInvme fdp events\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] [\-\-host\-events | \-E]
+ [\-\-raw\-binary | \-b] [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to the standard output stream\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme fdp events</em> <device> [--endgrp-id=<NUM> | -e <NUM>]\r
- [--host-events | -E]\r
- [--raw-binary | -b]\r
- [--output-format=<FMT> | -o <FMT>]</pre>\r
+<pre class="content"><em>nvme fdp events</em> <device> [--endgrp-id=<NUM> | -e <NUM>] [--host-events | -E]\r
+ [--raw-binary | -b] [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FDP\-SET\-EVEN" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FDP\-SET\-EVEN" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme fdp set\-events\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-placement\-handle=<NUM> | \-p <NUM>]
- [\-\-enable | \-e]
- [\-\-event\-types=<NUM,> | \-t <NUM,>]
+ [\-\-placement\-handle=<NUM> | \-p <NUM>] [\-\-enable | \-e]
+ [\-\-event\-types=<NUM,> | \-t <NUM,>]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to the standard output stream\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme fdp set-events</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--placement-handle=<NUM> | -p <NUM>]\r
- [--enable | -e]\r
- [--event-types=<NUM,> | -t <NUM,>]</pre>\r
+ [--placement-handle=<NUM> | -p <NUM>] [--enable | -e]\r
+ [--event-types=<NUM,> | -t <NUM,>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FDP\-STATS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FDP\-STATS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme fdp stats\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>]
- [\-\-raw\-binary | \-b]
- [\-\-output\-format=<FMT> | \-o <FMT>]
+\fInvme fdp stats\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to the standard output stream\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme fdp stats</em> <device> [--endgrp-id=<NUM> | -e <NUM>]\r
- [--raw-binary | -b]\r
- [--output-format=<FMT> | -o <FMT>]</pre>\r
+<pre class="content"><em>nvme fdp stats</em> <device> [--endgrp-id=<NUM> | -e <NUM>] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FDP\-STATUS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FDP\-STATUS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme fdp status\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-raw\-binary | \-b]
- [\-\-output\-format=<FMT> | \-o <FMT>]
+\fInvme fdp status\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to the standard output stream\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme fdp status</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--raw-binary | -b]\r
- [--output-format=<FMT> | -o <FMT>]</pre>\r
+<pre class="content"><em>nvme fdp status</em> <device> [--namespace-id=<NUM> | -n <NUM>] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FDP\-UPDATE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FDP\-UPDATE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme fdp update\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-pids=<NUM,> | \-p <NUM,>]
+ [\-\-pids=<NUM,> | \-p <NUM,>]
.fi
.SH "DESCRIPTION"
.sp
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme fdp update</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--pids=<NUM,> | -p <NUM,>]</pre>\r
+ [--pids=<NUM,> | -p <NUM,>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FDP\-USAGE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FDP\-USAGE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme fdp usage\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>]
- [\-\-raw\-binary | \-b]
- [\-\-output\-format=<FMT> | \-o <FMT>]
+\fInvme fdp usage\fR <device> [\-\-endgrp\-id=<NUM> | \-e <NUM>] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to the standard output stream\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme fdp usage</em> <device> [--endgrp-id=<NUM> | -e <NUM>]\r
- [--raw-binary | -b]\r
- [--output-format=<FMT> | -o <FMT>]</pre>\r
+<pre class="content"><em>nvme fdp usage</em> <device> [--endgrp-id=<NUM> | -e <NUM>] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FID\-SUPPORT\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FID\-SUPPORT\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme fid\-support\-effects\-log\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme fid\-support\-effects\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-H, \-\-human\-readable
+.RS 4
+This option will parse and format many of the bit fields into human\-readable formats\&.
+.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
-\-H, \-\-human\-readable
+\-v, \-\-verbose
.RS 4
-This option will parse and format many of the bit fields into human\-readable formats\&.
+Increase the information detail in the output\&.
.RE
.SH "EXAMPLES"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme fid-support-effects-log</em> <device> [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme fid-support-effects-log</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-H\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--human-readable\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ This option will parse and format many of the bit fields\r
+ into human-readable formats.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--H\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---human-readable\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- This option will parse and format many of the bit fields\r
- into human-readable formats.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FLUSH" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FLUSH" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme flush\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Specify the optional namespace id for this command\&. Defaults to 0xffffffff, indicating flush for all namespaces\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme flush</em> <device> [--namespace-id=<nsid> | -n <nsid>]</pre>\r
+<pre class="content"><em>nvme flush</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
0xffffffff, indicating flush for all namespaces.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FORMAT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FORMAT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme format\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-lbaf=<lbaf> | \-l <lbaf>]
- [\-\-block\-size=<block size | \-b <block size>]
- [\-\-ses=<ses> | \-s <ses>]
- [\-\-pil=<pil> | \-p <pil>]
- [\-\-pi=<pi> | \-i <pi>]
- [\-\-ms=<ms> | \-m <ms>]
- [\-\-reset | \-r ]
- [\-\-force ]
- [\-\-timeout=<timeout> | \-t <timeout> ]
+ [\-\-lbaf=<lbaf> | \-l <lbaf>]
+ [\-\-block\-size=<block size | \-b <block size>]
+ [\-\-ses=<ses> | \-s <ses>] [\-\-pil=<pil> | \-p <pil>]
+ [\-\-pi=<pi> | \-i <pi>] [\-\-ms=<ms> | \-m <ms>]
+ [\-\-reset | \-r] [\-\-force]
+ [\-\-timeout=<timeout> | \-t <timeout>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Override default timeout value\&. In milliseconds\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme format</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--lbaf=<lbaf> | -l <lbaf>]\r
- [--block-size=<block size | -b <block size>]\r
- [--ses=<ses> | -s <ses>]\r
- [--pil=<pil> | -p <pil>]\r
- [--pi=<pi> | -i <pi>]\r
- [--ms=<ms> | -m <ms>]\r
- [--reset | -r ]\r
- [--force ]\r
- [--timeout=<timeout> | -t <timeout> ]</pre>\r
+ [--lbaf=<lbaf> | -l <lbaf>]\r
+ [--block-size=<block size | -b <block size>]\r
+ [--ses=<ses> | -s <ses>] [--pil=<pil> | -p <pil>]\r
+ [--pi=<pi> | -i <pi>] [--ms=<ms> | -m <ms>]\r
+ [--reset | -r] [--force]\r
+ [--timeout=<timeout> | -t <timeout>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
Override default timeout value. In milliseconds.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FW\-COMMIT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FW\-COMMIT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme fw\-commit\fR <device> [\-\-slot=<slot> | \-s <slot>]
- [\-\-action=<action> | \-a <action>]
- [\-\-bpid=<boot\-partid> | \-b <boot\-partid> ]
+ [\-\-action=<action> | \-a <action>]
+ [\-\-bpid=<boot\-partid> | \-b <boot\-partid>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Specifies the Boot partition that shall be used for the Commit Action, if applicable (default: 0)
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme fw-commit</em> <device> [--slot=<slot> | -s <slot>]\r
- [--action=<action> | -a <action>]\r
- [--bpid=<boot-partid> | -b <boot-partid> ]</pre>\r
+ [--action=<action> | -a <action>]\r
+ [--bpid=<boot-partid> | -b <boot-partid>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
if applicable (default: 0)\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FW\-DOWNLOAD" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FW\-DOWNLOAD" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme fw\-download\fR <device> [\-\-fw=<firmware\-file> | \-f <firmware\-file>]
- [\-\-xfer=<transfer\-size> | \-x <transfer\-size>]
- [\-\-offset=<offset> | \-o <offset>]
+ [\-\-xfer=<transfer\-size> | \-x <transfer\-size>]
+ [\-\-offset=<offset> | \-O <offset>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
This specifies the size to split each transfer\&. This is useful if the device has a max transfer size requirement for firmware\&. It defaults to 4k\&.
.RE
.PP
-\-o <offset>, \-\-offset=<offset>
+\-O <offset>, \-\-offset=<offset>
.RS 4
This specifies the starting offset in dwords\&. This is really only useful if your firmware is split in multiple files; otherwise the offset starts at zero and automatically adjusts based on the
\fIxfer\fR
size given\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme fw-download</em> <device> [--fw=<firmware-file> | -f <firmware-file>]\r
- [--xfer=<transfer-size> | -x <transfer-size>]\r
- [--offset=<offset> | -o <offset>]</pre>\r
+ [--xfer=<transfer-size> | -x <transfer-size>]\r
+ [--offset=<offset> | -O <offset>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <offset>\r
+-O <offset>\r
</dt>\r
<dt class="hdlist1">\r
--offset=<offset>\r
<em>xfer</em> size given.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-FW\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-FW\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme fw\-log\fR <device> [\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw fw log buffer to stdout\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme fw-log</em> <device> [--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-GEN\-HOSTNQN" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-GEN\-HOSTNQN" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme gen\-hostnqn\fR
+\fInvme gen\-hostnqn\fR [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Generate a random host NQN in the form: nqn\&.2014\-08\&.org\&.nvmexpress:uuid:1b4e28ba\-2fa1\-11d2\-883f\-0016d3cca427 and prints it to stdout\&.
.SH "OPTIONS"
-.sp
-No options needed
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
nvme gen\-hostnqn
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme gen-hostnqn</em></pre>\r
+<pre class="content"><em>nvme gen-hostnqn</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_options">OPTIONS</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>No options needed</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
+</dl></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-GET\-FEATURE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-GET\-FEATURE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme get\-feature\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-feature\-id=<fid> | \-f <fid>] [\-\-cdw11=<cdw11>]
- [\-\-uuid\-index=<uuid\-index> | \-U <uuid_index>]
- [\-\-data\-len=<data\-len> | \-l <data\-len>]
- [\-\-sel=<select> | \-s <select>]
- [\-\-raw\-binary | \-b]
- [\-\-human\-readable | \-H]
+ [\-\-feature\-id=<fid> | \-f <fid>] [\-\-cdw11=<cdw11>]
+ [\-\-uuid\-index=<uuid\-index> | \-U <uuid_index>]
+ [\-\-data\-len=<data\-len> | \-l <data\-len>]
+ [\-\-sel=<select> | \-s <select>]
+ [\-\-raw\-binary | \-b]
+ [\-\-human\-readable | \-H]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
This option will parse and format many of the bit fields into human\-readable formats\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme get-feature</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--feature-id=<fid> | -f <fid>] [--cdw11=<cdw11>]\r
- [--uuid-index=<uuid-index> | -U <uuid_index>]\r
- [--data-len=<data-len> | -l <data-len>]\r
- [--sel=<select> | -s <select>]\r
- [--raw-binary | -b]\r
- [--human-readable | -H]</pre>\r
+ [--feature-id=<fid> | -f <fid>] [--cdw11=<cdw11>]\r
+ [--uuid-index=<uuid-index> | -U <uuid_index>]\r
+ [--data-len=<data-len> | -l <data-len>]\r
+ [--sel=<select> | -s <select>]\r
+ [--raw-binary | -b]\r
+ [--human-readable | -H]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
into human-readable formats.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-GET\-LBA\-STAT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-GET\-LBA\-STAT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme get\-lba\-status\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-start\-lba=<slba> | \-s <slba>]
- [\-\-max\-dw=<max\-dw> | \-m <max\-dw>]
- [\-\-action=<action\-type> | \-a <action\-type>]
- [\-\-range\-len=<range\-len> | \-l <range\-len>]
- [\-\-timeout=<timeout> | \-t <timeout> ]
- [\-\-output\-format=<format> | \-o <format>]
+ [\-\-start\-lba=<slba> | \-s <slba>]
+ [\-\-max\-dw=<max\-dw> | \-m <max\-dw>]
+
[\-\-action=<action\-type> | \-a <action\-type>]
+ [\-\-range\-len=<range\-len> | \-l <range\-len>]
+ [\-\-timeout=<timeout> | \-t <timeout>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Override default timeout value\&. In milliseconds\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme get-lba-status</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--start-lba=<slba> | -s <slba>]\r
- [--max-dw=<max-dw> | -m <max-dw>]\r
- [--action=<action-type> | -a <action-type>]\r
- [--range-len=<range-len> | -l <range-len>]\r
- [--timeout=<timeout> | -t <timeout> ]\r
- [--output-format=<format> | -o <format>]</pre>\r
+ [--start-lba=<slba> | -s <slba>]\r
+ [--max-dw=<max-dw> | -m <max-dw>]\r
+ [--action=<action-type> | -a <action-type>]\r
+ [--range-len=<range-len> | -l <range-len>]\r
+ [--timeout=<timeout> | -t <timeout>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-GET\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-GET\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme get\-log\fR <device> [\-\-log\-id=<log\-id> | \-i <log\-id>]
- [\-\-log\-len=<log\-len> | \-l <log\-len>]
- [\-\-aen=<aen> | \-a <aen>]
- [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-raw\-binary | \-b]
- [\-\-lpo=<offset> | \-o <offset>]
- [\-\-lsp=<field> | \-s <field>]
- [\-\-lsi=<field> | \-S <field>]
- [\-\-rae | \-r]
- [\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
- [\-\-ot=<offset_type> | \-O <offset_type>]
- [\-\-xfer\-len=<length> | \-x <length>]
+ [\-\-log\-len=<log\-len> | \-l <log\-len>]
+ [\-\-aen=<aen> | \-a <aen>]
+ [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-raw\-binary | \-b]
+ [\-\-lpo=<offset> | \-L <offset>]
+ [\-\-lsp=<field> | \-s <field>]
+ [\-\-lsi=<field> | \-S <field>]
+ [\-\-rae | \-r]
+ [\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
+ [\-\-ot=<offset_type> | \-O <offset_type>]
+ [\-\-xfer\-len=<length> | \-x <length>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw log buffer to stdout\&.
.RE
.PP
-\-o <offset>, \-\-lpo=<offset>
+\-L <offset>, \-\-lpo=<offset>
.RS 4
The log page offset specifies the location within a log page to start returning data from\&. It\(cqs Dword\-aligned and 64\-bits\&.
.RE
.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
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme get-log</em> <device> [--log-id=<log-id> | -i <log-id>]\r
- [--log-len=<log-len> | -l <log-len>]\r
- [--aen=<aen> | -a <aen>]\r
- [--namespace-id=<nsid> | -n <nsid>]\r
- [--raw-binary | -b]\r
- [--lpo=<offset> | -o <offset>]\r
- [--lsp=<field> | -s <field>]\r
- [--lsi=<field> | -S <field>]\r
- [--rae | -r]\r
- [--csi=<command_set_identifier> | -y <command_set_identifier>]\r
- [--ot=<offset_type> | -O <offset_type>]\r
- [--xfer-len=<length> | -x <length>]</pre>\r
+ [--log-len=<log-len> | -l <log-len>]\r
+ [--aen=<aen> | -a <aen>]\r
+ [--namespace-id=<nsid> | -n <nsid>]\r
+ [--raw-binary | -b]\r
+ [--lpo=<offset> | -L <offset>]\r
+ [--lsp=<field> | -s <field>]\r
+ [--lsi=<field> | -S <field>]\r
+ [--rae | -r]\r
+ [--csi=<command_set_identifier> | -y <command_set_identifier>]\r
+ [--ot=<offset_type> | -O <offset_type>]\r
+ [--xfer-len=<length> | -x <length>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <offset>\r
+-L <offset>\r
</dt>\r
<dt class="hdlist1">\r
--lpo=<offset>\r
a multiple of 4096. The default size is 4096.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-GET\-NS\-ID" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-GET\-NS\-ID" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme get\-ns\-id\fR <device>
+\fInvme get\-ns\-id\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Retrieves the namespace ID for an NVMe block device\&. The <device> param is mandatory and must be an NVMe block device (ex: /dev/nvme0n1)\&.
.SH "OPTIONS"
-.sp
-None
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme get-ns-id</em> <device></pre>\r
+<pre class="content"><em>nvme get-ns-id</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_options">OPTIONS</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>None</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
+</dl></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-GET\-PROPERTY" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-GET\-PROPERTY" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme get\-property\fR <device> [\-\-offset=<offset> | \-o <offset>]
- [\-\-human\-readable | \-H ]
+\fInvme get\-property\fR <device> [\-\-offset=<offset> | \-O <offset>]
+ [\-\-human\-readable | \-H]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Reads and shows the defined NVMe controller property for NVMe over Fabric\&.
.SH "OPTIONS"
.PP
-\-o, \-\-offset
+\-O, \-\-offset
.RS 4
The offset of the property\&. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20
.RE
.RS 4
\-\-human\-readable: Show the fields packed in the property
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme get-property</em> <device> [--offset=<offset> | -o <offset>]\r
- [--human-readable | -H ]</pre>\r
+<pre class="content"><em>nvme get-property</em> <device> [--offset=<offset> | -O <offset>]\r
+ [--human-readable | -H]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o\r
+-O\r
</dt>\r
<dt class="hdlist1">\r
--offset\r
Show the fields packed in the property\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-HELP" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-HELP" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-huawei-id-ctrl
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-HUAWEI\-ID\-CT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-HUAWEI\-ID\-CT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme huawei id\-ctrl\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme huawei id\-ctrl\fR <device> [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
This option will parse and format many of the bit fields into human\-readable formats\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme huawei id-ctrl</em> <device> [-v | --vendor-specific] [-b | --raw-binary]\r
- [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme huawei id-ctrl</em> <device> [--vendor-specific | -v] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or\r
+ <em>binary</em>. Only one output format can be used at a time.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-list
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LIST" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-LIST" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme huawei list\fR [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme huawei list\fR [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
Scan the sysfs tree for NVM Express devices and return the /dev node for those Huawei devices as well as some pertinent information about them\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme huawei list</em> [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme huawei list</em> [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-id-ctrl
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-CTRL" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme id\-ctrl\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme id\-ctrl\fR <device> [\-\-vendor\-specific | \-V] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the vendor specific and human readable options\&.
.RE
.PP
-\-v, \-\-vendor\-specific
+\-V, \-\-vendor\-specific
.RS 4
In addition to parsing known fields, this option will dump the vendor specific region of the structure in hex with ascii interpretation\&.
.RE
This option will parse and format many of the bit fields into human\-readable formats\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
.\}
.nf
# nvme id\-ctrl /dev/nvme0 \-\-vendor\-specific
-# nvme id\-ctrl /dev/nvme0 \-v
+# nvme id\-ctrl /dev/nvme0 \-V
.fi
.if n \{\
.RE
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme id-ctrl</em> <device> [-v | --vendor-specific] [-b | --raw-binary]\r
- [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme id-ctrl</em> <device> [--vendor-specific | -V] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--v\r
+-V\r
</dt>\r
<dt class="hdlist1">\r
--vendor-specific\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--verbose\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><code># nvme id-ctrl /dev/nvme0 --vendor-specific\r
-# nvme id-ctrl /dev/nvme0 -v</code></pre>\r
+# nvme id-ctrl /dev/nvme0 -V</code></pre>\r
</div></div>\r
<div class="paragraph"><p>The above will dump the <em>vs</em> buffer in hex since it doesn’t know how to\r
interpret it.</p></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-id-domain
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-DOMAIN" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-DOMAIN" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme id\-domain\fR <device> [\-\-dom\-id=<domian_id> | \-d <domian_id>]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Retrieve the identify domain list data structure for the given domain id\&. If this value is not given, domain id will be 0xffff\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme id-domain</em> <device> [--dom-id=<domian_id> | -d <domian_id>]\r
- [-o <fmt> | --output-format=<fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-id-iocs
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-IOCS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-IOCS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme id\-iocs\fR <device> [\-\-controller\-id=<cntid> | \-c <cntid>]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
This option will parse and format many of the bit fields into human\-readable formats\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme id-iocs</em> <device> [--controller-id=<cntid> | -c <cntid>]\r
- [-o <fmt> | --output-format=<fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme id\-ns\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary]
- [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-force]
- [\-\-human\-readable | \-H]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+\fInvme id\-ns\fR <device> [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b]
+ [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-force]
+ [\-\-human\-readable | \-H]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the vendor specific and human readable options\&.
.RE
.PP
-\-v, \-\-vendor\-specific
+\-V, \-\-vendor\-specific
.RS 4
In addition to parsing known fields, this option will dump the vendor specific region of the structure in hex with ascii interpretation\&.
.RE
This option will parse and format many of the bit fields into human\-readable formats\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
.\}
.nf
# nvme id\-ns /dev/nvme0n1 \-\-vendor\-specific
-# nvme id\-ns /dev/nvme0n1 \-v
+# nvme id\-ns /dev/nvme0n1 \-V
.fi
.if n \{\
.RE
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme id-ns</em> <device> [-v | --vendor-specific] [-b | --raw-binary]\r
- [--namespace-id=<nsid> | -n <nsid>] [--force]\r
- [--human-readable | -H]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+<pre class="content"><em>nvme id-ns</em> <device> [--vendor-specific | -v] [--raw-binary | -b]\r
+ [--namespace-id=<nsid> | -n <nsid>] [--force]\r
+ [--human-readable | -H]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--v\r
+-V\r
</dt>\r
<dt class="hdlist1">\r
--vendor-specific\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--verbose\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><code># nvme id-ns /dev/nvme0n1 --vendor-specific\r
-# nvme id-ns /dev/nvme0n1 -v</code></pre>\r
+# nvme id-ns /dev/nvme0n1 -V</code></pre>\r
</div></div>\r
<div class="paragraph"><p>The above will dump the 'vs' buffer in hex since it doesn’t know how to\r
interpret it.</p></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-id-nvmset
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-NVMSET" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NVMSET" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme id\-nvmset\fR <device> [\-i <id> | \-\-nvmset_id=<id> ]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme id\-nvmset\fR <device> [\-\-nvmset_id=<id> | \-i <id>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
This field specifies the identifier of the NVM Set\&. If given, NVM set identifier whose entry is to be in result data will be greater than or equal to this value\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme id-nvmset</em> <device> [-i <id> | --nvmset_id=<id> ]\r
- [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme id-nvmset</em> <device> [--nvmset_id=<id> | -i <id>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- This field specifies the identifier of the NVM Set. If given, NVM set\r
+ This field specifies the identifier of the NVM Set. If given, NVM set\r
identifier whose entry is to be in result data will be greater than or\r
equal to this value.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-inspur-nvme-vendor-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-INSPUR\-NVME\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-INSPUR\-NVME\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-intel-id-ctrl
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-INTEL\-ID\-CTR" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-INTEL\-ID\-CTR" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme intel id\-ctrl\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme intel id\-ctrl\fR <device> [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
This option will parse and format many of the bit fields into human\-readable formats\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme intel id-ctrl</em> <device> [-v | --vendor-specific] [-b | --raw-binary]\r
- [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme intel id-ctrl</em> <device> [--vendor-specific | -v] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or\r
+ <em>binary</em>. Only one output format can be used at a time.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-intel-internal-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-INTEL\-INTERNA" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-INTEL\-INTERNA" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-intel-lat-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-INTEL\-LAT\-ST" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-INTEL\-LAT\-ST" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-intel-market-name
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-INTEL\-MARKET\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-INTEL\-MARKET\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-intel-smart-log-add
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-INTEL\-SMART\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-INTEL\-SMART\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme intel smart\-log\-add\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-raw\-binary | \-b]
- [\-\-json | \-j]
+ [\-\-raw\-binary | \-b] [\-\-json | \-j]
.fi
.SH "DESCRIPTION"
.sp
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme intel smart-log-add</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--raw-binary | -b]\r
- [--json | -j]</pre>\r
+ [--raw-binary | -b] [--json | -j]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Dump output in json format.\r
+ Dump output in json format.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-intel-temp-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-INTEL\-TEMP\-S" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-INTEL\-TEMP\-S" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-io-mgmt-recv
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-IO\-MGMT\-RECV" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-IO\-MGMT\-RECV" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme io\-mgmt\-recv\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-mos=<NUM> | \-s <NUM>]
- [\-\-mo=<NUM> | \-m <NUM>]
- [\-\-data=<FILE> | \-d <FILE>]
- [\-\-data\-len=<NUM> | \-l <NUM>]
+ [\-\-mos=<NUM> | \-s <NUM>] [\-\-mo=<NUM> | \-m <NUM>]
+ [\-\-data=<FILE> | \-d <FILE>]
+ [\-\-data\-len=<NUM> | \-l <NUM>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Management Operation Specific parameter\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "NVME"
.sp
Part of nvme\-cli
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme io-mgmt-recv</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--mos=<NUM> | -s <NUM>]\r
- [--mo=<NUM> | -m <NUM>]\r
- [--data=<FILE> | -d <FILE>]\r
- [--data-len=<NUM> | -l <NUM>]</pre>\r
+ [--mos=<NUM> | -s <NUM>] [--mo=<NUM> | -m <NUM>]\r
+ [--data=<FILE> | -d <FILE>]\r
+ [--data-len=<NUM> | -l <NUM>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
Management Operation Specific parameter.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-io-mgmt-send
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-IO\-MGMT\-SEND" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-IO\-MGMT\-SEND" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme io\-mgmt\-send\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-mos=<NUM> | \-s <NUM>]
- [\-\-mo=<NUM> | \-m <NUM>]
- [\-\-data=<FILE> | \-d <FILE>]
- [\-\-data\-len=<NUM> | \-l <NUM>]
+ [\-\-mos=<NUM> | \-s <NUM>] [\-\-mo=<NUM> | \-m <NUM>]
+ [\-\-data=<FILE> | \-d <FILE>]
+ [\-\-data\-len=<NUM> | \-l <NUM>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Management Operation Specific parameter\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "NVME"
.sp
Part of nvme\-cli
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme io-mgmt-send</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--mos=<NUM> | -s <NUM>]\r
- [--mo=<NUM> | -m <NUM>]\r
- [--data=<FILE> | -d <FILE>]\r
- [--data-len=<NUM> | -l <NUM>]</pre>\r
+ [--mos=<NUM> | -s <NUM>] [--mo=<NUM> | -m <NUM>]\r
+ [--data=<FILE> | -d <FILE>]\r
+ [--data-len=<NUM> | -l <NUM>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
Management Operation Specific parameter.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-io-passthru
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-IO\-PASSTHRU" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-IO\-PASSTHRU" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme\-io\-passthru\fR <device> [\-\-opcode=<opcode> | \-o <opcode>]
- [\-\-flags=<flags> | \-f <flags>] [\-rsvd=<rsvd> | \-R <rsvd>]
- [\-\-namespace\-id=<nsid> | \-nsid <nsid>]
- [\-\-cdw2=<cdw2>] [\-\-cdw3=<cdw3>] [\-\-cdw10=<cdw10>]
- [\-\-cdw11=<cdw11>] [\-\-cdw12=<cdw12>] [\-\-cdw13=<cdw13>]
- [\-\-cdw14=<cdw14>] [\-\-cdw15=<cdw15>]
- [\-\-data\-len=<data\-len> | \-l <data\-len>]
- [\-\-metadata\-len=<len> | \-m <len>]
- [\-\-read | \-r ] [\-\-write | \-w]
- [\-\-input\-file=<file> | \-i <file>]
- [\-\-metadata=<file> | \-M <file>]
- [\-\-timeout=<to> | \-t <to>]
- [\-\-show\-command | \-s]
- [\-\-dry\-run | \-d]
- [\-\-raw\-binary | \-b]
- [\-\-prefill=<prefill> | \-p <prefill>]
- [\-\-latency | \-T]
+\fInvme\-io\-passthru\fR <device> [\-\-opcode=<opcode> | \-O <opcode>]
+ [\-\-flags=<flags> | \-f <flags>] [\-rsvd=<rsvd> | \-R <rsvd>]
+ [\-\-namespace\-id=<nsid> | \-nsid <nsid>]
+ [\-\-cdw2=<cdw2>] [\-\-cdw3=<cdw3>] [\-\-cdw10=<cdw10>]
+ [\-\-cdw11=<cdw11>] [\-\-cdw12=<cdw12>] [\-\-cdw13=<cdw13>]
+ [\-\-cdw14=<cdw14>] [\-\-cdw15=<cdw15>]
+ [\-\-data\-len=<data\-len> | \-l <data\-len>]
+ [\-\-metadata\-len=<len> | \-m <len>]
+ [\-\-read | \-r] [\-\-write | \-w]
+ [\-\-input\-file=<file> | \-i <file>]
+ [\-\-metadata=<file> | \-M <file>]
+ [\-\-timeout=<to> | \-t <to>] [\-\-show\-command | \-s]
+ [\-\-dry\-run | \-d] [\-\-raw\-binary | \-b]
+ [\-\-prefill=<prefill> | \-p <prefill>]
+ [\-\-latency | \-T]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the returned structure (if applicable) may be returned in one of several ways depending on the option flags; the structure may printed by the program as a hex dump, or may be returned as a raw buffer printed to stdout for another program to parse\&.
.SH "OPTIONS"
.PP
-\-o <opcode>, \-\-opcode=<opcode>
+\-O <opcode>, \-\-opcode=<opcode>
.RS 4
The NVMe opcode to send to the device in the command
.RE
.RS 4
Print out the latency the IOCTL took (in us)\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
nvme io\-passthru /dev/nvme0n1 \-\-opcode=2 \-\-namespace\-id=1 \-\-data\-len=4096 \-\-read \-\-cdw10=0 \-\-cdw11=0 \-\-cdw12=0x70000 \-\-raw\-binary
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme-io-passthru</em> <device> [--opcode=<opcode> | -o <opcode>]\r
- [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]\r
- [--namespace-id=<nsid> | -nsid <nsid>]\r
- [--cdw2=<cdw2>] [--cdw3=<cdw3>] [--cdw10=<cdw10>]\r
- [--cdw11=<cdw11>] [--cdw12=<cdw12>] [--cdw13=<cdw13>]\r
- [--cdw14=<cdw14>] [--cdw15=<cdw15>]\r
- [--data-len=<data-len> | -l <data-len>]\r
- [--metadata-len=<len> | -m <len>]\r
- [--read | -r ] [--write | -w]\r
- [--input-file=<file> | -i <file>]\r
- [--metadata=<file> | -M <file>]\r
- [--timeout=<to> | -t <to>]\r
- [--show-command | -s]\r
- [--dry-run | -d]\r
- [--raw-binary | -b]\r
- [--prefill=<prefill> | -p <prefill>]\r
- [--latency | -T]</pre>\r
+<pre class="content"><em>nvme-io-passthru</em> <device> [--opcode=<opcode> | -O <opcode>]\r
+ [--flags=<flags> | -f <flags>] [-rsvd=<rsvd> | -R <rsvd>]\r
+ [--namespace-id=<nsid> | -nsid <nsid>]\r
+ [--cdw2=<cdw2>] [--cdw3=<cdw3>] [--cdw10=<cdw10>]\r
+ [--cdw11=<cdw11>] [--cdw12=<cdw12>] [--cdw13=<cdw13>]\r
+ [--cdw14=<cdw14>] [--cdw15=<cdw15>]\r
+ [--data-len=<data-len> | -l <data-len>]\r
+ [--metadata-len=<len> | -m <len>]\r
+ [--read | -r] [--write | -w]\r
+ [--input-file=<file> | -i <file>]\r
+ [--metadata=<file> | -M <file>]\r
+ [--timeout=<to> | -t <to>] [--show-command | -s]\r
+ [--dry-run | -d] [--raw-binary | -b]\r
+ [--prefill=<prefill> | -p <prefill>]\r
+ [--latency | -T]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <opcode>\r
+-O <opcode>\r
</dt>\r
<dt class="hdlist1">\r
--opcode=<opcode>\r
Print out the latency the IOCTL took (in us).\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-lba-status-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LBA\-STATUS\-L" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-LBA\-STATUS\-L" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme lba\-status\-log\fR <device> [\-\-rae | \-r] [\-\-output\-format=<fmt> | \-o <fmt>]
+\fInvme lba\-status\-log\fR <device> [\-\-rae | \-r]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Retain an Asynchronous Event\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme lba-status-log</em> <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]</pre>\r
+<pre class="content"><em>nvme lba-status-log</em> <device> [--rae | -r]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.\r
- Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-list-ctrl
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LIST\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-LIST\-CTRL" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme list\-ctrl\fR <device> [\-\-cntid=<cntid> | \-c <cntid>]
- [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-o <fmt> | \-\-output\-format=<fmt>]
-DESCRIPTION
+ [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
+.SH "DESCRIPTION"
.sp
-.nf
-For the NVMe device given, sends an identify command for controller list
-and provides the result and returned structure\&. This uses either mode
-12h or 13h depending on the requested namespace identifier\&.
-
-The <device> parameter is mandatory and may be either the NVMe character
-device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
-The starting controller in the list always begins with 0 unless the
-`\*(Aq\-\-cntid\*(Aq` option is given to override\&.
-
-On success, the controller array is printed for each index and controller
-identifier\&.
-
-OPTIONS
-.fi
+For the NVMe device given, sends an identify command for controller list and provides the result and returned structure\&. This uses either mode 12h or 13h depending on the requested namespace identifier\&.
+.sp
+The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&. The starting controller in the list always begins with 0 unless the \*(Aq\-\-cntid\*(Aq option is given to override\&.
+.sp
+On success, the controller array is printed for each index and controller identifier\&.
+.SH "OPTIONS"
.PP
\-c <cntid>, \-\-cntid=<cntid>
.RS 4
If provided, will request the controllers attached to the specified namespace\&. If no namespace is given, or set to 0, the command requests the controller list for the entire subsystem, whether or not they are attached to namespace(s)\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
-\fInormal\fR
+\fInormal\fR,
+\fIjson\fR
or
-\fIjson\fR\&. Only one output format can be used at a time\&.
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
.RE
.SH "EXAMPLES"
.sp
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme list-ctrl</em> <device> [--cntid=<cntid> | -c <cntid>]\r
- [--namespace-id=<nsid> | -n <nsid>] [-o <fmt> | --output-format=<fmt>]\r
-DESCRIPTION</pre>\r
+ [--namespace-id=<nsid> | -n <nsid>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
-<div class="listingblock">\r
-<div class="content">\r
-<pre><code>For the NVMe device given, sends an identify command for controller list\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_description">DESCRIPTION</h2>\r
+<div class="sectionbody">\r
+<div class="paragraph"><p>For the NVMe device given, sends an identify command for controller list\r
and provides the result and returned structure. This uses either mode\r
-12h or 13h depending on the requested namespace identifier.\r
-\r
-The <device> parameter is mandatory and may be either the NVMe character\r
+12h or 13h depending on the requested namespace identifier.</p></div>\r
+<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character\r
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).\r
The starting controller in the list always begins with 0 unless the\r
-`'--cntid'` option is given to override.\r
-\r
-On success, the controller array is printed for each index and controller\r
-identifier.\r
-\r
-OPTIONS</code></pre>\r
-</div></div>\r
+<code>'--cntid'</code> option is given to override.</p></div>\r
+<div class="paragraph"><p>On success, the controller array is printed for each index and controller\r
+identifier.</p></div>\r
+</div>\r
+</div>\r
+<div class="sect1">\r
+<h2 id="_options">OPTIONS</h2>\r
+<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
-c <cntid>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--verbose\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em> or <em>json</em>. Only one output\r
- format can be used at a time.\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-list-endgrp
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LIST\-ENDGRP" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-LIST\-ENDGRP" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme list\-endgrp\fR <device> [\-\-endgrp\-id=<endgrp\-id> | \-i <endgrp\-id>]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Retrieve the identify endurance group list structure starting for the given endurance group id\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
-\fInormal\fR
+\fInormal\fR,
+\fIjson\fR
or
-\fIjson\fR\&. Only one output format can be used at a time\&.
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
.RE
.SH "EXAMPLES"
.sp
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme list-endgrp</em> <device> [--endgrp-id=<endgrp-id> | -i <endgrp-id>]\r
- [-o <fmt> | --output-format=<fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Retrieve the identify endurance group list structure starting for the given\r
- endurance group id.\r
+ Retrieve the identify endurance group list structure starting for the\r
+ given endurance group id.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em> or <em>json</em>. Only one output\r
- format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.nf
\fInvme list\-ns\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-csi=<command_set_identifier> | \-y <command_set_identifier>]
- [\-\-all | \-a] [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-all | \-a]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Retrieve the identify list structure for all namespaces in the subsystem, whether attached or inactive\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
-\fInormal\fR, or
-\fIjson\fR\&. Only one output format can be used at a time\&.
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
.RE
.SH "EXAMPLES"
.sp
<div class="verseblock">\r
<pre class="content"><em>nvme list-ns</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
[--csi=<command_set_identifier> | -y <command_set_identifier>]\r
- [--all | -a] [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--all | -a]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, or <em>json</em>.\r
- Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-list-subsys
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LIST\-SUBSYS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-LIST\-SUBSYS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme list\-subsys\fR [\-o <fmt> | \-\-output\-format=<fmt>] <device>
+\fInvme list\-subsys\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Scan the sysfs tree for NVM Express subsystems and return the controllers for those subsystems as well as some pertinent information about them\&. If a device is given, print out only the values for the controllers and subsystems leading to the device\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
-\fInormal\fR
+\fInormal\fR,
+\fIjson\fR
or
-\fIjson\fR\&. Only one output format can be used at a time\&.
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
.RE
.SH "EXAMPLES"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme list-subsys</em> [-o <fmt> | --output-format=<fmt>] <device></pre>\r
+<pre class="content"><em>nvme list-subsys</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em> or <em>json</em>. Only one output\r
- format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-list
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LIST" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-LIST" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme list\fR [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme list\fR [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Scan the sysfs tree for NVM Express devices and return the /dev node for those devices as well as some pertinent information about them\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
-\fInormal\fR
+\fInormal\fR,
+\fIjson\fR
or
-\fIjson\fR\&. Only one output format can be used at a time\&.
+\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme list</em> [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme list</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em> or <em>json</em>. Only one output\r
- format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-lockdown
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-LOCKDOWN" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-LOCKDOWN" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme\-lockdown\fR <device> [\-\-ofi=<ofi> | \-o <ofi>]
+\fInvme\-lockdown\fR <device> [\-\-ofi=<ofi> | \-O <ofi>]
[\-\-ifc=<ifc> | \-f <ifc>]
[\-\-prhbt=<prhbt> | \-p <prhbt>]
[\-\-scp=<scp> | \-s <scp>]
[\-\-uuid=<UUID_Index> | \-U <UUID_Index>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The Lockdown command is used to control the Command and Feature Lockdown capability which configures the prohibition or allowance of execution of the specified command or Set Features command targeting a specific Feature Identifier\&.
.SH "OPTIONS"
.PP
-\-\-ofi=<ofi>, \-o <ofi>
+\-O <ofi>, \-\-ofi=<ofi>
.RS 4
Opcode or Feature Identifier(OFI) specifies the command opcode or Set Features Feature Identifier identified by the Scope field\&.
.RE
.PP
-\-\-ifc=<ifc>, \-f <ifc>
+\-f <ifc>, \-\-ifc=<ifc>
.RS 4
Interface (INF) field identifies the interfaces affected by this command\&.
.RE
.PP
-\-
\-prhbt=<prhbt>, \-p <prhbt>
+\-
p <prhbt>, \-\-prhbt=<prhbt>
.RS 4
Prohibit (PRHBT) bit specifies whether to prohibit or allow the command opcode or Set Features Feature Identifier specified by this command\&.
.RE
.PP
-\-\-scp=<scp>, \-s <scp>
+\-s <scp>, \-\-scp=<scp>
.RS 4
Scope (SCP) field specifies the contents of the Opcode or Feature Identifier field\&.
.RE
.PP
-\-\-uuid=<UUID_Index>, \-U <UUID_Index>
+\-U <UUID_Index>, \-\-uuid=<UUID_Index>
.RS 4
UUID Index \- If this field is set to a non\-zero value, then the value of this field is the index of a UUID in the UUID List that is used by the command\&. If this field is cleared to 0h,then no UUID index is specified\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme-lockdown</em> <device> [--ofi=<ofi> | -o <ofi>]\r
+<pre class="content"><em>nvme-lockdown</em> <device> [--ofi=<ofi> | -O <ofi>]\r
[--ifc=<ifc> | -f <ifc>]\r
[--prhbt=<prhbt> | -p <prhbt>]\r
[--scp=<scp> | -s <scp>]\r
- [--uuid=<UUID_Index> | -U <UUID_Index>]</pre>\r
+ [--uuid=<UUID_Index> | -U <UUID_Index>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
---ofi=<ofi>\r
+-O <ofi>\r
</dt>\r
<dt class="hdlist1">\r
--o <ofi>\r
+--ofi=<ofi>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---ifc=<ifc>\r
+-f <ifc>\r
</dt>\r
<dt class="hdlist1">\r
--f <ifc>\r
+--ifc=<ifc>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---prhbt=<prhbt>\r
+-p <prhbt>\r
</dt>\r
<dt class="hdlist1">\r
--p <prhbt>\r
+--prhbt=<prhbt>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---scp=<scp>\r
+-s <scp>\r
</dt>\r
<dt class="hdlist1">\r
--s <scp>\r
+--scp=<scp>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---uuid=<UUID_Index>\r
+-U <UUID_Index>\r
</dt>\r
<dt class="hdlist1">\r
--U <UUID_Index>\r
+--uuid=<UUID_Index>\r
</dt>\r
<dd>\r
<p>\r
If this field is cleared to 0h,then no UUID index is specified.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-mi-cmd-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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-MI\-CMD\-SUPPO" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-MI\-CMD\-SUPPO" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme\-mi\-cmd\-support\-effects\-log\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>]
- [\-H | \-\-human\-readable]
+\fInvme\-mi\-cmd\-support\-effects\-log\fR <device> [\-\-human\-readable | \-H]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-H, \-\-human\-readable
+.RS 4
+This option will parse and format many of the bit fields into human\-readable formats\&.
+.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
-\-H, \-\-human\-readable
+\-v, \-\-verbose
.RS 4
-This option will parse and format many of the bit fields into human\-readable formats\&.
+Increase the information detail in the output\&.
.RE
.SH "EXAMPLES"
.sp
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>nvme-mi-cmd-support-effects-log -\r
- Send NVMe MI Command Support and Effects log, returns results and structure\r
+ Send NVMe MI Command Support and Effects log, returns results and structure\r
</p>\r
</div>\r
</div>\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme-mi-cmd-support-effects-log</em> <device> [-o <fmt> | --output-format=<fmt>]\r
- [-H | --human-readable]</pre>\r
+<pre class="content"><em>nvme-mi-cmd-support-effects-log</em> <device> [--human-readable | -H]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-H\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--human-readable\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ This option will parse and format many of the bit fields\r
+ into human-readable formats.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--H\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---human-readable\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- This option will parse and format many of the bit fields\r
- into human-readable formats.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-micron-clear-pcie-errors
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-MICRON\-CLEAR\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-MICRON\-CLEAR\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-micron-internal-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-MICRON\-INTERN" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-MICRON\-INTERN" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.fi
.SH "DESCRIPTION"
.sp
-For the given NVMe device, sends the Micron vendor specific device commands to retrieve various logs (in binary format) and compresses them and saves into specified zip file\&. These vendor unique logs can be analyzed with Micron Technical support team for any device specific issues
+For the given NVMe device, sends the Micron vendor specific device commands to retrieve various logs (in binary format) and compresses them and saves into specified zip file\&. These vendor unique logs can be analyzed with Micron Technical support team for any device specific issues\&.
.sp
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
.sp
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>For the given NVMe device, sends the Micron vendor specific device commands to retrieve\r
-various logs (in binary format) and compresses them and saves into specified zip file.\r
-These vendor unique logs can be analyzed with Micron Technical support team for any device\r
-specific issues</p></div>\r
+<div class="paragraph"><p>For the given NVMe device, sends the Micron vendor specific device commands to\r
+retrieve various logs (in binary format) and compresses them and saves into\r
+specified zip file. These vendor unique logs can be analyzed with Micron\r
+Technical support team for any device specific issues.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe\r
character device (ex: /dev/nvme0), or a namespace block device (ex:\r
/dev/nvme0n1).</p></div>\r
-<div class="paragraph"><p>This will only work on Micron devices devices of model numbers 9200 and 54XX. Support\r
-for new devices may be added subsequently. Results for any other device are undefined.</p></div>\r
+<div class="paragraph"><p>This will only work on Micron devices devices of model numbers 9200 and 54XX.\r
+Support for new devices may be added subsequently. Results for any other device\r
+are undefined.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-micron-nand-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-MICRON\-NAND\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-MICRON\-NAND\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-micron-pcie-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-MICRON\-PCIE\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-MICRON\-PCIE\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-micron-selective-download
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-MICRON\-SELECT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-MICRON\-SELECT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
-nvme-micron-selective-download \- Performs selective firmware download that allows user to select which firmware binary to update for 9200 devices\&. This requires power cycle once the update completes\&.
+nvme-micron-selective-download \- Performs selective firmware download that allows user select which firmware binary to update for 9200 devices\&. This requires power cycle the update completes\&.
.SH "SYNOPSIS"
.sp
.nf
-\fInvme micron selective\-download\fR <device> [\-\-fw=<FILE>, \-f <FILE>] [\-\-select=<flag>, \-s <flag>]
+\fInvme micron selective\-download\fR <device> [\-\-fw=<FILE>, \-f <FILE>]
+ [\-\-select=<flag>, \-s <flag>]
.fi
.SH "DESCRIPTION"
.sp
-This command uses micron vendor specific nvme commands to download given firmware image to the specified 9200 device to update selected or all portions of firmware image\&.
+This command uses micron vendor specific nvme commands to download given firmware image to the 9200 device to update selected or all portions of firmware image\&.
.sp
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
.sp
-This will only work on Micron devices devices of model number 9200\&. Support for new devices may be added subsequently\&. Results for any other device are undefined\&.
+This will only work on Micron devices devices of model number 9200\&. Support for new devices be added subsequently\&. Results for any other device are undefined\&.
.SH "OPTIONS"
.PP
\-f <FILE>, \-\-fw=<FILE>
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>nvme-micron-selective-download -\r
- Performs selective firmware download that allows user to select which firmware binary to update for 9200 devices. This requires power cycle once the update completes.\r
+ Performs selective firmware download that allows user select which firmware binary to update for 9200 devices. This requires power cycle the update completes.\r
</p>\r
</div>\r
</div>\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme micron selective-download</em> <device> [--fw=<FILE>, -f <FILE>] [--select=<flag>, -s <flag>]</pre>\r
+<pre class="content"><em>nvme micron selective-download</em> <device> [--fw=<FILE>, -f <FILE>]\r
+ [--select=<flag>, -s <flag>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This command uses micron vendor specific nvme commands to download given firmware image to the\r
-specified 9200 device to update selected or all portions of firmware image.</p></div>\r
+<div class="paragraph"><p>This command uses micron vendor specific nvme commands to download given\r
+firmware image to the 9200 device to update selected or all portions of firmware\r
+image.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe\r
character device (ex: /dev/nvme0), or a namespace block device (ex:\r
/dev/nvme0n1).</p></div>\r
-<div class="paragraph"><p>This will only work on Micron devices devices of model number 9200. Support for new devices\r
-may be added subsequently. Results for any other device are undefined.</p></div>\r
+<div class="paragraph"><p>This will only work on Micron devices devices of model number 9200. Support for\r
+new devices be added subsequently. Results for any other device are undefined.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-micron-smart-add-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-MICRON\-SMART\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-MICRON\-SMART\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme micron vs\-smart\-add\-log\fR <device> \-f <json|normal>
+\fInvme micron vs\-smart\-add\-log\fR <device> \-f <json|normal>
.fi
.SH "DESCRIPTION"
.sp
.sp
This will only work on Micron devices devices of model numbers 54XX and OCP complaint controllers\&. Support for new devices may be added subsequently\&.
.SH "OPTIONS"
-.sp
-\-f <json|normal> controls the format of displayed output\&.
+.PP
+\-f <json|normal>
+.RS 4
+Controls the format of displayed output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme micron vs-smart-add-log</em> <device> -f <json|normal></pre>\r
+<pre class="content"><em>nvme micron vs-smart-add-log</em> <device> -f <json|normal></pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_options">OPTIONS</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>-f <json|normal> controls the format of displayed output.</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-f <json|normal>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Controls the format of displayed output.\r
+</p>\r
+</dd>\r
+</dl></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-micron-temperature-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-MICRON\-TEMPER" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-MICRON\-TEMPER" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-netapp-ontapdevices
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-NETAPP\-ONTAPD" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-NETAPP\-ONTAPD" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme netapp ontapdevices\fR [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme netapp ontapdevices\fR [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme netapp ontapdevices</em> [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme netapp ontapdevices</em> [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em> (default), <em>column</em>, or\r
- <em>json</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em> (default), <em>column</em>, or\r
+ <em>json</em>. Only one output format can be used at a time.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-netapp-smdevices
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-NETAPP\-SMDEVI" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-NETAPP\-SMDEVI" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme netapp smdevices\fR [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme netapp smdevices\fR [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme netapp smdevices</em> [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme netapp smdevices</em> [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-ns-descs
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-NS\-DESCS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-NS\-DESCS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme ns\-descs\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+\fInvme ns\-descs\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to stdout\&. Structure is not parsed by program\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme ns-descs</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+<pre class="content"><em>nvme ns-descs</em> <device> [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.\r
- Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-ns-rescan
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-NS\-RESCAN" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-NS\-RESCAN" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme ns\-rescan\fR <device>
+\fInvme ns\-rescan\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Requests NVMe controller rescans the namespaces\&. The <device> param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&.
.SH "OPTIONS"
-.sp
-None
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme ns-rescan</em> <device></pre>\r
+<pre class="content"><em>nvme ns-rescan</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_options">OPTIONS</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>None</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
+</dl></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-nvm-id-ctrl
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-NVM\-ID\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-NVM\-ID\-CTRL" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme nvm\-id\-ctrl\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme nvm\-id\-ctrl\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the data structure returned by the device will be decoded and displayed in one of several ways\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme nvm-id-ctrl</em> <device> [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme nvm-id-ctrl</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-nvme-mi-recv
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-NVME\-MI\-RECV" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-NVME\-MI\-RECV" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme nvme\-mi\-recv\fR <device> [\-\-opcode=<opcode> | \-o <opcode>]
- [\-\-namespace\-id=<nsid>]
- [\-\-data\-len=<data\-len> | \-l <data\-len>]
- [\-\-nmimt=<nmimt> | \-m <nmimt>]
- [\-\-nmd0=<nmd0> | \-0 <nmd0>]
- [\-\-nmd1=<nmd1> | \-1 <nmd1>]
- [\-\-input\-file=<file> | \-i <file>]
+\fInvme nvme\-mi\-recv\fR <device> [\-\-opcode=<opcode> | \-O <opcode>]
+ [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-data\-len=<data\-len> | \-l <data\-len>]
+ [\-\-nmimt=<nmimt> | \-m <nmimt>]
+ [\-\-nmd0=<nmd0> | \-0 <nmd0>] [\-\-nmd1=<nmd1> | \-1 <nmd1>]
+ [\-\-input\-file=<file> | \-i <file>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <opcode>, \-\-opcode=<opcode>
+\-O <opcode>, \-\-opcode=<opcode>
.RS 4
The NVMe\-MI opcode to send to the device in the command
.RE
.RS 4
If the command is a data\-out (write) command, use this file to fill the buffer sent to the device\&. If no file is given, assumed to use STDIN\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
.RS 4
.\}
.nf
-# nvme nvme\-mi\-recv /dev/nvme0n1 \-o 5 \-m 1 \-0 0 \-1 0x100 \-l 256
+# nvme nvme\-mi\-recv /dev/nvme0n1 \-O 5 \-m 1 \-0 0 \-1 0x100 \-l 256
.fi
.if n \{\
.RE
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme nvme-mi-recv</em> <device> [--opcode=<opcode> | -o <opcode>]\r
- [--namespace-id=<nsid>]\r
- [--data-len=<data-len> | -l <data-len>]\r
- [--nmimt=<nmimt> | -m <nmimt>]\r
- [--nmd0=<nmd0> | -0 <nmd0>]\r
- [--nmd1=<nmd1> | -1 <nmd1>]\r
- [--input-file=<file> | -i <file>]</pre>\r
+<pre class="content"><em>nvme nvme-mi-recv</em> <device> [--opcode=<opcode> | -O <opcode>]\r
+ [--namespace-id=<nsid> | -n <nsid>]\r
+ [--data-len=<data-len> | -l <data-len>]\r
+ [--nmimt=<nmimt> | -m <nmimt>]\r
+ [--nmd0=<nmd0> | -0 <nmd0>] [--nmd1=<nmd1> | -1 <nmd1>]\r
+ [--input-file=<file> | -i <file>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <opcode>\r
+-O <opcode>\r
</dt>\r
<dt class="hdlist1">\r
--opcode=<opcode>\r
assumed to use STDIN.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
</p>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><code># nvme nvme-mi-recv /dev/nvme0n1 -o 5 -m 1 -0 0 -1 0x100 -l 256</code></pre>\r
+<pre><code># nvme nvme-mi-recv /dev/nvme0n1 -O 5 -m 1 -0 0 -1 0x100 -l 256</code></pre>\r
</div></div>\r
</li>\r
</ul></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-nvme-mi-send
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-NVME\-MI\-SEND" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-NVME\-MI\-SEND" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme nvme\-mi\-send\fR <device> [\-\-opcode=<opcode> | \-o <opcode>]
- [\-\-namespace\-id=<nsid>]
- [\-\-data\-len=<data\-len> | \-l <data\-len>]
- [\-\-nmimt=<nmimt> | \-m <nmimt>]
- [\-\-nmd0=<nmd0> | \-0 <nmd0>]
- [\-\-nmd1=<nmd1> | \-1 <nmd1>]
- [\-\-input\-file=<file> | \-i <file>]
+\fInvme nvme\-mi\-send\fR <device> [\-\-opcode=<opcode> | \-O <opcode>]
+ [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-data\-len=<data\-len> | \-l <data\-len>]
+ [\-\-nmimt=<nmimt> | \-m <nmimt>]
+ [\-\-nmd0=<nmd0> | \-0 <nmd0>] [\-\-nmd1=<nmd1> | \-1 <nmd1>]
+ [\-\-input\-file=<file> | \-i <file>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <opcode>, \-\-opcode=<opcode>
+\-O <opcode>, \-\-opcode=<opcode>
.RS 4
The NVMe\-MI opcode to send to the device in the command
.RE
.RS 4
If the command is a data\-out (write) command, use this file to fill the buffer sent to the device\&. If no file is given, assumed to use STDIN\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
.RS 4
.\}
.nf
-# nvme nvme\-mi\-send /dev/nvme0n1 \-o 6 \-m 1 \-0 0 \-1 0x100 \-l 256 \-i vpd\&.bin
+# nvme nvme\-mi\-send /dev/nvme0n1 \-O 6 \-m 1 \-0 0 \-1 0x100 \-l 256 \-i vpd\&.bin
.fi
.if n \{\
.RE
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme nvme-mi-send</em> <device> [--opcode=<opcode> | -o <opcode>]\r
- [--namespace-id=<nsid>]\r
- [--data-len=<data-len> | -l <data-len>]\r
- [--nmimt=<nmimt> | -m <nmimt>]\r
- [--nmd0=<nmd0> | -0 <nmd0>]\r
- [--nmd1=<nmd1> | -1 <nmd1>]\r
- [--input-file=<file> | -i <file>]</pre>\r
+<pre class="content"><em>nvme nvme-mi-send</em> <device> [--opcode=<opcode> | -O <opcode>]\r
+ [--namespace-id=<nsid> | -n <nsid>]\r
+ [--data-len=<data-len> | -l <data-len>]\r
+ [--nmimt=<nmimt> | -m <nmimt>]\r
+ [--nmd0=<nmd0> | -0 <nmd0>] [--nmd1=<nmd1> | -1 <nmd1>]\r
+ [--input-file=<file> | -i <file>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <opcode>\r
+-O <opcode>\r
</dt>\r
<dt class="hdlist1">\r
--opcode=<opcode>\r
assumed to use STDIN.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
</p>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><code># nvme nvme-mi-send /dev/nvme0n1 -o 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin</code></pre>\r
+<pre><code># nvme nvme-mi-send /dev/nvme0n1 -O 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin</code></pre>\r
</div></div>\r
</li>\r
</ul></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-ocp-clear-fw-activate-history
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-OCP\-CLEAR\-FW" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-OCP\-CLEAR\-FW" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-ocp-clear-pcie-correctable-error-counters
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-OCP\-CLEAR\-PC" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-OCP\-CLEAR\-PC" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-ocp-eol-plp-failure-mode
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-OCP\-EOL\-PLP\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-OCP\-EOL\-PLP\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme ocp eol\-plp\-failure\-mode\fR <device> [\-\-mode=<mode> | \-m <mode>] [\-\-no\-uuid | \-n] [\-\-save | \-s]
- [\-\-sel=<select> | \-s <select>]
+\fInvme ocp eol\-plp\-failure\-mode\fR <device> [\-\-mode=<mode> | \-m <mode>]
+ [\-\-no\-uuid | \-n] [\-\-save | \-s]
+ [\-\-sel=<select> | \-s <select>]
.fi
.SH "DESCRIPTION"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme ocp eol-plp-failure-mode</em> <device> [--mode=<mode> | -m <mode>] [--no-uuid | -n] [--save | -s]\r
- [--sel=<select> | -s <select>]</pre>\r
+<pre class="content"><em>nvme ocp eol-plp-failure-mode</em> <device> [--mode=<mode> | -m <mode>]\r
+ [--no-uuid | -n] [--save | -s]\r
+ [--sel=<select> | -s <select>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Save the attribute so that it persists through all power states and resets.\r
+ Save the attribute so that it persists through all power states and\r
+ resets.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-ocp-latency-monitor-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-OCP\-LATENCY\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-OCP\-LATENCY\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-ocp-smart-add-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-OCP\-SMART\-AD" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-OCP\-SMART\-AD" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: persistent-event-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "PERSISTENT\-EVENT\-L" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "PERSISTENT\-EVENT\-L" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme persistent\-event\-log\fR <device> [\-\-action=<action> | \-a <action>]
- [\-\-log\-len=<log\-len> | \-l <log\-len>]
- [\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-log\-len=<log\-len> | \-l <log\-len>] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw persistent event log buffer to stdout\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme persistent-event-log</em> <device> [--action=<action> | -a <action>]\r
- [--log-len=<log-len> | -l <log-len>]\r
- [--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--log-len=<log-len> | -l <log-len>] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- While try to retrieve this log action the controller shall take\r
- during processing this persistent log page command. This mandatory\r
- field, based on the value issued it may Read Log Data, Establish\r
- Context and Read Log Data or Release Context can occur. For More\r
- details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent\r
- Event Log (Log Identifier 0Dh)\r
+ While try to retrieve this log action the controller shall take\r
+ during processing this persistent log page command. This mandatory\r
+ field, based on the value issued it may Read Log Data, Establish\r
+ Context and Read Log Data or Release Context can occur. For More\r
+ details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent\r
+ Event Log (Log Identifier 0Dh)\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Allocates a buffer of <log-len> bytes size and requests this\r
- many bytes be returned in the constructed NVMe command. This\r
- param is mandatory. If <log-len> given is 0 and action is 0,\r
- it will read the Total Log Length(TLL) of the page.\r
+ Allocates a buffer of <log-len> bytes size and requests this\r
+ many bytes be returned in the constructed NVMe command. This\r
+ param is mandatory. If <log-len> given is 0 and action is 0,\r
+ it will read the Total Log Length(TLL) of the page.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Print the raw persistent event log buffer to stdout.\r
+ Print the raw persistent event log buffer to stdout.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.\r
- Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-pred-lat-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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-PRED\-LAT\-EVE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-PRED\-LAT\-EVE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme pred\-lat\-event\-agg\-log\fR <device> [\-\-log\-entries=<log_entries> | \-e <log_entries>]
+\fInvme pred\-lat\-event\-agg\-log\fR <device>
+ [\-\-log\-entries=<log_entries> | \-e <log_entries>]
[\-\-rae | \-r] [\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw Predictable Latency Event Aggregate log buffer to stdout\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme pred-lat-event-agg-log</em> <device> [--log-entries=<log_entries> | -e <log_entries>]\r
+<pre class="content"><em>nvme pred-lat-event-agg-log</em> <device>\r
+ [--log-entries=<log_entries> | -e <log_entries>]\r
[--rae | -r] [--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Retrieve the Predictable Latency Event Aggregate Log pending entries.\r
- This argument is mandatory and its success may depend on the device’s\r
- statistics to provide this log For More details see NVM Express 1.4 Spec.\r
- Section 5.14.1.11. The maximum number of log entries supported is 2044\r
- for the device.\r
+ Retrieve the Predictable Latency Event Aggregate Log pending entries.\r
+ This argument is mandatory and its success may depend on the device’s\r
+ statistics to provide this log For More details see NVM Express 1.4 Spec.\r
+ Section 5.14.1.11. The maximum number of log entries supported is 2044\r
+ for the device.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.\r
- Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or <em>binary</em>.\r
+ Only one output format can be used at a time.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-predictable-lat-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-PREDICTABLE\-L" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-PREDICTABLE\-L" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.nf
\fInvme predictable\-lat\-log\fR <device> [\-\-nvmset\-id=<nvmset_id> | \-i <nvmset_id>]
[\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw Predictable latency per NVM set log buffer to stdout\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="verseblock">\r
<pre class="content"><em>nvme predictable-lat-log</em> <device> [--nvmset-id=<nvmset_id> | -i <nvmset_id>]\r
[--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Retrieve the Predictable latency per NVM set log for the given nvmset id.\r
- This argument is mandatory and its success may depend on the device’s\r
- statistics to provide this log For More details see NVM Express 1.4 Spec.\r
- Section 5.14.1.10. The default nvmset id to use is 1 for the device.\r
+ Retrieve the Predictable latency per NVM set log for the given nvmset id.\r
+ This argument is mandatory and its success may depend on the device’s\r
+ statistics to provide this log For More details see NVM Express 1.4 Spec.\r
+ Section 5.14.1.10. The default nvmset id to use is 1 for the device.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-primary-ctrl-caps
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-PRIMARY\-CTRL\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-PRIMARY\-CTRL\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme primary\-ctrl\-caps\fR <device> [\-o <format> | \-\-output\-format=<format>]
+\fInvme primary\-ctrl\-caps\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the structure may be returned in one of several ways depending on the option flags; the structure may be parsed by the program or the raw buffer may be printed to stdout\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-H, \-\-human\-readable
+.RS 4
+This option will parse and format many of the bit fields into human\-readable formats\&.
+.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
-\-H, \-\-human\-readable
+\-v, \-\-verbose
.RS 4
-This option will parse and format many of the bit fields into human\-readable formats\&.
+Increase the information detail in the output\&.
.RE
.SH "EXAMPLES"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme primary-ctrl-caps</em> <device> [-o <format> | --output-format=<format>]</pre>\r
+<pre class="content"><em>nvme primary-ctrl-caps</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-H\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--human-readable\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ This option will parse and format many of the bit fields\r
+ into human-readable formats.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--H\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---human-readable\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- This option will parse and format many of the bit fields\r
- into human-readable formats.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-read
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-READ" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-READ" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-prinfo=<prinfo> | \-p <prinfo>]
[\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
[\-\-app\-tag=<apptag> | \-a <apptag>]
- [\-\-limited\-retry | \-l]
- [\-\-force\-unit\-access | \-f]
+ [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f]
[\-\-dir\-type=<type> | \-T <type>]
- [\-\-dir\-spec=<spec> | \-S <spec>]
- [\-\-dsm=<dsm> | \-D <dsm>]
- [\-\-show\-command | \-v]
- [\-\-dry\-run | \-w]
- [\-\-latency | \-t]
+ [\-\-dir\-spec=<spec> | \-S <spec>] [\-\-dsm=<dsm> | \-D <dsm>]
+ [\-\-show\-command | \-V] [\-\-dry\-run | \-w] [\-\-latency | \-t]
[\-\-storage\-tag<storage\-tag> | \-g <storage\-tag>]
- [\-\-storage\-tag\-check | \-C ]
- [\-\-force]
+ [\-\-storage\-tag\-check | \-C] [\-\-force]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The Read command reads the logical blocks specified by the command from the medium and copies to the data data buffer provided\&. Will use stdout by default if you don\(cqt provide a file\&.
.SH "OPTIONS"
.PP
-\-\-start\-block=<slba>, \-s <slba>
+\-s <slba>, \-\-start\-block=<slba>
.RS 4
Start block\&.
.RE
.PP
-\-\-block\-count, \-c
+\-c, \-\-block\-count
.RS 4
The number of blocks to transfer\&. This is a zeroes based value to align with the kernel\(cqs use of this field\&. (ie\&. 0 means transfer 1 block)\&.
.RE
.PP
-\-\-data\-size=<size>, \-z <size>
+\-z <size>, \-\-data\-size=<size>
.RS 4
Size of data, in bytes\&.
.RE
.PP
-\-\-metadata\-size=<size>, \-y <size>
+\-y <size>, \-\-metadata\-size=<size>
.RS 4
Size of metadata in bytes\&.
.RE
.PP
-\-\-data=<data\-file>, \-d <data\-file>
+\-d <data\-file>, \-\-data=<data\-file>
.RS 4
Data file\&. If none provided, contents are sent to STDOUT\&.
.RE
.PP
-\-\-metadata=<metadata\-file>, \-M <metadata\-file>
+\-M <metadata\-file>, \-\-metadata=<metadata\-file>
.RS 4
Metadata file, if necessary\&.
.RE
.PP
-\-
\-prinfo=<prinfo>, \-p <prinfo>
+\-
p <prinfo>, \-\-prinfo=<prinfo>
.RS 4
Protection Information field definition\&.
.TS
.sp 1
.RE
.PP
-\-\-ref\-tag=<reftag>, \-r <reftag>
+\-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4
Optional reftag when used with protection information\&.
.RE
.PP
-\-
\-app\-tag\-mask=<appmask>, \-m <appmask>
+\-
m <appmask>, \-\-app\-tag\-mask=<appmask>
.RS 4
Optional application tag mask when used with protection information\&.
.RE
.PP
-\-\-force\-unit\-access, \-f
+\-f, \-\-force\-unit\-access
.RS 4
Set the force\-unit access flag\&.
.RE
The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&.
.RE
.PP
-\-v, \-\-show\-cmd
+\-V, \-\-show\-cmd
.RS 4
Print out the command to be sent\&.
.RE
.RS 4
Ignore namespace is currently busy and performed the operation even though\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
[--prinfo=<prinfo> | -p <prinfo>]\r
[--app-tag-mask=<appmask> | -m <appmask>]\r
[--app-tag=<apptag> | -a <apptag>]\r
- [--limited-retry | -l]\r
- [--force-unit-access | -f]\r
+ [--limited-retry | -l] [--force-unit-access | -f]\r
[--dir-type=<type> | -T <type>]\r
- [--dir-spec=<spec> | -S <spec>]\r
- [--dsm=<dsm> | -D <dsm>]\r
- [--show-command | -v]\r
- [--dry-run | -w]\r
- [--latency | -t]\r
+ [--dir-spec=<spec> | -S <spec>] [--dsm=<dsm> | -D <dsm>]\r
+ [--show-command | -V] [--dry-run | -w] [--latency | -t]\r
[--storage-tag<storage-tag> | -g <storage-tag>]\r
- [--storage-tag-check | -C ]\r
- [--force]</pre>\r
+ [--storage-tag-check | -C] [--force]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
---start-block=<slba>\r
+-s <slba>\r
</dt>\r
<dt class="hdlist1">\r
--s <slba>\r
+--start-block=<slba>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---block-count\r
+-c\r
</dt>\r
<dt class="hdlist1">\r
--c\r
+--block-count\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---data-size=<size>\r
+-z <size>\r
</dt>\r
<dt class="hdlist1">\r
--z <size>\r
+--data-size=<size>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---metadata-size=<size>\r
+-y <size>\r
</dt>\r
<dt class="hdlist1">\r
--y <size>\r
+--metadata-size=<size>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---data=<data-file>\r
+-d <data-file>\r
</dt>\r
<dt class="hdlist1">\r
--d <data-file>\r
+--data=<data-file>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---metadata=<metadata-file>\r
+-M <metadata-file>\r
</dt>\r
<dt class="hdlist1">\r
--M <metadata-file>\r
+--metadata=<metadata-file>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---prinfo=<prinfo>\r
+-p <prinfo>\r
</dt>\r
<dt class="hdlist1">\r
--p <prinfo>\r
+--prinfo=<prinfo>\r
</dt>\r
<dd>\r
<p>\r
</div>\r
</dd>\r
<dt class="hdlist1">\r
---ref-tag=<reftag>\r
+-r <reftag>\r
</dt>\r
<dt class="hdlist1">\r
--r <reftag>\r
+--ref-tag=<reftag>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag-mask=<appmask>\r
+-m <appmask>\r
</dt>\r
<dt class="hdlist1">\r
--m <appmask>\r
+--app-tag-mask=<appmask>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---force-unit-access\r
+-f\r
</dt>\r
<dt class="hdlist1">\r
--f\r
+--force-unit-access\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--v\r
+-V\r
</dt>\r
<dt class="hdlist1">\r
--show-cmd\r
even though.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-reset
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESET" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-RESET" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme reset\fR <device>
+\fInvme reset\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Requests NVMe controller reset\&. The <device> param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&.
.SH "OPTIONS"
-.sp
-None
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme reset</em> <device></pre>\r
+<pre class="content"><em>nvme reset</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_options">OPTIONS</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>None</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
+</dl></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-resv-acquire
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESV\-ACQUIRE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-ACQUIRE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme resv\-acquire\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-crkey=<crkey> | \-c <crkey>]
-
[\-\-prkey=<prkey> | \-p <prkey>]
- [\-\-rtype=<rtype> | \-t <rtype>]
- [\-\-racqa=<racqa> | \-a <racqa>]
- [\-\-iekey | \-i]
+ [\-\-crkey=<crkey> | \-c <crkey>]
+ [\-\-prkey=<prkey> | \-p <prkey>]
+ [\-\-rtype=<rtype> | \-t <rtype>]
+ [\-\-racqa=<racqa> | \-a <racqa>] [\-\-iekey | \-i]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Indicator option, defaults to
\fI0\fR\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme resv-acquire</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--crkey=<crkey> | -c <crkey>]\r
- [--prkey=<prkey> | -p <prkey>]\r
- [--rtype=<rtype> | -t <rtype>]\r
- [--racqa=<racqa> | -a <racqa>]\r
- [--iekey | -i]</pre>\r
+ [--crkey=<crkey> | -c <crkey>]\r
+ [--prkey=<prkey> | -p <prkey>]\r
+ [--rtype=<rtype> | -t <rtype>]\r
+ [--racqa=<racqa> | -a <racqa>] [--iekey | -i]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<p>\r
Ignore Existing Key: If this bit is set to a <em>1</em>, then the\r
Current Reservation Key (CRKEY) check is disabled and the command\r
- shall succeed regardless of the CRKEY field value.\r
+ shall succeed regardless of the CRKEY field value.\r
</p>\r
<div class="paragraph"><p>Indicator option, defaults to <em>0</em>.</p></div>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-resv-notif-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESV\-NOTIF\-L" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-NOTIF\-L" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme resv\-notif\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
+\fInvme resv\-notif\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the returned Reservation Notification log structure may be returned in one of several ways depending on the option flags; the structure may parsed by the program and printed in a readable format or the raw buffer may be printed to stdout for another program to parse\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>nvme-resv-notif-log -\r
- Send NVMe Reservation Notification log page request, return result and log\r
+ Send NVMe Reservation Notification log page request, return result and log\r
</p>\r
</div>\r
</div>\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme resv-notif-log</em> <device> [--output-format=<fmt> | -o <fmt>]</pre>\r
+<pre class="content"><em>nvme resv-notif-log</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-resv-register
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESV\-REGISTER" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-REGISTER" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme resv\-register\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-crkey=<crkey> | \-c <crkey>]
- [\-\-nrkey=<nrkey> | \-k <nrkey>]
- [\-\-rrega=<rrega> | \-r <rrega>]
- [\-\-cptpl=<cptpl> | \-p <cptpl>]
- [\-\-iekey | \-i]
+ [\-\-crkey=<crkey> | \-c <crkey>]
+ [\-\-nrkey=<nrkey> | \-k <nrkey>]
+ [\-\-rrega=<rrega> | \-r <rrega>]
+ [\-\-cptpl=<cptpl> | \-p <cptpl>] [\-\-iekey | \-i]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Indicator option, defaults to
\fI0\fR\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme resv-register</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--crkey=<crkey> | -c <crkey>]\r
- [--nrkey=<nrkey> | -k <nrkey>]\r
- [--rrega=<rrega> | -r <rrega>]\r
- [--cptpl=<cptpl> | -p <cptpl>]\r
- [--iekey | -i]</pre>\r
+ [--crkey=<crkey> | -c <crkey>]\r
+ [--nrkey=<nrkey> | -k <nrkey>]\r
+ [--rrega=<rrega> | -r <rrega>]\r
+ [--cptpl=<cptpl> | -p <cptpl>] [--iekey | -i]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
<div class="paragraph"><p>Indicator option, defaults to <em>0</em>.</p></div>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-resv-release
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESV\-RELEASE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-RELEASE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme resv\-release\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-crkey=<crkey> | \-c <crkey>]
- [\-\-rtype=<rtype> | \-t <rtype>]
- [\-\-rrela=<rrela> | \-a <rrela>]
- [\-\-iekey | \-i]
+ [\-\-crkey=<crkey> | \-c <crkey>]
+ [\-\-rtype=<rtype> | \-t <rtype>]
+ [\-\-rrela=<rrela> | \-a <rrela>] [\-\-iekey | \-i]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Indicator option, defaults to
\fI0\fR\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme resv-release</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--crkey=<crkey> | -c <crkey>]\r
- [--rtype=<rtype> | -t <rtype>]\r
- [--rrela=<rrela> | -a <rrela>]\r
- [--iekey | -i]</pre>\r
+ [--crkey=<crkey> | -c <crkey>]\r
+ [--rtype=<rtype> | -t <rtype>]\r
+ [--rrela=<rrela> | -a <rrela>] [--iekey | -i]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
<div class="paragraph"><p>Indicator option, defaults to <em>0</em>.</p></div>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-resv-report
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RESV\-REPORT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-RESV\-REPORT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme resv\-report\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-numd=<num\-dwords> | \-d <num\-dwords>]
- [\-\-eds | \-e]
+ [\-\-numd=<num\-dwords> | \-d <num\-dwords>] [\-\-eds | \-e]
[\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw buffer to stdout\&. Structure is not parsed by program\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme resv-report</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--numd=<num-dwords> | -d <num-dwords>]\r
- [--eds | -e]\r
+ [--numd=<num-dwords> | -d <num-dwords>] [--eds | -e]\r
[--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-rpmb
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-RPMB" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-RPMB" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme rpmb\fR <device> [\-\-cmd=<command> | \-c <command>]
- [\-\-msgfile=<data\-file> | \-f <data\-file>]
- [\-\-keyfile=<key\-file> | \-g <key\-file>]
- [\-\-key=<key> | \-k <key>]
- [\-\-msg=<data> | \-d <data>]
- [\-\-address=<offset> | \-o <offset>]
- [\-\-blocks=<512 byte sectors> | \-b <sectors> ]
- [\-\-target=<target\-id> | \-t <id> ]
+ [\-\-msgfile=<data\-file> | \-f <data\-file>]
+ [\-\-keyfile=<key\-file> | \-g <key\-file>]
+ [\-\-key=<key> | \-k <key>] [\-\-msg=<data> | \-d <data>]
+ [\-\-address=<offset> | \-o <offset>]
+ [\-\-blocks=<512 byte sectors> | \-b <sectors>]
+ [\-\-target=<target\-id> | \-t <id>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
The size in 512 byte sectors to be used for data transfer commands (read or write) for a specified RPMB target\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme rpmb</em> <device> [--cmd=<command> | -c <command>]\r
- [--msgfile=<data-file> | -f <data-file>]\r
- [--keyfile=<key-file> | -g <key-file>]\r
- [--key=<key> | -k <key>]\r
- [--msg=<data> | -d <data>]\r
- [--address=<offset> | -o <offset>]\r
- [--blocks=<512 byte sectors> | -b <sectors> ]\r
- [--target=<target-id> | -t <id> ]</pre>\r
+ [--msgfile=<data-file> | -f <data-file>]\r
+ [--keyfile=<key-file> | -g <key-file>]\r
+ [--key=<key> | -k <key>] [--msg=<data> | -d <data>]\r
+ [--address=<offset> | -o <offset>]\r
+ [--blocks=<512 byte sectors> | -b <sectors>]\r
+ [--target=<target-id> | -t <id>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
(read or write) for a specified RPMB target.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-sanitize-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SANITIZE\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SANITIZE\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme sanitize\-log\fR <device> [\-\-rae | \-r] [\-\-output\-format=<fmt> | \-o <fmt>]
- [\-\-human\-readable | \-H]
- [\-\-raw\-binary | \-b]
+\fInvme sanitize\-log\fR <device> [\-\-rae | \-r] [\-\-human\-readable | \-H]
+ [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Retain an Asynchronous Event\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
-.RS 4
-Set the reporting format to
-\fInormal\fR,
-\fIjson\fR, or
-\fIbinary\fR\&. Only one output format can be used at a time\&.
-.RE
-.PP
\-H, \-\-human\-readable
.RS 4
This option will parse and format many of the bit fields into human\-readable formats\&.
.RS 4
Print the raw buffer to stdout\&. Structure is not parsed by program\&. This overrides the vendor specific and human readable options\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme sanitize-log</em> <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]\r
- [--human-readable | -H]\r
- [--raw-binary | -b]</pre>\r
+<pre class="content"><em>nvme sanitize-log</em> <device> [--rae | -r] [--human-readable | -H]\r
+ [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<td align="left" valign="top"><p class="table">Global Data Erased bit\r
If set to 1 then non-volatile storage in the NVM subsystem has\r
not been written to:\r
- a) since being manufactured and the NVM subsystem has never been sanitized; or\r
- b) since the most recent successful sanitize operation.\r
+ a) since being manufactured and the NVM subsystem has never been sanitized; or\r
+ b) since the most recent successful sanitize operation.\r
If cleared to 0, then non-volatile storage in the NVM subsystem has been written to:\r
- a) since being manufactured and the NVM subsystem has never been sanitized; or\r
- b) since the most recent successful sanitize operation of the NVM subsystem.</p></td>\r
+ a) since being manufactured and the NVM subsystem has never been sanitized; or\r
+ b) since the most recent successful sanitize operation of the NVM subsystem.</p></td>\r
</tr>\r
</tbody>\r
</table>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
-</dt>\r
-<dt class="hdlist1">\r
---output-format=<format>\r
-</dt>\r
-<dd>\r
-<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
-</p>\r
-</dd>\r
-<dt class="hdlist1">\r
-H\r
</dt>\r
<dt class="hdlist1">\r
program. This overrides the vendor specific and human readable options.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-sanitize
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SANITIZE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SANITIZE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme sanitize\fR <device> [\-\-no\-dealloc | \-d]
- [\-\-oipbp | \-i]
- [\-\-owpass=<overwrite\-pass\-count> | \-n <overwrite\-pass\-count>]
- [\-\-ause | \-u]
- [\-\-sanact=<action> | \-a <action>]
- [\-\-ovrpat=<overwrite\-pattern> | \-p <overwrite\-pattern>]
- [\-\-force]
+\fInvme sanitize\fR <device> [\-\-no\-dealloc | \-d] [\-\-oipbp | \-i]
+ [\-\-owpass=<overwrite\-pass\-count> | \-n <overwrite\-pass\-count>]
+ [\-\-ause | \-u] [\-\-sanact=<action> | \-a <action>]
+ [\-\-ovrpat=<overwrite\-pattern> | \-p <overwrite\-pattern>]
+ [\-\-force]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Ignore namespace is currently busy and performed the operation even though\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme sanitize</em> <device> [--no-dealloc | -d]\r
- [--oipbp | -i]\r
- [--owpass=<overwrite-pass-count> | -n <overwrite-pass-count>]\r
- [--ause | -u]\r
- [--sanact=<action> | -a <action>]\r
- [--ovrpat=<overwrite-pattern> | -p <overwrite-pattern>]\r
- [--force]</pre>\r
+<pre class="content"><em>nvme sanitize</em> <device> [--no-dealloc | -d] [--oipbp | -i]\r
+ [--owpass=<overwrite-pass-count> | -n <overwrite-pass-count>]\r
+ [--ause | -u] [--sanact=<action> | -a <action>]\r
+ [--ovrpat=<overwrite-pattern> | -p <overwrite-pattern>]\r
+ [--force]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- No Deallocate After Sanitize:\r
- If set, then the controller shall not deallocate any logical\r
- blocks as a result of successfully completing the sanitize\r
- operation. If cleared, then the controller should deallocate\r
- logical blocks as a result of successfully completing the\r
- sanitize operation. This bit shall be ignored if the Sanitize\r
- Action field is set to 001b (i.e., Exit Failure Mode).\r
+ No Deallocate After Sanitize:\r
+ If set, then the controller shall not deallocate any logical\r
+ blocks as a result of successfully completing the sanitize\r
+ operation. If cleared, then the controller should deallocate\r
+ logical blocks as a result of successfully completing the\r
+ sanitize operation. This bit shall be ignored if the Sanitize\r
+ Action field is set to 001b (i.e., Exit Failure Mode).\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Overwrite Invert Pattern Between Passes:\r
- If set, then the Overwrite Pattern shall be inverted between\r
- passes. If cleared, then the overwrite pattern shall not be\r
- inverted between passes. This bit shall be ignored unless the\r
- Sanitize Action field is set to 011b (i.e., Overwrite).\r
+ Overwrite Invert Pattern Between Passes:\r
+ If set, then the Overwrite Pattern shall be inverted between\r
+ passes. If cleared, then the overwrite pattern shall not be\r
+ inverted between passes. This bit shall be ignored unless the\r
+ Sanitize Action field is set to 011b (i.e., Overwrite).\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Overwrite Pass Count:\r
- This field specifies the number of overwrite passes (i.e.,\r
- how many times the media is to be overwritten) using the data\r
- from the Overwrite Pattern field of this command. A value of 0\r
- specifies 16 overwrite passes. This field shall be ignored\r
- unless the Sanitize Action field is set to 011b (i.e., Overwrite).\r
+ Overwrite Pass Count:\r
+ This field specifies the number of overwrite passes (i.e.,\r
+ how many times the media is to be overwritten) using the data\r
+ from the Overwrite Pattern field of this command. A value of 0\r
+ specifies 16 overwrite passes. This field shall be ignored\r
+ unless the Sanitize Action field is set to 011b (i.e., Overwrite).\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Allow Unrestricted Sanitize Exit:\r
- If set, then the sanitize operation is performed in unrestricted\r
- completion mode. If cleared then the sanitize operation is\r
- performed in restricted completion mode. This bit shall be ignored\r
- if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode).\r
+ Allow Unrestricted Sanitize Exit:\r
+ If set, then the sanitize operation is performed in unrestricted\r
+ completion mode. If cleared then the sanitize operation is\r
+ performed in restricted completion mode. This bit shall be ignored\r
+ if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode).\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Sanitize Action:\r
+ Sanitize Action:\r
</p>\r
<div class="tableblock">\r
<table rules="all"\r
</dt>\r
<dd>\r
<p>\r
- Overwrite Pattern:\r
- This field is ignored unless the Sanitize Action field in\r
- Command Dword 10 is set to 011b (i.e., Overwrite). This field\r
- specifies a 32-bit pattern that is used for the Overwrite\r
- sanitize operation.\r
+ Overwrite Pattern:\r
+ This field is ignored unless the Sanitize Action field in\r
+ Command Dword 10 is set to 011b (i.e., Overwrite). This field\r
+ specifies a 32-bit pattern that is used for the Overwrite\r
+ sanitize operation.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Ignore namespace is currently busy and performed the operation\r
- even though.\r
+ Ignore namespace is currently busy and performed the operation\r
+ even though.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-clear-fw-activate-history
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-CLEAR" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-CLEAR" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
all commands work across all product families.</p></div>\r
<div class="paragraph"><p>The <em><device></em> may be either an NVMe character device (ex: /dev/nvme0) or an\r
nvme block device (ex: /dev/nvme0n1).</p></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-clear-pcie-correctable-errors
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-CLEAR" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-CLEAR" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme seagate clear\-pcie\-correctable\-errors [<device>] [OPTIONS]\fR
+\fInvme seagate clear\-pcie\-correctable\-errors [<device>] [OPTIONS]\fR
.fi
.SH "DESCRIPTION"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme seagate clear-pcie-correctable-errors [<device>] [OPTIONS]</em></pre>\r
+<pre class="content"><em>nvme seagate clear-pcie-correctable-errors [<device>] [OPTIONS]</em></pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
all commands work across all product families.</p></div>\r
<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0), or an\r
nvme block device (ex: /dev/nvme0n1).</p></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-cloud-SSD-plugin-version
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-CLOUD" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-CLOUD" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-get-ctrl-tele
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-GET\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-GET\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
all commands work across all product families.</p></div>\r
<div class="paragraph"><p>The '<device>'parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an\r
nvme block device (ex: /dev/nvme0n1).</p></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-get-host-tele
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-GET\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-GET\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
This will only work on Seagate devices supporting this feature\&. Not all commands work across all product families\&.
.sp
-The \fI<device>\fR parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1)\&.
+The \fI<device>\fR parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an block device (ex: /dev/nvme0n1)\&.
.SH "OPTIONS"
.PP
\-n <NUM>, \-\-namespace\-id=<NUM>
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This will only work on Seagate devices supporting this feature. Not all\r
+<div class="paragraph"><p>This will only work on Seagate devices supporting this feature. Not all\r
commands work across all product families.</p></div>\r
-<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an\r
-nvme block device (ex: /dev/nvme0n1).</p></div>\r
+<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device\r
+(ex: /dev/nvme0) or an block device (ex: /dev/nvme0n1).</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
</dt>\r
<dd>\r
<p>\r
- 1 - controller shall capture Data representing the internal state of the controller at the time the command is processed.\r
+ 1 - controller shall capture Data representing the internal state of the\r
+ controller at the time the command is processed.\r
0 - controller shall not update the Telemetry Host Initiated Data.\r
</p>\r
</dd>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-help
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-HELP" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-HELP" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-plugin-version
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-PLUGI" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-PLUGI" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-version
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-VERSI" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-VERSI" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-vs-fw-activate-history
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-VS\-F" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-VS\-F" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
all commands work across all product families.</p></div>\r
<div class="paragraph"><p>The <em><device></em> may be either an NVMe character device (ex: /dev/nvme0) or an\r
nvme block device (ex: /dev/nvme0n1).</p></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-vs-internal-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-VS\-I" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-VS\-I" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
all commands work across all product families.</p></div>\r
-<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an\r
-nvme block device (ex: /dev/nvme0n1).</p></div>\r
+<div class="paragraph"><p>The <em><device></em> parameter is mandatory and may be either an NVMe character device\r
+(ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div class="sect1">\r
<h2 id="_examples">EXAMPLES</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>Get the Seagate vendor specific Controller-Initiated telemetry log for the specified device.</p></div>\r
+<div class="paragraph"><p>Get the Seagate vendor specific Controller-Initiated telemetry log for the\r
+specified device.</p></div>\r
<div class="listingblock">\r
<div class="content">\r
<pre><code># nvme seagate vs-internal-log /dev/nvme0</code></pre>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-vs-log-page-sup
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-VS\-L" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-VS\-L" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
The \fI<device>\fR may be either an NVMe character device (ex: /dev/nvme0) or an NVMe block device (ex: /dev/nvme0n1)\&.
.SH "OPTIONS"
.PP
-\-o <FMT>, \-\-output\-format=<FMT>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Output in binary format
.RE
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
all commands work across all product families.</p></div>\r
<div class="paragraph"><p>The <em><device></em> may be either an NVMe character device (ex: /dev/nvme0) or an\r
NVMe block device (ex: /dev/nvme0n1).</p></div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <FMT>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<FMT>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-vs-pcie-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-VS\-P" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-VS\-P" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
The \fI<device>\fR parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1)\&.
.SH "OPTIONS"
.PP
-\-o <FMT>, \-\-output\-format=<FMT>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Output in binary format
.RE
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
all commands work across all product families.</p></div>\r
<div class="paragraph"><p>The <em><device></em> parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an\r
nvme block device (ex: /dev/nvme0n1).</p></div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <FMT>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<FMT>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-vs-smart-add-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-VS\-S" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-VS\-S" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
/dev/nvme0n1).</p></div>\r
<div class="paragraph"><p>The log contents may be associated with the controller, in which case the namespace parameter is ignored.</p></div>\r
<div class="paragraph"><p>Two logs exist, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM Supercap SMART log page)</p></div>\r
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
all commands work across all product families.</p></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-seagate-vs-temperature-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SEAGATE\-VS\-T" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SEAGATE\-VS\-T" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
The \*(Aq<device>\*(Aqparameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1)\&.
.SH "OPTIONS"
.PP
-\-o <FMT>, \-\-output\-format=<FMT>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Output in binary format
.RE
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
+<div class="paragraph"><p>This command will only work on Seagate devices supporting this feature. Not\r
all commands work across all product families.</p></div>\r
<div class="paragraph"><p>The '<device>'parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an\r
nvme block device (ex: /dev/nvme0n1).</p></div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <FMT>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<FMT>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-security-recv
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SECURITY\-RECV" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SECURITY\-RECV" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme security\-recv\fR <device> [\-\-size=<size> | \-x <size>]
- [\-\-secp=<security\-protocol> | \-p <security\-protocol>]
- [\-\-spsp=<protocol\-specific> | \-s <protocol\-specific>]
- [\-\-nssf=<nvme\-specific> | \-N <nvme\-specific>]
- [\-\-al=<allocation\-length> | \-t <allocation\-length>]
- [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-raw\-binary | \-b]
+ [\-\-secp=<security\-protocol> | \-p <security\-protocol>]
+
[\-\-spsp=<protocol\-specific> | \-s <protocol\-specific>]
+ [\-\-nssf=<nvme\-specific> | \-N <nvme\-specific>]
+
[\-\-al=<allocation\-length> | \-t <allocation\-length>]
+ [\-\-namespace\-id=<nsid> | \-n <nsid>] [\-\-raw\-binary | \-b]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Print the raw buffer to stdout\&. Defaults to print in hex\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No Examples
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme security-recv</em> <device> [--size=<size> | -x <size>]\r
- [--secp=<security-protocol> | -p <security-protocol>]\r
- [--spsp=<protocol-specific> | -s <protocol-specific>]\r
- [--nssf=<nvme-specific> | -N <nvme-specific>]\r
- [--al=<allocation-length> | -t <allocation-length>]\r
- [--namespace-id=<nsid> | -n <nsid>]\r
- [--raw-binary | -b]</pre>\r
+ [--secp=<security-protocol> | -p <security-protocol>]\r
+ [--spsp=<protocol-specific> | -s <protocol-specific>]\r
+ [--nssf=<nvme-specific> | -N <nvme-specific>]\r
+ [--al=<allocation-length> | -t <allocation-length>]\r
+ [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
Print the raw buffer to stdout. Defaults to print in hex.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-security-send
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SECURITY\-SEND" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SECURITY\-SEND" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme security\-send\fR <device> [\-\-file=<file> | \-f <file>]
- [\-\-secp=<security\-protocol> | \-p <security\-protocol>]
- [\-\-spsp=<protocol\-specific> | \-s <protocol\-specific>]
- [\-\-tl=<transfer\-length> | \-t <transfer\-length>]
- [\-\-nssf=<nvme\-specific> | \-N <nvme\-specific>]
- [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-secp=<security\-protocol> | \-p <security\-protocol>]
+ [\-\-spsp=<protocol\-specific> | \-s <protocol\-specific>]
+ [\-\-tl=<transfer\-length> | \-t <transfer\-length>]
+ [\-\-nssf=<nvme\-specific> | \-N <nvme\-specific>]
+ [\-\-namespace\-id=<nsid> | \-n <nsid>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
.RS 4
Transfer Length: The value of this field is specific to the Security Protocol as defined in SPC\-4\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No Examples
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme security-send</em> <device> [--file=<file> | -f <file>]\r
- [--secp=<security-protocol> | -p <security-protocol>]\r
- [--spsp=<protocol-specific> | -s <protocol-specific>]\r
- [--tl=<transfer-length> | -t <transfer-length>]\r
- [--nssf=<nvme-specific> | -N <nvme-specific>]\r
- [--namespace-id=<nsid> | -n <nsid>]</pre>\r
+ [--secp=<security-protocol> | -p <security-protocol>]\r
+ [--spsp=<protocol-specific> | -s <protocol-specific>]\r
+ [--tl=<transfer-length> | -t <transfer-length>]\r
+ [--nssf=<nvme-specific> | -N <nvme-specific>]\r
+ [--namespace-id=<nsid> | -n <nsid>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
Security Protocol as defined in SPC-4.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-self-test-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SELF\-TEST\-LO" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SELF\-TEST\-LO" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme self\-test\fR\-log <device> [\-\-log\-entries=<entries> | \-e <entries>]
- [\-\-output\-format=<FMT> | \-o <FMT>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Specifies how many DST log entries the program should request from the device\&. This must be at least one, and shouldn\(cqt exceed the 20 entries\&. Defaults to 20 DST log entries\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme self-test</em>-log <device> [--log-entries=<entries> | -e <entries>]\r
- [--output-format=<FMT> | -o <FMT>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-set-feature
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SET\-FEATURE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SET\-FEATURE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme set\-feature\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-feature\-id=<fid> | \-f <fid>] [\-\-value=<value> | \-v <value>]
- [\-\-uuid\-index=<uuid\-index> | \-U <uuid_index>]
- [\-\-data\-len=<data\-len> | \-l <data\-len>]
- [\-\-data=<data\-file> | \-d <data\-file>]
- [\-\-save | \-s]
+ [\-\-feature\-id=<fid> | \-f <fid>] [\-\-value=<value> | \-V <value>]
+ [\-\-uuid\-index=<uuid\-index> | \-U <uuid_index>]
+ [\-\-data\-len=<data\-len> | \-l <data\-len>]
+ [\-\-data=<data\-file> | \-d <data\-file>] [\-\-save | \-s]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The data file for the buffer submitted for this feature\&. Most known features do not use this value\&. The exceptions is LBA Range Type and host identifier\&. This defaults to STDIN so files and echo can be piped\&.
.RE
.PP
-\-v <value>, \-\-value=<value>
+\-V <value>, \-\-value=<value>
.RS 4
The value for command dword 11, the value you want to set the feature to\&.
.RE
.RS 4
UUID Index of the feature
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
.RS 4
.\}
.nf
-# nvme set\-feature /dev/nvme0 \-f 2 /dev/nvme0n1 \-v 0x1
+# nvme set\-feature /dev/nvme0 \-f 2 /dev/nvme0n1 \-V 0x1
.fi
.if n \{\
.RE
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme set-feature</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--feature-id=<fid> | -f <fid>] [--value=<value> | -v <value>]\r
- [--uuid-index=<uuid-index> | -U <uuid_index>]\r
- [--data-len=<data-len> | -l <data-len>]\r
- [--data=<data-file> | -d <data-file>]\r
- [--save | -s]</pre>\r
+ [--feature-id=<fid> | -f <fid>] [--value=<value> | -V <value>]\r
+ [--uuid-index=<uuid-index> | -U <uuid_index>]\r
+ [--data-len=<data-len> | -l <data-len>]\r
+ [--data=<data-file> | -d <data-file>] [--save | -s]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--v <value>\r
+-V <value>\r
</dt>\r
<dt class="hdlist1">\r
--value=<value>\r
UUID Index of the feature\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
-Sets the Power State (PS) to 1 in feature id 2:\r
+Sets the Power State (PS) to 1 in feature id 2:\r
</p>\r
<div class="listingblock">\r
<div class="content">\r
-<pre><code># nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -v 0x1</code></pre>\r
+<pre><code># nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -V 0x1</code></pre>\r
</div></div>\r
</li>\r
<li>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-set-property
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SET\-PROPERTY" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SET\-PROPERTY" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme set\-property\fR <device> [\-\-offset=<offset> | \-o <offset>]
- [\-\-value=<val> | \-v <val>]
+\fInvme set\-property\fR <device> [\-\-offset=<offset> | \-O <offset>]
+ [\-\-value=<val> | \-V <val>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Writes and shows the defined NVMe controller property for NVMe over Fabric\&.
.SH "OPTIONS"
.PP
-\-o, \-\-offset
+\-O, \-\-offset
.RS 4
The offset of the property\&.
.RE
.PP
-\-v
+\-V
.RS 4
\-\-value: The value of the property to be set\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples (yet)\&.
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme set-property</em> <device> [--offset=<offset> | -o <offset>]\r
- [--value=<val> | -v <val>]</pre>\r
+<pre class="content"><em>nvme set-property</em> <device> [--offset=<offset> | -O <offset>]\r
+ [--value=<val> | -V <val>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o\r
+-O\r
</dt>\r
<dt class="hdlist1">\r
--offset\r
</dt>\r
<dd>\r
<p>\r
- The offset of the property.\r
+ The offset of the property.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--v\r
+-V\r
</dt>\r
<dd>\r
<p>\r
The value of the property to be set.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-show-hostnqn
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SHOW\-HOSTNQN" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SHOW\-HOSTNQN" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme show\-hostnqn\fR
+\fInvme show\-hostnqn\fR [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Show the host NQN configured for the system\&. If /usr/local/etc/nvme/hostnqn is not present and systemd application\-specific machine IDs are available, this will show the systemd\-generated host NQN for the system\&.
.SH "OPTIONS"
-.sp
-No options needed
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
nvme show\-hostnqn
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme show-hostnqn</em></pre>\r
+<pre class="content"><em>nvme show-hostnqn</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>Show the host NQN configured for the system. If /usr/local/etc/nvme/hostnqn is\r
+<div class="paragraph"><p>Show the host NQN configured for the system. If /usr/local/etc/nvme/hostnqn is\r
not present and systemd application-specific machine IDs are available,\r
this will show the systemd-generated host NQN for the system.</p></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_options">OPTIONS</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>No options needed</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
+</dl></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" 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: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme show\-regs\fR <device> [\-\-human\-readable | \-H]
- [\-\-output\-format=<FMT> | \-o <FMT>]
+\fInvme show\-regs\fR <device> [\-\-human\-readable | \-H]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Display registers or supported properties in human readable format\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme show-regs</em> <device> [--human-readable | -H]\r
- [--output-format=<FMT> | -o <FMT>]</pre>\r
+<pre class="content"><em>nvme show-regs</em> <device> [--human-readable | -H]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Display registers or supported properties in human readable format.\r
+ Display registers or supported properties in human readable format.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-show-topology
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SHOW\-TOPOLOGY" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SHOW\-TOPOLOGY" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme show\-topology\fR
+\fInvme show\-topology\fR [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Show the topology of all NVMe subsystems\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR
\fInamespace\fR
ordered\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
nvme show\-topology
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme show-topology</em></pre>\r
+<pre class="content"><em>nvme show-topology</em> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
always <em>namespace</em> ordered.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-smart-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SMART\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SMART\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.nf
\fInvme smart\-log\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-raw\-binary | \-b]
- [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Print the raw SMART log buffer to stdout\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
-\fIjson\fR, or
+\fIjson\fR
+or
\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<div class="verseblock">\r
<pre class="content"><em>nvme smart-log</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
[--raw-binary | -b]\r
- [--output-format=<fmt> | -o <fmt>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-subsystem-reset
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SUBSYSTEM\-RES" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SUBSYSTEM\-RES" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme subsystem\-reset\fR <device>
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Requests NVMe subsystem reset\&. The <device> param is mandatory and must be an NVMe character device (ex: /dev/nvme0)\&.
.SH "OPTIONS"
-.sp
-None
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme subsystem-reset</em> <device></pre>\r
+<pre class="content"><em>nvme subsystem-reset</em> <device>\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_options">OPTIONS</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>None</p></div>\r
+<div class="dlist"><dl>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
+</dl></div>\r
</div>\r
</div>\r
<div class="sect1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-supported-log-pages
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-SUPPORTED\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-SUPPORTED\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme supported\-log\-pages\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
- [\-\-verbose | \-v]
+\fInvme supported\-log\-pages\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the returned supported log pages log structure will be printed for each command that is supported\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
-This option will set the reporting format to normal, json, or binary\&. Only one output format can be used at a time\&.
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
-Show more information including LID Supported (LSUPP) and Index Offset Supported (IOP) details\&.
+Increase the information detail in the output\&. Show more information including LID Supported (LSUPP) and Index Offset Supported (IOP) details\&.
.RE
.SH "EXAMPLES"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme supported-log-pages</em> <device> [--output-format=<fmt> | -o <fmt>]\r
- [--verbose | -v]</pre>\r
+<pre class="content"><em>nvme supported-log-pages</em> <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- This option will set the reporting format to normal, json, or binary.\r
- Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Show more information including LID Supported (LSUPP) and Index Offset Supported (IOP) details.\r
+ Increase the information detail in the output. Show more information\r
+ including LID Supported (LSUPP) and Index Offset Supported (IOP) details.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-telemetry-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-TELEMETRY\-LOG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-TELEMETRY\-LOG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme telemetry\-log\fR <device> [\-\-output\-file=<file> | \-o <file>]
- [\-\-host\-generate=<gen> | \-g <gen>]
+\fInvme telemetry\-log\fR <device> [\-\-output\-file=<file> | \-O <file>]
+ [\-\-host\-generate=<gen> | \-g <gen>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
On success, the returned log structure will be in raw binary format \fIonly\fR with \-\-output\-file option which is mandatory\&.
.SH "OPTIONS"
.PP
-\-o <file>, \-\-output\-file=<file>
+\-O <file>, \-\-output\-file=<file>
.RS 4
File name to which raw binary data will be saved to\&.
.RE
.RS 4
Retrieves the specific data area requested\&. Valid inputs are 1,2,3,4\&. If this option is not specified, the default value is 3, since data area 4 may not be supported\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
.RS 4
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme telemetry-log</em> <device> [--output-file=<file> | -o <file>]\r
- [--host-generate=<gen> | -g <gen>]</pre>\r
+<pre class="content"><em>nvme telemetry-log</em> <device> [--output-file=<file> | -O <file>]\r
+ [--host-generate=<gen> | -g <gen>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <file>\r
+-O <file>\r
</dt>\r
<dt class="hdlist1">\r
--output-file=<file>\r
4 may not be supported.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-toshiba-clear-pcie-correctable-errors
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-TOSHIBA\-CLEAR" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-TOSHIBA\-CLEAR" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-toshiba-vs-internal-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-TOSHIBA\-VS\-I" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-TOSHIBA\-VS\-I" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-toshiba-vs-smart-add-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-TOSHIBA\-VS\-S" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-TOSHIBA\-VS\-S" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe\r
character device (ex: /dev/nvme0), or a namespace block device (ex:\r
/dev/nvme0n1).</p></div>\r
-<div class="paragraph"><p>The log contents may be associated with the controller, in which case the namespace parameter is ignored.</p></div>\r
+<div class="paragraph"><p>The log contents may be associated with the controller, in which case the\r
+namespace parameter is ignored.</p></div>\r
<div class="paragraph"><p>Two logs exist, page 0xC0 (log page directory) and page 0xCA (vendor log page)</p></div>\r
<div class="paragraph"><p>This will only work on Toshiba devices supporting this feature.</p></div>\r
</div>\r
</dt>\r
<dd>\r
<p>\r
- Log page: 0xC0 or 0xCA (defaults to 0xCA)\r
+ Log page: 0xC0 or 0xCA (defaults to 0xCA)\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-transcend-badblock
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-TRANSCEND\-BAD" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-TRANSCEND\-BAD" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-transcend-healthvalue
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-TRANSCEND\-HEA" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-TRANSCEND\-HEA" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>Retrieves the NVMe Device SMART log page from the Transcend device and evaluate health status of Transcend device.</p></div>\r
+<div class="paragraph"><p>Retrieves the NVMe Device SMART log page from the Transcend device and evaluate\r
+health status of Transcend device.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character\r
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></div>\r
<div class="paragraph"><p>On success, the returned value would print health percentage value.</p></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-verify
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-VERIFY" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-VERIFY" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme\-verify\fR <device> [\-\-namespace\-id=<nsid> | \-n <nsid>]
- [\-\-start\-block=<slba> | \-s <slba>]
- [\-\-block\-count=<nlb> | \-c <nlb>]
- [\-\-limited\-retry | \-l]
- [\-\-force\-unit\-access | \-f]
- [\-\-prinfo=<prinfo> | \-p <prinfo>]
- [\-\-ref\-tag=<reftag> | \-r <reftag>]
- [\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
- [\-\-app\-tag=<apptag> | \-a <apptag>]
- [\-\-storage\-tag<storage\-tag> | \-S <storage\-tag>]
- [\-\-storage\-tag\-check | \-C]
+ [\-\-start\-block=<slba> | \-s <slba>]
+ [\-\-block\-count=<nlb> | \-c <nlb>] [\-\-limited\-retry | \-l]
+ [\-\-force\-unit\-access | \-f]
+ [\-\-prinfo=<prinfo> | \-p <prinfo>]
+ [\-\-ref\-tag=<reftag> | \-r <reftag>]
+ [\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
+ [\-\-app\-tag=<apptag> | \-a <apptag>]
+ [\-\-storage\-tag<storage\-tag> | \-S <storage\-tag>]
+ [\-\-storage\-tag\-check | \-C]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The Verify command verifies the integrity of the stored information by reading data and metadata\&.
.SH "OPTIONS"
.PP
-\-\-namespace\-id=<nsid>, \-n <nsid>
+\-n <nsid>, \-\-namespace\-id=<nsid>
.RS 4
Namespace ID use in the command\&.
.RE
.PP
-\-\-start\-block=<slba>, \-s <slba>
+\-s <slba>, \-\-start\-block=<slba>
.RS 4
Start block address\&.
.RE
.PP
-\-\-block\-count=<nlb>, \-c <nlb>
+\-c <nlb>, \-\-block\-count=<nlb>
.RS 4
Number of logical blocks to Verify\&.
.RE
.PP
-\-\-limited\-retry, \-l
+\-l, \-\-limited\-retry
.RS 4
Sets the limited retry flag\&.
.RE
.PP
-\-\-force\-unit\-access, \-f
+\-f, \-\-force\-unit\-access
.RS 4
Set the force\-unit access flag\&.
.RE
.PP
-\-
\-prinfo=<prinfo>, \-p <prinfo>
+\-
p <prinfo>, \-\-prinfo=<prinfo>
.RS 4
Protection Information field definition\&.
.TS
.sp 1
.RE
.PP
-\-\-ref\-tag=<reftag>, \-r <reftag>
+\-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4
Optional reftag when used with protection information\&.
.RE
.PP
-\-
\-app\-tag\-mask=<appmask>, \-m <appmask>
+\-
m <appmask>, \-\-app\-tag\-mask=<appmask>
.RS 4
Optional application tag mask when used with protection information\&.
.RE
.PP
-\-
\-app\-tag=<apptag>, \-a <apptag>
+\-
a <apptag>, \-\-app\-tag=<apptag>
.RS 4
Optional application tag when used with protection information\&.
.RE
.RS 4
This flag enables Storage Tag field checking as part of Verify operation\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme-verify</em> <device> [--namespace-id=<nsid> | -n <nsid>]\r
- [--start-block=<slba> | -s <slba>]\r
- [--block-count=<nlb> | -c <nlb>]\r
- [--limited-retry | -l]\r
- [--force-unit-access | -f]\r
- [--prinfo=<prinfo> | -p <prinfo>]\r
- [--ref-tag=<reftag> | -r <reftag>]\r
- [--app-tag-mask=<appmask> | -m <appmask>]\r
- [--app-tag=<apptag> | -a <apptag>]\r
- [--storage-tag<storage-tag> | -S <storage-tag>]\r
- [--storage-tag-check | -C]</pre>\r
+ [--start-block=<slba> | -s <slba>]\r
+ [--block-count=<nlb> | -c <nlb>] [--limited-retry | -l]\r
+ [--force-unit-access | -f]\r
+ [--prinfo=<prinfo> | -p <prinfo>]\r
+ [--ref-tag=<reftag> | -r <reftag>]\r
+ [--app-tag-mask=<appmask> | -m <appmask>]\r
+ [--app-tag=<apptag> | -a <apptag>]\r
+ [--storage-tag<storage-tag> | -S <storage-tag>]\r
+ [--storage-tag-check | -C]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
---namespace-id=<nsid>\r
+-n <nsid>\r
</dt>\r
<dt class="hdlist1">\r
--n <nsid>\r
+--namespace-id=<nsid>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---start-block=<slba>\r
+-s <slba>\r
</dt>\r
<dt class="hdlist1">\r
--s <slba>\r
+--start-block=<slba>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---block-count=<nlb>\r
+-c <nlb>\r
</dt>\r
<dt class="hdlist1">\r
--c <nlb>\r
+--block-count=<nlb>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---limited-retry\r
+-l\r
</dt>\r
<dt class="hdlist1">\r
--l\r
+--limited-retry\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---force-unit-access\r
+-f\r
</dt>\r
<dt class="hdlist1">\r
--f\r
+--force-unit-access\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---prinfo=<prinfo>\r
+-p <prinfo>\r
</dt>\r
<dt class="hdlist1">\r
--p <prinfo>\r
+--prinfo=<prinfo>\r
</dt>\r
<dd>\r
<p>\r
</div>\r
</dd>\r
<dt class="hdlist1">\r
---ref-tag=<reftag>\r
+-r <reftag>\r
</dt>\r
<dt class="hdlist1">\r
--r <reftag>\r
+--ref-tag=<reftag>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag-mask=<appmask>\r
+-m <appmask>\r
</dt>\r
<dt class="hdlist1">\r
--m <appmask>\r
+--app-tag-mask=<appmask>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag=<apptag>\r
+-a <apptag>\r
</dt>\r
<dt class="hdlist1">\r
--a <apptag>\r
+--app-tag=<apptag>\r
</dt>\r
<dd>\r
<p>\r
This flag enables Storage Tag field checking as part of Verify operation.\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-virtium-save-smart-to-vtview-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-VIRTIUM\-SAVE\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-VIRTIUM\-SAVE\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.fi
.SH "DESCRIPTION"
.sp
-This command automates the process of collecting SMART data periodically and saving the data in a ready\-to\-analyze format\&. Each entry is saved with timestamp and in csv format\&. Users can use excel to analyze the data\&. Some examples of use cases are collecting SMART data for temperature characterization, collecting data to calculate endurance, or collecting SMART data during a test or during normal operation\&.
+This command automates the process of collecting SMART data periodically and saving the data in a ready\-to\-analyze format\&. Each entry is saved with timestamp and in csv format\&. Users can use excel to analyze the data\&. Some examples of use cases are collecting SMART data for temperature characterization, data to calculate endurance, or collecting SMART data during a test or during normal operation\&.
.sp
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
.sp
.PP
\-f <NUM>, \-\-freq=<NUM>
.RS 4
-(optional) How often you want to log SMART data (0\&.25 = 15\*(Aq , 0\&.5 = 30\*(Aq , 1 = 1 hour, 2 = 2 hours, etc\&.)\&. Default = 10 hours\&.
+(optional) How often you want to log SMART data (0\&.25 = 15\*(Aq, 0\&.5 = 30\*(Aq, 1 = 1 hour, 2 = 2 hours, etc\&.)\&. Default = 10 hours\&.
.RE
.PP
\-o <FILE>, \-\-output\-file=<FILE>
<div class="paragraph"><p>This command automates the process of collecting SMART data periodically and\r
saving the data in a ready-to-analyze format. Each entry is saved\r
with timestamp and in csv format. Users can use excel to analyze the data.\r
-Some examples of use cases are collecting SMART data for temperature characterization,\r
-collecting data to calculate endurance, or collecting SMART data during a test\r
-or during normal operation.</p></div>\r
+Some examples of use cases are collecting SMART data for temperature\r
+characterization, data to calculate endurance, or collecting SMART data during a\r
+test or during normal operation.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character\r
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).</p></div>\r
-<div class="paragraph"><p>On success, the command generates a log file, which contains an entry for identify device\r
-(current features & settings) and periodic entries of SMART data.</p></div>\r
-<div class="paragraph"><p>This command runs for the time specified by the option <run-time>, and collects SMART data\r
-at the frequency specified by the option <freq>. If the output file name is not specified,\r
-this command will generate a file name that include model string and serial number of the device.</p></div>\r
-<div class="paragraph"><p>If the test-name option is specified, it will be recorded in the log file and be used as part\r
-of the log file name.</p></div>\r
+<div class="paragraph"><p>On success, the command generates a log file, which contains an entry for\r
+identify device (current features & settings) and periodic entries of SMART data.</p></div>\r
+<div class="paragraph"><p>This command runs for the time specified by the option <run-time>, and collects\r
+SMART data at the frequency specified by the option <freq>. If the output file\r
+name is not specified, this command will generate a file name that include model\r
+string and serial number of the device.</p></div>\r
+<div class="paragraph"><p>If the test-name option is specified, it will be recorded in the log file and be\r
+used as part of the log file name.</p></div>\r
</div>\r
</div>\r
<div class="sect1">\r
</dt>\r
<dd>\r
<p>\r
- (optional) How often you want to log SMART data\r
- (0.25 = 15' , 0.5 = 30' , 1 = 1 hour, 2 = 2 hours, etc.). Default = 10 hours.\r
+ (optional) How often you want to log SMART data (0.25 = 15', 0.5 = 30',\r
+ 1 = 1 hour, 2 = 2 hours, etc.). Default = 10 hours.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- (optional) Name of the log file (give it a name that easy for you to remember\r
- what the test is). You can leave it blank too, the file name will be generated\r
- as <model string>-<serial number>-<test name>.txt.\r
+ (optional) Name of the log file (give it a name that easy for you to\r
+ remember what the test is). You can leave it blank too, the file name\r
+ will be generated as <model string>-<serial number>-<test name>.txt.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- (optional) Name of the test you are doing. We use this string as part of the name of the log file.\r
+ (optional) Name of the test you are doing. We use this string as part of\r
+ the name of the log file.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-virtium-show-identify
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-VIRTIUM\-SHOW\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-VIRTIUM\-SHOW\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-cap-diag
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-CAP\-DIAG" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CAP\-DIAG" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
</dt>\r
<dd>\r
<p>\r
- Transfer size; defaults to 0x10000 (65536 decimal) bytes\r
+ Transfer size; defaults to 0x10000 (65536 decimal) bytes\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-capabilities
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-CAPABILIT" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CAPABILIT" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-clear-assert-dump
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-CLEAR\-AS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CLEAR\-AS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-clear-fw-activate-history
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-CLEAR\-FW" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CLEAR\-FW" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-clear-pcie-correctable-errors
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-CLEAR\-PC" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CLEAR\-PC" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-cloud-SSD-plugin-version
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-CLOUD\-SS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CLOUD\-SS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-cloud-boot-SSD-version
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-CLOUD\-BO" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-CLOUD\-BO" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-drive-essentials
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-DRIVE\-ES" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-DRIVE\-ES" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>For the NVMe device given, captures the drive essential bin files and saves them into a tar file.\r
-The tar file will be in the following format: DRIVE_ESSENTIALS_<Serial Num>_<FW Revision>_<Date>_<Time>.tar.gz\r
- e.g. DRIVE_ESSENTIALS_A00FD8CA_1048_20170713_091731.tar.gz</p></div>\r
+<div class="paragraph"><p>For the NVMe device given, captures the drive essential bin files and saves them\r
+into a tar file. The tar file will be in the following format:\r
+DRIVE_ESSENTIALS_<Serial Num>_<FW Revision>_<Date>_<Time>.tar.gz\r
+ e.g. DRIVE_ESSENTIALS_A00FD8CA_1048_20170713_091731.tar.gz</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory; NVMe character device (ex: /dev/nvme0).</p></div>\r
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.\r
Results for any other device are undefined.</p></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-drive-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-DRIVE\-LO" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-DRIVE\-LO" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-drive-resize
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-DRIVE\-RE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-DRIVE\-RE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-enc-get-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-ENC\-GET\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-ENC\-GET\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme wdc enc\-get\-log\fR <device> [\-\-log\-id=<NUM>, \-l <NUM>] [\-\-output\-file=<FILE>, \-o <FILE>] [\-\-transfer\-size=<SIZE>, \-s <SIZE>]
+\fInvme wdc enc\-get\-log\fR <device> [\-\-log\-id=<NUM>, \-l <NUM>]
+ [\-\-output\-file=<FILE>, \-o <FILE>]
+ [\-\-transfer\-size=<SIZE>, \-s <SIZE>]
.fi
.SH "DESCRIPTION"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme wdc enc-get-log</em> <device> [--log-id=<NUM>, -l <NUM>] [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]</pre>\r
+<pre class="content"><em>nvme wdc enc-get-log</em> <device> [--log-id=<NUM>, -l <NUM>]\r
+ [--output-file=<FILE>, -o <FILE>]\r
+ [--transfer-size=<SIZE>, -s <SIZE>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
output the Enclosure logs.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory and may be either the NVMe character\r
device (ex: /dev/nvme0).</p></div>\r
-<div class="paragraph"><p>The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2, 0xd3, 0xd4, 0xe2 and 0xe4.</p></div>\r
+<div class="paragraph"><p>The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2,\r
+0xd3, 0xd4, 0xe2 and 0xe4.</p></div>\r
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.\r
Results for any other device are undefined.</p></div>\r
<div class="paragraph"><p>On success it returns the enclosure log data, error code otherwise.</p></div>\r
</dt>\r
<dd>\r
<p>\r
- Output file pathname\r
+ Output file pathname\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192)\r
+ Data retrieval transfer size, maximum transfer size should be 0x2000\r
+ (decimal 8192)\r
</p>\r
</dd>\r
</dl></div>\r
<div class="ulist"><ul>\r
<li>\r
<p>\r
-Gets the enclosure log from the device based on the log id(0xd1) with transfer size(0x2000) and saves to defined file in current directory:\r
+Gets the enclosure log from the device based on the log id(0xd1) with transfer\r
+ size(0x2000) and saves to defined file in current directory:\r
</p>\r
<div class="listingblock">\r
<div class="content">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-get-crash-dump
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-GET\-CRAS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-CRAS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-get-dev-capabilities-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-GET\-DEV\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-DEV\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme wdc get\-dev\-capabilities\-log\fR <device> [\-\-output\-format=<normal|json>
-\-o <normal|json>]
+\fInvme wdc get\-dev\-capabilities\-log\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
On success it returns the parsed device capabilities log page data, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR, or
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>nvme-wdc-get-dev-capabilities-log -\r
- Send NVMe WDC get-dev-capabilities-log plugin command, return parsed log output\r
+ Send NVMe WDC get-dev-capabilities-log plugin command, return parsed log output\r
</p>\r
</div>\r
</div>\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme wdc get-dev-capabilities-log</em> <device> [--output-format=<normal|json>\r
--o <normal|json>]</pre>\r
+<pre class="content"><em>nvme wdc get-dev-capabilities-log</em> <device> [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-get-drive-status
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-GET\-DRIV" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-DRIV" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
</tr>\r
<tr>\r
<td align="left" valign="top"><p class="table"><strong>EOL (End of Life) Status</strong></p></td>\r
-<td align="left" valign="top"><p class="table">The 3 possible states are : Normal, Read Only, or End of Life.</p></td>\r
+<td align="left" valign="top"><p class="table">The 3 possible states are : Normal, Read Only, or End of Life.</p></td>\r
</tr>\r
<tr>\r
<td align="left" valign="top"><p class="table"><strong>Assert Dump Status</strong></p></td>\r
-<td align="left" valign="top"><p class="table">The 2 possible states are : Present or Not Present.</p></td>\r
+<td align="left" valign="top"><p class="table">The 2 possible states are : Present or Not Present.</p></td>\r
</tr>\r
<tr>\r
<td align="left" valign="top"><p class="table"><strong>Thermal Throttling Status</strong></p></td>\r
-<td align="left" valign="top"><p class="table">The 3 possible states are : Off, On, or Unavailable.</p></td>\r
+<td align="left" valign="top"><p class="table">The 3 possible states are : Off, On, or Unavailable.</p></td>\r
</tr>\r
<tr>\r
<td align="left" valign="top"><p class="table"><strong>Format Corrupt Reason</strong></p></td>\r
-<td align="left" valign="top"><p class="table">The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.</p></td>\r
+<td align="left" valign="top"><p class="table">The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.</p></td>\r
</tr>\r
</tbody>\r
</table>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-get-error-recovery-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-GET\-ERRO" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-ERRO" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns the parsed error recovery log page data, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR, or
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>nvme-wdc-get-error-recovery-log -\r
- Send NVMe WDC get-error-recovery-log plugin command, return parsed log output\r
+ Send NVMe WDC get-error-recovery-log plugin command, return parsed log output\r
</p>\r
</div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-get-latency-monitor-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-GET\-LATE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-LATE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-get-pfail-dump
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-GET\-PFAI" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-PFAI" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-get-unsupported-reqs-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-GET\-UNSU" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-GET\-UNSU" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns the parsed unsupported requirements log page data, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR, or
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-id-ctrl
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-ID\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-ID\-CTRL" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme wdc id\-ctrl\fR <device> [\-v | \-\-vendor\-specific] [\-b | \-\-raw\-binary]
- [\-H | \-\-human\-readable]
- [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme wdc id\-ctrl\fR <device> [\-\-vendor\-specific | \-v] [\-\-raw\-binary | \-b]
+ [\-\-human\-readable | \-H]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
This option will parse and format many of the bit fields into human\-readable formats\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme wdc id-ctrl</em> <device> [-v | --vendor-specific] [-b | --raw-binary]\r
- [-H | --human-readable]\r
- [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme wdc id-ctrl</em> <device> [--vendor-specific | -v] [--raw-binary | -b]\r
+ [--human-readable | -H]\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or\r
+ <em>binary</em>. Only one output format can be used at a time.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-log-page-directory
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-LOG\-PAGE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-LOG\-PAGE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns the log page directory information, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>For the NVMe device given, retrieves the log page directory which contains the list of\r
-log page IDs supported by the drive. The --output-format option will format the output as\r
+log page IDs supported by the drive. The --output-format option will format the output as\r
specified.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).</p></div>\r
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-namespace-resize
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-NAMESPACE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-NAMESPACE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme wdc namespace\-resize\fR <device> [\-\-nsid=<NAMSPACE ID>, \-n <NAMSPACE ID>] [\-\-op_option=<OP OPTION>, \-o <OP OPTION>]
+\fInvme wdc namespace\-resize\fR <device> [\-\-nsid=<NAMESPACE ID>, \-n <NAMSPACE ID>]
+ [\-\-op_option=<OP OPTION>, \-o <OP OPTION>]
.fi
.SH "DESCRIPTION"
.sp
-For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported by the device\&.
+For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported the device\&.
.sp
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0)\&.
.sp
This will only work on WDC devices supporting this feature\&. Results for any other device are undefined\&.
.SH "OPTIONS"
.PP
-\-n <NAMSPACE ID>, \-\-namespace\-id=<NAMSPACE_ID>
+\-n <NAMESPACE ID>, \-\-namespace\-id=<NAMESPACE_ID>
.RS 4
Namespace ID; ID of the namespace to resize
.RE
.PP
\-o <OP OPTION>, \-\-op\-option=<OP OPTION>
.RS 4
-Overprovisioning Option; defaults to 0xF
-.sp
-.if n \{\
-.RS 4
-.\}
-.nf
-Valid Values:
-0x1 \- 7% of Original TNVMCAP reported value
-0x2 \- 28% of Original TNVMCAP reported value
-0x3 \- 50% of Original TNVMCAP reported value
-0xF \- 0% of Original TNVMCAP reported value (original config)
-All other values \- reserved
-.fi
-.if n \{\
-.RE
-.\}
+Overprovisioning Option; defaults to 0xF Valid Values: 0x1 \- 7% of Original TNVMCAP reported value 0x2 \- 28% of Original TNVMCAP reported value 0x3 \- 50% of Original TNVMCAP reported value 0xF \- 0% of Original TNVMCAP reported value (original config) All other values \- reserved
.RE
.SH "EXAMPLES"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme wdc namespace-resize</em> <device> [--nsid=<NAMSPACE ID>, -n <NAMSPACE ID>] [--op_option=<OP OPTION>, -o <OP OPTION>]</pre>\r
+<pre class="content"><em>nvme wdc namespace-resize</em> <device> [--nsid=<NAMESPACE ID>, -n <NAMSPACE ID>]\r
+ [--op_option=<OP OPTION>, -o <OP OPTION>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific Command that modifies the namespace size reported\r
-by the device.</p></div>\r
+<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific Command that modifies\r
+the namespace size reported the device.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).</p></div>\r
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.\r
Results for any other device are undefined.</p></div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--n <NAMSPACE ID>\r
+-n <NAMESPACE ID>\r
</dt>\r
<dt class="hdlist1">\r
---namespace-id=<NAMSPACE_ID>\r
+--namespace-id=<NAMESPACE_ID>\r
</dt>\r
<dd>\r
<p>\r
</dt>\r
<dd>\r
<p>\r
- Overprovisioning Option; defaults to 0xF\r
+ Overprovisioning Option; defaults to 0xF\r
+ Valid Values:\r
+ 0x1 - 7% of Original TNVMCAP reported value\r
+ 0x2 - 28% of Original TNVMCAP reported value\r
+ 0x3 - 50% of Original TNVMCAP reported value\r
+ 0xF - 0% of Original TNVMCAP reported value (original config)\r
+ All other values - reserved\r
</p>\r
-<div class="literalblock">\r
-<div class="content">\r
-<pre><code>Valid Values:\r
-0x1 - 7% of Original TNVMCAP reported value\r
-0x2 - 28% of Original TNVMCAP reported value\r
-0x3 - 50% of Original TNVMCAP reported value\r
-0xF - 0% of Original TNVMCAP reported value (original config)\r
-All other values - reserved</code></pre>\r
-</div></div>\r
</dd>\r
</dl></div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-purge-monitor
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-PURGE\-MO" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-PURGE\-MO" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-purge
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-PURGE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-PURGE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-cloud-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-CLOUD" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-CLOUD" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR, or
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-device-waf
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-DEVIC" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-DEVIC" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR, or
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-drive-info
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-DRIVE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-DRIVE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-error-reason-identifier
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-ERROR" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-ERROR" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
<div class="paragraph"><p>For the NVMe device given, retrieve the telemetry log error reason id field for either the host generated or\r
-controller initiated log. The controller initiated telemetry log page option must be enabled to retrieve the\r
+controller initiated log. The controller initiated telemetry log page option must be enabled to retrieve the\r
error reason id for that log page id.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).</p></div>\r
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-fw-activate-history
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-FW\-A" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-FW\-A" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR, or
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<tbody>\r
<tr>\r
<td align="left" valign="top"><p class="table"><strong>Entry Number</strong></p></td>\r
-<td align="left" valign="top"><p class="table">The number of fw activate entry. The most recent 20 entries will be displayed.</p></td>\r
+<td align="left" valign="top"><p class="table">The number of fw activate entry. The most recent 20 entries will be displayed.</p></td>\r
</tr>\r
<tr>\r
<td align="left" valign="top"><p class="table"><strong>Power on Hour</strong></p></td>\r
</tr>\r
<tr>\r
<td align="left" valign="top"><p class="table"><strong>Result</strong></p></td>\r
-<td align="left" valign="top"><p class="table">The result of the firmware activation event. The output shall be in the format:\r
+<td align="left" valign="top"><p class="table">The result of the firmware activation event. The output shall be in the format:\r
Pass or Failed + error code</p></td>\r
</tr>\r
</tbody>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-hw-rev-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-HW\-R" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-HW\-R" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns 0, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR, or
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-internal-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-INTER" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-INTER" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme wdc vs\-internal\-log\fR <device> [\-\-output\-file=<FILE>, \-o <FILE>] [\-\-transfer\-size=<SIZE>, \-s <SIZE>]
- [\-\-data\-area=<DATA AREA>, \-d <DATA_AREA>] [\-\-file\-size=<FILE SIZE>, \-f <FILE SIZE>] [\-\-offset=<OFFSET>, \-e <OFFSET>]
- [\-\-type=<TYPE>, \-t <type>] [\-\-verbose, \-v]
+\fInvme wdc vs\-internal\-log\fR <device> [\-\-output\-file=<FILE>, \-o <FILE>]
+ [\-\-transfer\-size=<SIZE>, \-s <SIZE>]
+ [\-\-data\-area=<DATA AREA>, \-d <DATA_AREA>]
+ [\-\-file\-size=<FILE SIZE>, \-f <FILE SIZE>]
+ [\-\-offset=<OFFSET>, \-e <OFFSET>]
+ [\-\-type=<TYPE>, \-t <type>] [\-\-verbose, \-v]
.fi
.SH "DESCRIPTION"
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme wdc vs-internal-log</em> <device> [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]\r
- [--data-area=<DATA AREA>, -d <DATA_AREA>] [--file-size=<FILE SIZE>, -f <FILE SIZE>] [--offset=<OFFSET>, -e <OFFSET>]\r
- [--type=<TYPE>, -t <type>] [--verbose, -v]</pre>\r
+<pre class="content"><em>nvme wdc vs-internal-log</em> <device> [--output-file=<FILE>, -o <FILE>]\r
+ [--transfer-size=<SIZE>, -s <SIZE>]\r
+ [--data-area=<DATA AREA>, -d <DATA_AREA>]\r
+ [--file-size=<FILE SIZE>, -f <FILE SIZE>]\r
+ [--offset=<OFFSET>, -e <OFFSET>]\r
+ [--type=<TYPE>, -t <type>] [--verbose, -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific Internal Log request and saves\r
-the result to a file.</p></div>\r
+<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific Internal Log request\r
+and saves the result to a file.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).</p></div>\r
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.\r
Results for any other device are undefined.</p></div>\r
</dt>\r
<dd>\r
<p>\r
- Output file; defaults to device serial number followed by "<em>internal_fw_log</em><date>_<time>.bin" suffix\r
+ Output file; defaults to device serial number followed by\r
+ "<em>internal_fw_log</em><date>_<time>.bin" suffix\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Transfer size; defaults to 0x10000 (65536 decimal) bytes\r
+ Transfer size; defaults to 0x10000 (65536 decimal) bytes\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will be retrieved. This parameter\r
- is currently only supported on the SN340, SN640, SN730, and SN840 devices.\r
+ DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will\r
+ be retrieved. This parameter is currently only supported on the SN340,\r
+ SN640, SN730, and SN840 devices.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Specifies the desired size of the data file starting at the passed in offset. This allows the user to\r
- retrieve the data in several smaller files of the passed in size. This parameter is currently only\r
- supported on the SN340 device.\r
+ Specifies the desired size of the data file starting at the passed in\r
+ offset. This allows the user to retrieve the data in several smaller\r
+ files of the passed in size. This parameter is currently only supported\r
+ on the SN340 device.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Specifies the data offset at which to start retrieving the data. This parameter is used in combination\r
- with the file size parameter to retrieve the data in several smaller files. This parameter is currently\r
- only supported on the SN340 device.\r
+ Specifies the data offset at which to start retrieving the data. This\r
+ parameter is used in combination with the file size parameter to\r
+ retrieve the data in several smaller files. This parameter is currently\r
+ only supported on the SN340 device.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Specifies the telemetry type - NONE, HOST, or CONTROLLER. This parameter is used to get either the host\r
- generated or controller initiated telemetry log page. If not specified or none is specified, the command\r
- will return the default E6 log data. This parameter is currently only supported on the SN640 and SN840\r
- devices.\r
+ Specifies the telemetry type - NONE, HOST, or CONTROLLER. This parameter\r
+ is used to get either the host generated or controller initiated\r
+ telemetry log page. If not specified or none is specified, the command\r
+ will return the default E6 log data. This parameter is currently only\r
+ supported on the SN640 and SN840 devices.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-nand-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-NAND\" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-NAND\" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
On success it returns the NAND statistics, error code otherwise\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR, or
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-smart-add-log
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-SMART" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-SMART" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
Return the statistics from specific interval, defaults to 14\&. This parameter is only valid for the 0xC1 log page and ignored for all other log pages\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR, or
</dt>\r
<dd>\r
<p>\r
- Return the statistics from specific interval, defaults to 14. This parameter is only valid for the 0xC1 log page\r
- and ignored for all other log pages.\r
+ Return the statistics from specific interval, defaults to 14. This\r
+ parameter is only valid for the 0xC1 log page and ignored for all other\r
+ log pages.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
</dt>\r
<dd>\r
<p>\r
- Log Page Version: 0 = vendor, 1 = WDC. This parameter is only valid for the 0xC0 log page and ignored for all\r
- other log pages.\r
+ Log Page Version: 0 = vendor, 1 = WDC. This parameter is only valid for\r
+ the 0xC0 log page and ignored for all other log pages.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
</dt>\r
<dd>\r
<p>\r
- Supply a comma separated list of desired log pages to display.\r
- The possible values are 0xc0, 0xc1, 0xca, 0xd0.\r
- Note: Not all pages are supported on all drives.\r
- The default is to display all supported log pages.\r
+ Supply a comma separated list of desired log pages to display.\r
+ The possible values are 0xc0, 0xc1, 0xca, 0xd0.\r
+ Note: Not all pages are supported on all drives.\r
+ The default is to display all supported log pages.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-telemetry-controller-option
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-TELEM" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-TELEM" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme wdc vs\-telemetry\-controller\-option\fR <device> [\-\-disable, \-d] [\-\-enable, \-e]
- [\-\-status, \-s]
+\fInvme wdc vs\-telemetry\-controller\-option\fR <device>
+ [\-\-disable, \-d] [\-\-enable, \-e] [\-\-status, \-s]
.fi
.SH "DESCRIPTION"
.sp
-For the NVMe device given, sends the WDC Vendor Specific set feature command to disable, enable or get current status of the controller initiated option of the telemetry log page\&.
+For the NVMe device given, sends the WDC Vendor Specific set feature command to disable, enable or get current status the controller initiated option of the telemetry log page\&.
.sp
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0)\&.
.sp
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme wdc vs-telemetry-controller-option</em> <device> [--disable, -d] [--enable, -e]\r
- [--status, -s]</pre>\r
+<pre class="content"><em>nvme wdc vs-telemetry-controller-option</em> <device>\r
+ [--disable, -d] [--enable, -e] [--status, -s]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sect1">\r
<h2 id="_description">DESCRIPTION</h2>\r
<div class="sectionbody">\r
-<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific set feature command to disable, enable or get current status\r
-of the controller initiated option of the telemetry log page.</p></div>\r
+<div class="paragraph"><p>For the NVMe device given, sends the WDC Vendor Specific set feature command to\r
+disable, enable or get current status the controller initiated option of the\r
+telemetry log page.</p></div>\r
<div class="paragraph"><p>The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).</p></div>\r
<div class="paragraph"><p>This will only work on WDC devices supporting this feature.\r
Results for any other device are undefined.</p></div>\r
</dt>\r
<dd>\r
<p>\r
- Returns the current status (enabled or disabled) of the controller initiated option of the telemetry log page.\r
+ Returns the current status (enabled or disabled) of the controller\r
+ initiated option of the telemetry log page.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-wdc-vs-temperature-stats
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WDC\-VS\-TEMPE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WDC\-VS\-TEMPE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-uncor
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-UNCOR" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-UNCOR" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-dir\-type=<dtype> | \-T <dtype>]
[\-\-dir\-spec=<dspec> | \-S <dspec>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The Write Uncorrectable command is used to invalidate a range of logical blocks\&.
.SH "OPTIONS"
.PP
-\-\-start\-block=<slba>, \-s <slba>
+\-s <slba>, \-\-start\-block=<slba>
.RS 4
Start block\&.
.RE
.PP
-\-\-block\-count=<nlb>, \-c
+\-c, \-\-block\-count=<nlb>
.RS 4
Number of logical blocks to write uncorrectable\&.
.RE
.PP
-\-\-namespace\-id=<nsid>, \-n <nsid>
+\-n <nsid>, \-\-namespace\-id=<nsid>
.RS 4
Namespace ID use in the command\&.
.RE
.RS 4
Directive specific
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
[--block-count=<nlb> | -c <nlb>]\r
[--namespace-id=<nsid> | -n <nsid>]\r
[--dir-type=<dtype> | -T <dtype>]\r
- [--dir-spec=<dspec> | -S <dspec>]</pre>\r
+ [--dir-spec=<dspec> | -S <dspec>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
---start-block=<slba>\r
+-s <slba>\r
</dt>\r
<dt class="hdlist1">\r
--s <slba>\r
+--start-block=<slba>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---block-count=<nlb>\r
+-c\r
</dt>\r
<dt class="hdlist1">\r
--c\r
+--block-count=<nlb>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---namespace-id=<nsid>\r
+-n <nsid>\r
</dt>\r
<dt class="hdlist1">\r
--n <nsid>\r
+--namespace-id=<nsid>\r
</dt>\r
<dd>\r
<p>\r
Directive specific\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-write-zeroes
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WRITE\-ZEROES" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WRITE\-ZEROES" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-ref\-tag=<reftag> | \-r <reftag>]
[\-\-prinfo=<prinfo> | \-p <prinfo>]
[\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
- [\-\-app\-tag=<apptag> | \-a <apptag>]
- [\-\-deac | \-d]
- [\-\-limited\-retry | \-l]
- [\-\-force\-unit\-access | \-f]
+ [\-\-app\-tag=<apptag> | \-a <apptag>] [\-\-deac | \-d]
+ [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f]
[\-\-namespace\-id=<nsid> | \-n <nsid>]
[\-\-storage\-tag<storage\-tag> | \-S <storage\-tag>]
[\-\-storage\-tag\-check<storage\-tag\-check> | \-C <storage\-tag\-check>]
[\-\-dir\-type=<dtype> | \-T <dtype>]
[\-\-dir\-spec=<dspec> | \-D <dspec>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The Write Zeroes command is used to set a range of logical blocks to 0\&.
.SH "OPTIONS"
.PP
-\-\-start\-block=<slba>, \-s <slba>
+\-s <slba>, \-\-start\-block=<slba>
.RS 4
Start block\&.
.RE
.PP
-\-\-block\-count=<nlb>, \-c <nlb>
+\-c <nlb>, \-\-block\-count=<nlb>
.RS 4
Number of logical blocks to write zeroes\&.
.RE
.PP
-\-
\-prinfo=<prinfo>, \-p <prinfo>
+\-
p <prinfo>, \-\-prinfo=<prinfo>
.RS 4
Protection Information field definition\&.
.TS
.sp 1
.RE
.PP
-\-\-ref\-tag=<reftag>, \-r <reftag>
+\-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4
Optional reftag when used with protection information\&.
.RE
.PP
-\-
\-app\-tag\-mask=<appmask>, \-m <appmask>
+\-
m <appmask>, \-\-app\-tag\-mask=<appmask>
.RS 4
Optional application tag mask when used with protection information\&.
.RE
.PP
-\-
\-app\-tag=<apptag>, \-a <apptag>
+\-
a <apptag>, \-\-app\-tag=<apptag>
.RS 4
Optional application tag when used with protection information\&.
.RE
.PP
-\-\-limited\-retry, \-l
+\-l, \-\-limited\-retry
.RS 4
Sets the limited retry flag\&.
.RE
.PP
-\-\-deac, \-d
+\-d, \-\-deac
.RS 4
Sets the DEAC bit, requesting controller deallocate the logical blocks\&.
.RE
.PP
-\-\-force\-unit\-access, \-f
+\-f, \-\-force\-unit\-access
.RS 4
Set the force\-unit access flag\&.
.RE
.PP
-\-\-namespace\-id=<nsid>, \-n <nsid>
+\-n <nsid>, \-\-namespace\-id=<nsid>
.RS 4
Namespace ID use in the command\&.
.RE
.PP
-\-\-storage\-tag=<storage\-tag>, \-S <storage\-tag>
+\-S <storage\-tag>, \-\-storage\-tag=<storage\-tag>
.RS 4
Variable Sized Logical Block Storage Tag(LBST)\&.
.RE
.PP
-\-\-storage\-tag\-check=<storage\-tag\-check>, \-C <storage\-tag\-check>
+\-C <storage\-tag\-check>, \-\-storage\-tag\-check=<storage\-tag\-check>
.RS 4
This bit specifies the Storage Tag field shall be checked as part of end\-to\-end data protection processing\&.
.RE
.RS 4
Directive specific
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
[--ref-tag=<reftag> | -r <reftag>]\r
[--prinfo=<prinfo> | -p <prinfo>]\r
[--app-tag-mask=<appmask> | -m <appmask>]\r
- [--app-tag=<apptag> | -a <apptag>]\r
- [--deac | -d]\r
- [--limited-retry | -l]\r
- [--force-unit-access | -f]\r
+ [--app-tag=<apptag> | -a <apptag>] [--deac | -d]\r
+ [--limited-retry | -l] [--force-unit-access | -f]\r
[--namespace-id=<nsid> | -n <nsid>]\r
[--storage-tag<storage-tag> | -S <storage-tag>]\r
[--storage-tag-check<storage-tag-check> | -C <storage-tag-check>]\r
[--dir-type=<dtype> | -T <dtype>]\r
- [--dir-spec=<dspec> | -D <dspec>]</pre>\r
+ [--dir-spec=<dspec> | -D <dspec>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
---start-block=<slba>\r
+-s <slba>\r
</dt>\r
<dt class="hdlist1">\r
--s <slba>\r
+--start-block=<slba>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---block-count=<nlb>\r
+-c <nlb>\r
</dt>\r
<dt class="hdlist1">\r
--c <nlb>\r
+--block-count=<nlb>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---prinfo=<prinfo>\r
+-p <prinfo>\r
</dt>\r
<dt class="hdlist1">\r
--p <prinfo>\r
+--prinfo=<prinfo>\r
</dt>\r
<dd>\r
<p>\r
</div>\r
</dd>\r
<dt class="hdlist1">\r
---ref-tag=<reftag>\r
+-r <reftag>\r
</dt>\r
<dt class="hdlist1">\r
--r <reftag>\r
+--ref-tag=<reftag>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag-mask=<appmask>\r
+-m <appmask>\r
</dt>\r
<dt class="hdlist1">\r
--m <appmask>\r
+--app-tag-mask=<appmask>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag=<apptag>\r
+-a <apptag>\r
</dt>\r
<dt class="hdlist1">\r
--a <apptag>\r
+--app-tag=<apptag>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---limited-retry\r
+-l\r
</dt>\r
<dt class="hdlist1">\r
--l\r
+--limited-retry\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---deac\r
+-d\r
</dt>\r
<dt class="hdlist1">\r
--d\r
+--deac\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---force-unit-access\r
+-f\r
</dt>\r
<dt class="hdlist1">\r
--f\r
+--force-unit-access\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---namespace-id=<nsid>\r
+-n <nsid>\r
</dt>\r
<dt class="hdlist1">\r
--n <nsid>\r
+--namespace-id=<nsid>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---storage-tag=<storage-tag>\r
+-S <storage-tag>\r
</dt>\r
<dt class="hdlist1">\r
--S <storage-tag>\r
+--storage-tag=<storage-tag>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---storage-tag-check=<storage-tag-check>\r
+-C <storage-tag-check>\r
</dt>\r
<dt class="hdlist1">\r
--C <storage-tag-check>\r
+--storage-tag-check=<storage-tag-check>\r
</dt>\r
<dd>\r
<p>\r
Directive specific\r
</p>\r
</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
+</p>\r
+</dd>\r
</dl></div>\r
</div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-write
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-WRITE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-WRITE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-prinfo=<prinfo> | \-p <prinfo>]
[\-\-app\-tag\-mask=<appmask> | \-m <appmask>]
[\-\-app\-tag=<apptag> | \-a <apptag>]
- [\-\-limited\-retry | \-l]
- [\-\-force\-unit\-access | \-f]
+ [\-\-limited\-retry | \-l] [\-\-force\-unit\-access | \-f]
[\-\-dir\-type=<type> | \-T <type>]
- [\-\-dir\-spec=<spec> | \-S <spec>]
- [\-\-dsm=<dsm> | \-D <dsm>]
- [\-\-show\-command | \-v]
- [\-\-dry\-run | \-w]
- [\-\-latency | \-t]
+ [\-\-dir\-spec=<spec> | \-S <spec>] [\-\-dsm=<dsm> | \-D <dsm>]
+ [\-\-show\-command | \-V] [\-\-dry\-run | \-w] [\-\-latency | \-t]
[\-\-storage\-tag<storage\-tag> | \-g <storage\-tag>]
- [\-\-storage\-tag\-check | \-C]
- [\-\-force]
+ [\-\-storage\-tag\-check | \-C] [\-\-force]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
The Write command writes the logical blocks specified by the command to the medium from the data data buffer provided\&. Will use stdin by default if you don\(cqt provide a file\&.
.SH "OPTIONS"
.PP
-\-\-start\-block=<slba>, \-s <slba>
+\-s <slba>, \-\-start\-block=<slba>
.RS 4
Start block\&.
.RE
.PP
-\-\-block\-count, \-c
+\-c, \-\-block\-count
.RS 4
The number of blocks to transfer\&. This is a zeroes based value to align with the kernel\(cqs use of this field\&. (ie\&. 0 means transfer 1 block)\&.
.RE
.PP
-\-\-data\-size=<size>, \-z <size>
+\-z <size>, \-\-data\-size=<size>
.RS 4
Size of data, in bytes\&.
.RE
.PP
-\-\-metadata\-size=<size>, \-y <size>
+\-y <size>, \-\-metadata\-size=<size>
.RS 4
Size of metadata in bytes\&.
.RE
.PP
-\-\-data=<data\-file>, \-d <data\-file>
+\-d <data\-file>, \-\-data=<data\-file>
.RS 4
Data file\&. If none provided, contents are sent from STDIN\&.
.RE
.PP
-\-\-metadata=<metadata\-file>, \-M <metadata\-file>
+\-M <metadata\-file>, \-\-metadata=<metadata\-file>
.RS 4
Metadata file, if necessary\&.
.RE
.PP
-\-
\-prinfo=<prinfo>, \-p <prinfo>
+\-
p <prinfo>, \-\-prinfo=<prinfo>
.RS 4
Protection Information field definition\&.
.TS
.sp 1
.RE
.PP
-\-\-ref\-tag=<reftag>, \-r <reftag>
+\-r <reftag>, \-\-ref\-tag=<reftag>
.RS 4
Optional reftag when used with protection information\&.
.RE
.PP
-\-
\-app\-tag\-mask=<appmask>, \-m <appmask>
+\-
m <appmask>, \-\-app\-tag\-mask=<appmask>
.RS 4
Optional application tag mask when used with protection information\&.
.RE
.PP
-\-
\-app\-tag=<apptag>, \-a <apptag>
+\-
a <apptag>, \-\-app\-tag=<apptag>
.RS 4
Optional application tag when used with protection information\&.
.RE
.PP
-\-\-limited\-retry, \-l
+\-l, \-\-limited\-retry
.RS 4
Sets the limited retry flag\&.
.RE
.PP
-\-\-force\-unit\-access, \-f
+\-f, \-\-force\-unit\-access
.RS 4
Set the force\-unit access flag\&.
.RE
The optional data set management attributes for this command\&. The argument for this is the least significant 8 bits of the DSM field in a write command; the most significant 16 bits of the field come from the directive specific field, if used\&. This may be used to set attributes for the LBAs being written, like access frequency, type, latency, among other things, as well as yet to be defined types\&. Please consult the NVMe specification for detailed breakdown of how to use this field\&.
.RE
.PP
-\-v, \-\-show\-cmd
+\-V, \-\-show\-cmd
.RS 4
Print out the command to be sent\&.
.RE
.RS 4
Ignore namespace is currently busy and performed the operation even though\&.
.RE
+.PP
+\-o <fmt>, \-\-output\-format=<fmt>
+.RS 4
+Set the reporting format to
+\fInormal\fR,
+\fIjson\fR
+or
+\fIbinary\fR\&. Only one output format can be used at a time\&.
+.RE
+.PP
+\-v, \-\-verbose
+.RS 4
+Increase the information detail in the output\&.
+.RE
.SH "EXAMPLES"
.sp
No examples yet\&.
[--prinfo=<prinfo> | -p <prinfo>]\r
[--app-tag-mask=<appmask> | -m <appmask>]\r
[--app-tag=<apptag> | -a <apptag>]\r
- [--limited-retry | -l]\r
- [--force-unit-access | -f]\r
+ [--limited-retry | -l] [--force-unit-access | -f]\r
[--dir-type=<type> | -T <type>]\r
- [--dir-spec=<spec> | -S <spec>]\r
- [--dsm=<dsm> | -D <dsm>]\r
- [--show-command | -v]\r
- [--dry-run | -w]\r
- [--latency | -t]\r
+ [--dir-spec=<spec> | -S <spec>] [--dsm=<dsm> | -D <dsm>]\r
+ [--show-command | -V] [--dry-run | -w] [--latency | -t]\r
[--storage-tag<storage-tag> | -g <storage-tag>]\r
- [--storage-tag-check | -C]\r
- [--force]</pre>\r
+ [--storage-tag-check | -C] [--force]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
---start-block=<slba>\r
+-s <slba>\r
</dt>\r
<dt class="hdlist1">\r
--s <slba>\r
+--start-block=<slba>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---block-count\r
+-c\r
</dt>\r
<dt class="hdlist1">\r
--c\r
+--block-count\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---data-size=<size>\r
+-z <size>\r
</dt>\r
<dt class="hdlist1">\r
--z <size>\r
+--data-size=<size>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---metadata-size=<size>\r
+-y <size>\r
</dt>\r
<dt class="hdlist1">\r
--y <size>\r
+--metadata-size=<size>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---data=<data-file>\r
+-d <data-file>\r
</dt>\r
<dt class="hdlist1">\r
--d <data-file>\r
+--data=<data-file>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---metadata=<metadata-file>\r
+-M <metadata-file>\r
</dt>\r
<dt class="hdlist1">\r
--M <metadata-file>\r
+--metadata=<metadata-file>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---prinfo=<prinfo>\r
+-p <prinfo>\r
</dt>\r
<dt class="hdlist1">\r
--p <prinfo>\r
+--prinfo=<prinfo>\r
</dt>\r
<dd>\r
<p>\r
</div>\r
</dd>\r
<dt class="hdlist1">\r
---ref-tag=<reftag>\r
+-r <reftag>\r
</dt>\r
<dt class="hdlist1">\r
--r <reftag>\r
+--ref-tag=<reftag>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag-mask=<appmask>\r
+-m <appmask>\r
</dt>\r
<dt class="hdlist1">\r
--m <appmask>\r
+--app-tag-mask=<appmask>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---app-tag=<apptag>\r
+-a <apptag>\r
</dt>\r
<dt class="hdlist1">\r
--a <apptag>\r
+--app-tag=<apptag>\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---limited-retry\r
+-l\r
</dt>\r
<dt class="hdlist1">\r
--l\r
+--limited-retry\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---force-unit-access\r
+-f\r
</dt>\r
<dt class="hdlist1">\r
--f\r
+--force-unit-access\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--v\r
+-V\r
</dt>\r
<dt class="hdlist1">\r
--show-cmd\r
</dt>\r
<dd>\r
<p>\r
- Ignore namespace is currently busy and performed the operation\r
- even though.\r
+ Ignore namespace is currently busy and performed the operation\r
+ even though.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-o <fmt>\r
+</dt>\r
+<dt class="hdlist1">\r
+--output-format=<fmt>\r
+</dt>\r
+<dd>\r
+<p>\r
+ Set the reporting format to <em>normal</em>, <em>json</em> or <em>binary</em>. Only one\r
+ output format can be used at a time.\r
+</p>\r
+</dd>\r
+<dt class="hdlist1">\r
+-v\r
+</dt>\r
+<dt class="hdlist1">\r
+--verbose\r
+</dt>\r
+<dd>\r
+<p>\r
+ Increase the information detail in the output.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-changed-zone-list
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-CHANGED\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-CHANGED\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme zns changed\-zone\-list\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>]
- [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-rae | \-r]
+\fInvme zns changed\-zone\-list\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
+ [\-\-namespace\-id=<NUM> | \-n <NUM>] [\-\-rae | \-r]
.fi
.SH "DESCRIPTION"
.sp
On success, the returned list may be decoded and displayed in one of several ways\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme zns changed-zone-list</em> <device> [-o <fmt> | --output-format=<fmt>]\r
- [--namespace-id=<NUM> | -n <NUM>]\r
- [--rae | -r]</pre>\r
+<pre class="content"><em>nvme zns changed-zone-list</em> <device> [--output-format=<fmt> | -o <fmt>]\r
+ [--namespace-id=<NUM> | -n <NUM>] [--rae | -r]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or\r
+ <em>binary</em>. Only one output format can be used at a time.\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-close-zone
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-CLOSE\-ZO" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-CLOSE\-ZO" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-finish-zone
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-FINISH\-Z" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-FINISH\-Z" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-id-ctrl
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-ID\-CTRL" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-ID\-CTRL" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme zns id\-ctrl\fR <device> [\-o <fmt> | \-\-output\-format=<fmt>]
+\fInvme zns id\-ctrl\fR <device> [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
On success, the data structure returned by the device will be decoded and displayed in one of several ways\&.
.SH "OPTIONS"
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>nvme-zns-id-ctrl -\r
- Send NVMe Zoned Command Set Identify Controller, return result and structure\r
+ Send NVMe Zoned Command Set Identify Controller, return result and structure\r
</p>\r
</div>\r
</div>\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme zns id-ctrl</em> <device> [-o <fmt> | --output-format=<fmt>]</pre>\r
+<pre class="content"><em>nvme zns id-ctrl</em> <device> [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div class="sectionbody">\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or\r
+ <em>binary</em>. Only one output format can be used at a time.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-id-ns
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-ID\-NS" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-ID\-NS" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.SH "SYNOPSIS"
.sp
.nf
-\fInvme zns id\-ns\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-o <fmt> | \-\-output\-format=<fmt>]
- [\-v | \-\-verbose]
+\fInvme zns id\-ns\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
+ [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v]
.fi
.SH "DESCRIPTION"
.sp
Increase the information detail in the output\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
<h2>NAME</h2>\r
<div class="sectionbody">\r
<p>nvme-zns-id-ns -\r
- Send NVMe Zoned Command Set Identify namespace, return result and structure\r
+ Send NVMe Zoned Command Set Identify namespace, return result and structure\r
</p>\r
</div>\r
</div>\r
<h2 id="_synopsis">SYNOPSIS</h2>\r
<div class="sectionbody">\r
<div class="verseblock">\r
-<pre class="content"><em>nvme zns id-ns</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [-o <fmt> | --output-format=<fmt>]\r
- [-v | --verbose]</pre>\r
+<pre class="content"><em>nvme zns id-ns</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or\r
+ <em>binary</em>. Only one output format can be used at a time.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-offline-zone
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-OFFLINE\-" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-OFFLINE\-" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-open-zone
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-OPEN\-ZON" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-OPEN\-ZON" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme zns open\-zone\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-start\-lba=<LBA> | \-s <LBA>]
- [\-\-zrwaa | \-r]
- [\-\-select\-all | \-a]
- [\-\-timeout=<timeout> | \-t <timeout>]
+ [\-\-start\-lba=<LBA> | \-s <LBA>] [\-\-zrwaa | \-r]
+ [\-\-select\-all | \-a] [\-\-timeout=<timeout> | \-t <timeout>]
.fi
.SH "DESCRIPTION"
.sp
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme zns open-zone</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--start-lba=<LBA> | -s <LBA>]\r
- [--zrwaa | -r]\r
- [--select-all | -a]\r
- [--timeout=<timeout> | -t <timeout>]</pre>\r
+ [--start-lba=<LBA> | -s <LBA>] [--zrwaa | -r]\r
+ [--select-all | -a] [--timeout=<timeout> | -t <timeout>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-report-zones
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-REPORT\-Z" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-REPORT\-Z" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
[\-\-extended | \-e]
[\-\-partial | \-p]
[\-\-verbose | \-v]
- [\-\-output\-format=<FMT> | \-o <FMT>]
+ [\-\-output\-format=<fmt> | \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
Increase the information detail in the output\&.
.RE
.PP
-\-o <format>, \-\-output\-format=<format>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
[--extended | -e]\r
[--partial | -p]\r
[--verbose | -v]\r
- [--output-format=<FMT> | -o <FMT>]</pre>\r
+ [--output-format=<fmt> | -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <format>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<format>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
- Set the reporting format to <em>normal</em>, <em>json</em>, or\r
- <em>binary</em>. Only one output format can be used at a time.\r
+ Set the reporting format to <em>normal</em>, <em>json</em>, or\r
+ <em>binary</em>. Only one output format can be used at a time.\r
</p>\r
</dd>\r
</dl></div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-reset-zone
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-RESET\-ZO" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-RESET\-ZO" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme zns reset\-zone\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-start\-lba=<LBA> | \-s <LBA>]
- [\-\-select\-all | \-a]
- [\-\-timeout=<timeout> | \-t <timeout>]
+ [\-\-start\-lba=<LBA> | \-s <LBA>]
+ [\-\-select\-all | \-a]
+ [\-\-timeout=<timeout> | \-t <timeout>]
.fi
.SH "DESCRIPTION"
.sp
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme zns reset-zone</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--start-lba=<LBA> | -s <LBA>]\r
- [--select-all | -a]\r
- [--timeout=<timeout> | -t <timeout>]</pre>\r
+ [--start-lba=<LBA> | -s <LBA>]\r
+ [--select-all | -a]\r
+ [--timeout=<timeout> | -t <timeout>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-set-zone-desc
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-SET\-ZONE" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-SET\-ZONE" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme zns set\-zone\-desc\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-start\-lba=<IONUM>, \-s <IONUM>]
- [\-\-zrwaa | \-r]
- [\-data=<FILE>, \-d <FILE>]
- [\-\-timeout=<timeout> | \-t <timeout>]
+ [\-\-start\-lba=<IONUM>, \-s <IONUM>]
+ [\-\-zrwaa | \-r]
+ [\-\-data=<FILE>, \-d <FILE>]
+ [\-\-timeout=<timeout> | \-t <timeout>]
.fi
.SH "DESCRIPTION"
.sp
Allocate Zone Random Write Area to zone\&.
.RE
.PP
-\-d <FILE, \-data=<FILE>
+\-d <FILE>, \-\-data=<FILE>
.RS 4
Optional file for data (default stdin)
.RE
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme zns set-zone-desc</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--start-lba=<IONUM>, -s <IONUM>]\r
- [--zrwaa | -r]\r
- [-data=<FILE>, -d <FILE>]\r
- [--timeout=<timeout> | -t <timeout>]</pre>\r
+ [--start-lba=<IONUM>, -s <IONUM>]\r
+ [--zrwaa | -r]\r
+ [--data=<FILE>, -d <FILE>]\r
+ [--timeout=<timeout> | -t <timeout>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--d <FILE\r
+-d <FILE>\r
</dt>\r
<dt class="hdlist1">\r
--data=<FILE>\r
+--data=<FILE>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-zone-append
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-ZONE\-APP" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-ZONE\-APP" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-zone-mgmt-recv
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-ZONE\-MGM" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-ZONE\-MGM" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme zns zone\-mgmt\-recv\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-start\-lba=<LBA> | \-s <LBA>]
- [\-\-data\-len=<IONUM>, \-l <IONUM>]
- [\-\-zra=<NUM>, \-z <NUM>]
- [\-\-zrasf=<NUM>, \-a <NUM>]
- [\-\-zra\-spec\-feat, \-f]
- [\-\-output\-format=<FMT>, \-o <FMT>]
+ [\-\-start\-lba=<LBA> | \-s <LBA>]
+ [\-\-data\-len=<IONUM>, \-l <IONUM>]
+ [\-\-zra=<NUM>, \-z <NUM>] [\-\-zrasf=<NUM>, \-a <NUM>]
+ [\-\-zra\-spec\-feat, \-f] [\-\-output\-format=<fmt>, \-o <fmt>]
.fi
.SH "DESCRIPTION"
.sp
The starting LBA of the zone to manage receive\&.
.RE
.sp
-\-\-data\-len=<NUM> \-l <NUM> Received data buffer length
+\-l <NUM> \-\-data\-len=<NUM> Received data buffer length
.PP
\-z <NUM>, \-\-zra=<NUM>
.RS 4
Enable Zone Receive Action Specific features
.RE
.PP
-\-o <FMT>, \-\-output\-format=<FMT>
+\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Output format: normal|json|binary
.RE
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme zns zone-mgmt-recv</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--start-lba=<LBA> | -s <LBA>]\r
- [--data-len=<IONUM>, -l <IONUM>]\r
- [--zra=<NUM>, -z <NUM>]\r
- [--zrasf=<NUM>, -a <NUM>]\r
- [--zra-spec-feat, -f]\r
- [--output-format=<FMT>, -o <FMT>]</pre>\r
+ [--start-lba=<LBA> | -s <LBA>]\r
+ [--data-len=<IONUM>, -l <IONUM>]\r
+ [--zra=<NUM>, -z <NUM>] [--zrasf=<NUM>, -a <NUM>]\r
+ [--zra-spec-feat, -f] [--output-format=<fmt>, -o <fmt>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
</dl></div>\r
-<div class="paragraph"><p>--data-len=<NUM>\r
--l <NUM>\r
+<div class="paragraph"><p>-l <NUM>\r
+--data-len=<NUM>\r
Received data buffer length</p></div>\r
<div class="dlist"><dl>\r
<dt class="hdlist1">\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--o <FMT>\r
+-o <fmt>\r
</dt>\r
<dt class="hdlist1">\r
---output-format=<FMT>\r
+--output-format=<fmt>\r
</dt>\r
<dd>\r
<p>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme-zns-zone-mgmt-send
.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME\-ZNS\-ZONE\-MGM" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME\-ZNS\-ZONE\-MGM" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.sp
.nf
\fInvme zns zone\-mgmt\-send\fR <device> [\-\-namespace\-id=<NUM> | \-n <NUM>]
- [\-\-start\-lba=<IONUM>, \-s <IONUM>]
- [\-\-zsaso, \-o]
- [\-\-select\-all, \-a]
- [\-\-zsa=<NUM>, \-z <NUM>]
- [\-\-data\-len=<IONUM>, \-l <IONUM>]
- [\-\-data=<FILE>, \-d <FILE>]
- [\-\-timeout=<timeout> | \-t <timeout>]
+ [\-\-start\-lba=<IONUM>, \-s <IONUM>] [\-\-zsaso, \-o]
+ [\-\-select\-all, \-a] [\-\-zsa=<NUM>, \-z <NUM>]
+ [\-\-data\-len=<IONUM>, \-l <IONUM>]
+ [\-\-data=<FILE>, \-d <FILE>]
+ [\-\-timeout=<timeout> | \-t <timeout>]
.fi
.SH "DESCRIPTION"
.sp
Zone Send Action Specific Option
.RE
.PP
-\-\-select\-all, \-a
+\-a, \-\-select\-all
.RS 4
Send command to all zones
.RE
Buffer length if data required
.RE
.PP
-\-d <FILE, \-\-data=<FILE>
+\-d <FILE>, \-\-data=<FILE>
.RS 4
Optional file for data (default stdin)
.RE
<div class="sectionbody">\r
<div class="verseblock">\r
<pre class="content"><em>nvme zns zone-mgmt-send</em> <device> [--namespace-id=<NUM> | -n <NUM>]\r
- [--start-lba=<IONUM>, -s <IONUM>]\r
- [--zsaso, -o]\r
- [--select-all, -a]\r
- [--zsa=<NUM>, -z <NUM>]\r
- [--data-len=<IONUM>, -l <IONUM>]\r
- [--data=<FILE>, -d <FILE>]\r
- [--timeout=<timeout> | -t <timeout>]</pre>\r
+ [--start-lba=<IONUM>, -s <IONUM>] [--zsaso, -o]\r
+ [--select-all, -a] [--zsa=<NUM>, -z <NUM>]\r
+ [--data-len=<IONUM>, -l <IONUM>]\r
+ [--data=<FILE>, -d <FILE>]\r
+ [--timeout=<timeout> | -t <timeout>]</pre>\r
<div class="attribution">\r
</div></div>\r
</div>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
---select-all\r
+-a\r
</dt>\r
<dt class="hdlist1">\r
--a\r
+--select-all\r
</dt>\r
<dd>\r
<p>\r
</p>\r
</dd>\r
<dt class="hdlist1">\r
--d <FILE\r
+-d <FILE>\r
</dt>\r
<dt class="hdlist1">\r
--data=<FILE>\r
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:08 CEST\r
+ 2023-12-19 12:48:30 CET\r
</div>\r
</div>\r
</body>\r
.\" Title: nvme
.\" Author: [see the "Authors" section]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
-.\" Date: 06/30/2023
+.\" Date: 12/19/2023
.\" Manual: NVMe Manual
.\" Source: NVMe
.\" Language: English
.\"
-.TH "NVME" "1" "06/30/2023" "NVMe" "NVMe Manual"
+.TH "NVME" "1" "12/19/2023" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
<div id="footer">\r
<div id="footer-text">\r
Last updated\r
- 2023-09-29 08:33:07 CEST\r
+ 2023-12-19 12:48:29 CET\r
</div>\r
</div>\r
</body>\r
projects / users / sagi / nvme-cli.git / commitdiff