--------
[verse]
'nvme-admin-passthru' <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]
+ [--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]
DESCRIPTION
-----------
--latency::
Print out the latency the IOCTL took (in us).
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* The following will run the admin command with opcode=6 and cdw10=1, which
SYNOPSIS
--------
[verse]
-'nvme ana-log' <device> [-o <fmt> | --output-format=<fmt>]
+'nvme ana-log' <device> [--groups | -g]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-------
-g::
--groups::
- Return the list of ANA groups without the namespace listing.
+ Return the list of ANA groups without the namespace listing.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
[verse]
'nvme attach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
[--controllers=<ctrl-list,> | -c <ctrl-list,>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
The comma separated list of controller identifiers to attach
the namespace too.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
Attach namespace to the controller:
- # nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21
+ # nvme attach-ns /dev/nvme1 -n 0x2 -c 0x21
NVME
----
--------
[verse]
'nvme boot-part-log' <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]
DESCRIPTION
-----------
--lsp=<field>::
The log specified field of LID.
--o <file>::
+-f <file>::
--output-file=<file>::
File name to which raw binary data will be saved to.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
NAME
----
nvme-capacity-mgmt - Send capacity management command to configure/create/delete
- Endurance Groups or NVM Sets, returns results.
+Endurance Groups or NVM Sets, returns results.
SYNOPSIS
--------
[--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]
DESCRIPTION
-----------
-------
-O <operation>::
--operation=<operation>::
- Operation to be performed by the controller
+ Operation to be performed by the controller
-i <element-id>::
--element-id=<element-id>::
- Value specific to the value of the Operation field.
+ Value specific to the value of the Operation field.
-l <cap-lower>::
--cap-lower=<cap-lower>::
Least significant 32 bits of the capacity in bytes of the Endurance Group or
- NVM Set to be created
+ NVM Set to be created
-u <cap-upper>::
--cap-upper=<cap-upper>::
Most significant 32 bits of the capacity in bytes of the Endurance Group or
- NVM Set to be created
+ NVM Set to be created
+
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
NAME
----
nvme-changed-ns-list-log - Send NVMe Changed Namespace List log page
- request, returns result and log.
+request, returns result and log.
SYNOPSIS
--------
[verse]
'nvme changed-ns-list-log' <device> [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--raw-binary::
Print the raw Changed Namespace List log buffer to stdout.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme check-dhchap-key' [--key=<key> ]
+'nvme check-dhchap-key' [--key=<key>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--key=<key>::
Key to be checked.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No Examples
SYNOPSIS
--------
[verse]
-'nvme check-tls-key' [--keyring=<name> | -k <name> ]
- [--keytype=<type> | -t <type> ]
- [--hostnqn=<nqn> | -n <nqn> ]
- [--subsysnqn=<nqn> | -c <nqn> ]
- [--keydata=<key> | -d <key> ]
+'nvme check-tls-key' [--keyring=<name> | -k <name>]
+ [--keytype=<type> | -t <type>]
+ [--hostnqn=<nqn> | -n <nqn>]
+ [--subsysnqn=<nqn> | -c <nqn>]
+ [--keydata=<key> | -d <key>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--keydata=<key>::
Key to be checked.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No Examples
--------
[verse]
'nvme cmdset-ind-id-ns' <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]
DESCRIPTION
-----------
This option will parse and format many of the bit fields
into human-readable formats.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
[--storage-tag<storage-tag> | -g <storage-tag>]
[--storage-tag-check | -C]
[--force]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-p <prinfo>::
--prinfo=<prinfo>::
Protection Information and check field.
-
+
[]
|=================
data protection processing.
--force::
- Ignore namespace is currently busy and performed the operation
- even though.
+ Ignore namespace is currently busy and performed the operation
+ even though.
+
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme config'
- [--scan | -R]
- [--modify | -M]
- [--update | -U]
- [--dump | -O]
- [--config=<cfg> | -J <cfg> ]
- [--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>]
- [--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 <#>]
- [--duplicate-connect | -D]
- [--disable-sqflow | -d]
- [--hdr-digest | -g]
- [--data-digest | -G]
+'nvme config' [--scan | -R] [--modify | -M] [--update | -U] [--dump | -O]
+ [--config=<cfg> | -J <cfg>]
+ [--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>]
+ [--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 <#>]
+ [--duplicate-connect | -D] [--disable-sqflow | -d]
+ [--hdr-digest | -g] [--data-digest | -G]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-M::
--modify::
Add or modify entries in the configuration based on the values from
- the commandline.
+ the commandline.
-U::
--update::
-t <trtype>::
--transport=<trtype>::
This field specifies the network fabric being used for
- a NVMe-over-Fabrics network. Current string values include:
+ a NVMe-over-Fabrics network. Current string values include:
+
[]
|=================
-s <trsvcid>::
--trsvcid=<trsvcid>::
- This field specifies the transport service id. For transports using IP
+ This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420.
--data-digest::
Generates/verifies data digest (TCP).
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Read the current system configuration and write the contents to /tmp/config.json:
nvme-connect(1)
https://github.com/linux-nvme/libnvme/doc/config-schema.json
-
AUTHORS
-------
This was written by mailto:hare@suse.com[Hannes Reinecke]
SYNOPSIS
--------
[verse]
-'nvme connect-all'
- [--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>]
+'nvme connect-all' [--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]
DESCRIPTION
-----------
-t <trtype>::
--transport=<trtype>::
This field specifies the network fabric being used for
- a NVMe-over-Fabrics network. Current string values include:
+ a NVMe-over-Fabrics network. Current string values include:
+
[]
|=================
|Value|Definition
|rdma|The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc)
-|fc |*WIP* The network fabric is a Fibre Channel network.
+|fc |*WIP* The network fabric is a Fibre Channel network.
|tcp |The network fabric is a TCP/IP network.
|loop|Connect to a NVMe over Fabrics target on the local host
|=================
-s <trsvcid>::
--trsvcid=<trsvcid>::
- This field specifies the transport service id. For transports using IP
+ This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420.
Print out resulting JSON configuration file to stdout.
--nbft::
- Only look at NBFT tables
+ Only look at NBFT tables
--no-nbft::
- Do not look at NBFT tables
+ Do not look at NBFT tables
--nbft-path=<STR>::
- Use a user-defined path to the NBFT tables
+ Use a user-defined path to the NBFT tables
--context <STR>::
Set the execution context to <STR>. This allows to coordinate
the management of the global resources.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Connect to all records returned by the Discover Controller with IP4 address
* Issue a 'nvme connect-all' command using a @SYSCONFDIR@/nvme/discovery.conf file:
+
-----------
-# Machine default 'nvme discover' commands. Query the
+# Machine default 'nvme discover' commands. Query the
# Discovery Controller's 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
SYNOPSIS
--------
[verse]
-'nvme connect'
- [--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>]
- [--application=<id> ]
+'nvme connect' [--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]
DESCRIPTION
-----------
-t <trtype>::
--transport=<trtype>::
This field specifies the network fabric being used for
- a NVMe-over-Fabrics network. Current string values include:
+ a NVMe-over-Fabrics network. Current string values include:
+
[]
|=================
-s <trsvcid>::
--trsvcid=<trsvcid>::
- This field specifies the transport service id. For transports using IP
+ This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420.
--dump-config::
Print out resulting JSON configuration file to stdout.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal' or 'json'. 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.
-
--context <STR>::
Set the execution context to <STR>. This allows to coordinate
the management of the global resources.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Connect to a subsystem named nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
nvme-discover(1)
nvme-connect-all(1)
-
AUTHORS
-------
This was co-written by mailto:james.p.freyensee@intel.com[Jay Freyensee]
[--dir-type=<type> | -T <type>]
[--dir-spec=<spec> | -S <spec>]
[--format=<entry-format> | -F <entry-format>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
---sdlba=<sdlba>::
-d <sdlba>::
+--sdlba=<sdlba>::
64-bit addr of first destination logical block
---blocks=<nlb-list,>::
-b <nlb-list,>::
+--blocks=<nlb-list,>::
Comma separated list of the number of blocks in each range
---slbs=<slbas,>::
-s <slbas,>::
+--slbs=<slbas,>::
Comma separated list of the starting blocks in each range
---limited-retry::
-l::
+--limited-retry::
Sets the limited retry flag.
---force-unit-access::
-f::
+--force-unit-access::
Set the force-unit access flag.
---prinfow=<prinfow>::
-p <prinfow>::
+--prinfow=<prinfow>::
Protection Information field write definition.
---prinfor=<prinfor>::
-P <prinfor>::
+--prinfor=<prinfor>::
Protection Information field read definition.
---ref-tag=<reftag>::
-r <reftag>::
+--ref-tag=<reftag>::
initial lba reference tag.
---expected-ref-tags=<reftag,>::
-R <reftag,>::
+--expected-ref-tags=<reftag,>::
expected lba reference tags (comma-separated list).
---app-tag=<apptag>::
-a <apptag>::
+--app-tag=<apptag>::
lba app tag
---expected-app-tags=<apptag,>::
-A <apptag,>::
+--expected-app-tags=<apptag,>::
expected lba app tags (comma-separated list)
---app-mask=<appmask>::
-m <appmask>::
+--app-mask=<appmask>::
lba tag mask
---expected-app-masks=<appmask,>::
-M <appmask,>::
+--expected-app-masks=<appmask,>::
expected lba tag masks (comma-separated list)
---dir-type=<type>::
-T <type>::
+--dir-type=<type>::
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.
---dir-spec=<spec>::
-S <spec>::
+--dir-spec=<spec>::
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's capabilities.
---format=<entry-format>::
-F <entry-format>::
+--format=<entry-format>::
source range entry format
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
[--ror=<ror> | -O <ror>]
[--rnumzrwa=<rnumzrwa> | -u <rnumzrwa>]
[--phndls=<placement-handle-list,> | -p <placement-handle-list,>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-b::
--block-size::
Target block size the new namespace should be formatted as. Potential FLBAS
- values will be values will be scanned and the lowest numbered will be
- selected for the create-ns operation. Conflicts with --flbas argument.
+ values will be values will be scanned and the lowest numbered will be
+ selected for the create-ns operation. Conflicts with --flbas argument.
-S::
--nsze-si::
The comma separated list of Reclaim Unit Handle Identifier to be associated
with each Placement Handle.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Create a namespace:
--------
[verse]
'nvme delete-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--namespace-id=<nsid>::
The namespace identifier to delete.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
-------
none
-
EXAMPLES
--------
* Print the Dera Device status and Additional SMART log page in a human readable format:
[verse]
'nvme detach-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
[--controllers=<ctrl-list,> | -c <ctrl-list,>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
The namespace identifier to detach.
-c <ctrl-list,>::
--controllers=<ctrl-list,>::
+--controllers=<ctrl-list,>::
The comma separated list of controller identifiers to detach
the namespace from.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
--------
[verse]
'nvme device-self-test' <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]
DESCRIPTION
-----------
-s <NUM>::
--self-test-code=<NUM>::
- This field specifies the action taken by the device self-test command :
- 0h: Show current state of device self-test operation
- 1h: Start a short device self-test operation
- 2h: Start a extended device self-test operation
- eh: Start a vendor specific device self-test operation
- fh: Abort the device self-test operation
+ This field specifies the action taken by the device self-test command :
+ 0h: Show current state of device self-test operation
+ 1h: Start a short device self-test operation
+ 2h: Start a extended device self-test operation
+ eh: Start a vendor specific device self-test operation
+ fh: Abort the device self-test operation
Default is 0h.
-w::
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.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Start a short device self-test in the namespace-id 1:
NAME
----
-nvme-dim - Send Discovery Information Management command to one or more Discovery Controllers.
+nvme-dim - Send Discovery Information Management command to one or more
+Discovery Controllers.
SYNOPSIS
--------
[verse]
-'nvme dim'
- [--task=<task> | -t <task>]
- [--nqn=<nqn> | -n <nqn>]
- [--device=<device> | -d <device>]
+'nvme dim' [--task=<task> | -t <task>] [--nqn=<nqn> | -n <nqn>]
+ [--device=<device> | -d <device>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
with this NVMe device handle. A list of comma-separated device handles can
be supplied to apply the command to more than one DC.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Register with the Central Discovery Controller (CDC) named
--------
[verse]
'nvme dir-receive' <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]
DESCRIPTION
-----------
-D <dtype>::
--dir-type=<dtype>::
- Directive type
+ Directive type
-S <dspec>::
--dir-spec=<dspec>::
- Directive specific
+ Directive specific
-O <doper>::
--dir-oper=<doper>::
- Directive operation
+ Directive operation
-r <nsr>::
--req-resource=<nsr>::
Directive requested resource count
-
+
[]
|==================
Print the decoded receive buffer to stdout if the command returns
a structure.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Identify directive type supported :
--------
[verse]
'nvme dir-send' <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]
DESCRIPTION
-----------
-D <dtype>::
--dir-type=<dtype>::
- Directive type
+ Directive type
-S <dspec>::
--dir-spec=<dspec>::
- Directive specific
+ Directive specific
-O <doper>::
--dir-oper=<doper>::
- Directive operation
+ Directive operation
-T <tdir>::
--target-dir=<nsr>::
-e <endir>::
--endir=<endir>::
Target directive enable(1) or disable (0) operation
-
+
[]
|==================
Print the decoded receive buffer to stdout if the command returns
a structure.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Enable streams directive :
SYNOPSIS
--------
[verse]
-'nvme disconnect-all'
+'nvme disconnect-all' [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
See the documentation for the nvme-disconnect(1) command for further
background.
+OPTIONS
+-------
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Disconnect all existing nvme controllers:
SYNOPSIS
--------
[verse]
-'nvme disconnect'
- [--nqn=<subnqn> | -n <subnqn>]
- [--device=<device> | -d <device>]
+'nvme disconnect' [--nqn=<subnqn> | -n <subnqn>]
+ [--device=<device> | -d <device>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Disconnects and removes one or more existing NVMe over Fabrics controllers.
If the --nqn option is specified all controllers connecting to the Subsystem
-identified by subnqn will be removed. If the --device option is specified
+identified by subnqn will be removed. If the --device option is specified
the controller specified by the --device option will be removed.
OPTIONS
Indicates that the controller with the specified name should be
removed.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Disconnect all controllers for a subsystem named
--------
nvme-connect(1)
-
NVME
----
Part of the nvme-user suite
SYNOPSIS
--------
[verse]
-'nvme discover'
- [--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>]
+'nvme discover' [--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]
DESCRIPTION
-----------
If no parameters are given, then 'nvme discover' will attempt to
find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of
-Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file
+Discovery commands to run. If no @SYSCONFDIR@/nvme/discovery.conf file
exists, the command will quit with an error.
Otherwise, a specific Discovery Controller should be specified using the
The NVMe-over-Fabrics specification defines the concept of a
Discovery Controller that an NVMe Host can query on a fabric
network to discover NVMe subsystems contained in NVMe Targets
-which it can connect to on the network. The Discovery Controller
+which it can connect to on the network. The Discovery Controller
will return Discovery Log Pages that provide the NVMe Host
with specific information (such as network address and unique
subsystem NQN) the NVMe Host can use to issue an
resources are allocated to the NVMe Host for a connection.
A Discovery Controller has it's own NQN defined in the NVMe-over-Fabrics
-specification, *nqn.2014-08.org.nvmexpress.discovery*. All Discovery
+specification, *nqn.2014-08.org.nvmexpress.discovery*. All Discovery
Controllers must use this NQN name. This NQN is used by default by
nvme-cli for the 'discover' command.
-t <trtype>::
--transport=<trtype>::
This field specifies the network fabric being used for
- a NVMe-over-Fabrics network. Current string values include:
+ a NVMe-over-Fabrics network. Current string values include:
+
[]
|=================
-s <trsvcid>::
--trsvcid=<trsvcid>::
- This field specifies the transport service id. For transports using IP
+ This field specifies the transport service id. For transports using IP
addressing (e.g. rdma) this field is the port number. By default, the IP
port number for the RDMA transport is 4420.
--dump-config::
Print out resulting JSON configuration file to stdout.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
--force::
Disable the built-in persistent discover connection rules.
persistent discovery connection.
--nbft::
- Only look at NBFT tables
+ Only look at NBFT tables
--no-nbft::
- Do not look at NBFT tables
+ Do not look at NBFT tables
--nbft-path=<STR>::
- Use a user-defined path to the NBFT tables
+ Use a user-defined path to the NBFT tables
--context <STR>::
Set the execution context to <STR>. This allows to coordinate
the management of the global resources.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Query the Discover Controller with IP4 address 192.168.1.3 for all
* Issue a 'nvme discover' command using a @SYSCONFDIR@/nvme/discovery.conf file:
+
-----------
-# Machine default 'nvme discover' commands. Query the
+# Machine default 'nvme discover' commands. Query the
# Discovery Controller's 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
SYNOPSIS
--------
[verse]
-'nvme dsm' <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> ]
-
+'nvme dsm' <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]
DESCRIPTION
-----------
All the command command dword 11 attributes. Use exclusive from
specifying individual attributes
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet
NAME
----
-nvme-effects-log - Send NVMe Command Effects log page request, returns result and log
+nvme-effects-log - Send NVMe Command Effects log page request, returns result
+and log
SYNOPSIS
--------
[verse]
-'nvme effects-log' <device> [--output-format=<fmt> | -o <fmt>]
- [--human-readable | -H]
- [--raw-binary | -b]
+'nvme effects-log' <device> [--human-readable | -H] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- This option will set the reporting format to normal, json, or binary.
- Only one output format can be used at a time.
-
-H::
--human-readable::
This option will parse and format many of the bit fields into a
-b::
--raw-binary::
This option will print the raw buffer to stdout. Structure is not
- parsed by program. This overrides the human-readable option.
+ parsed by program. This overrides the human-readable option.
+
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
[verse]
'nvme endurance-event-agg-log' <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]
DESCRIPTION
-----------
-------
-e <log_entries>::
--log-entries=<log_entries>::
- Retrieve the Endurance Group Event Aggregate Log pending entries.
- This argument is mandatory and its success may depend on the device's
- statistics to provide this log For More details see NVM Express 1.4 Spec.
- Section 5.14.1.15. The maximum number of log entries supported is 2044
- for the device.
+ Retrieve the Endurance Group Event Aggregate Log pending entries.
+ This argument is mandatory and its success may depend on the device's
+ statistics to provide this log For More details see NVM Express 1.4 Spec.
+ Section 5.14.1.15. The maximum number of log entries supported is 2044
+ for the device.
-r::
--rae::
Retain an Asynchronous Event.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme endurance-log' <device> [--group-id=<group> | -g <group>]
- [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--group-id=<group>::
The endurance group identifier.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme error-log' <device> [--log-entries=<entries> | -e <entries>]
- [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]
+'nvme error-log' <device> [--log-entries=<entries> | -e <entries>]
+ [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--raw-binary::
Print the raw error log buffer to stdout.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme fdp configs' <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>]
DESCRIPTION
-----------
--raw-binary::
Print the raw buffer to the standard output stream.
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', 'json', or 'binary'. Only one
output format can be used at a time.
SYNOPSIS
--------
[verse]
-'nvme fdp events' <device> [--endgrp-id=<NUM> | -e <NUM>]
- [--host-events | -E]
- [--raw-binary | -b]
- [--output-format=<FMT> | -o <FMT>]
+'nvme fdp events' <device> [--endgrp-id=<NUM> | -e <NUM>] [--host-events | -E]
+ [--raw-binary | -b] [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
--raw-binary::
Print the raw buffer to the standard output stream.
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', 'json', or 'binary'. Only one
output format can be used at a time.
--------
[verse]
'nvme fdp set-events' <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,>]
DESCRIPTION
-----------
--raw-binary::
Print the raw buffer to the standard output stream.
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', 'json', or 'binary'. Only one
output format can be used at a time.
SYNOPSIS
--------
[verse]
-'nvme fdp stats' <device> [--endgrp-id=<NUM> | -e <NUM>]
- [--raw-binary | -b]
- [--output-format=<FMT> | -o <FMT>]
+'nvme fdp stats' <device> [--endgrp-id=<NUM> | -e <NUM>] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
--raw-binary::
Print the raw buffer to the standard output stream.
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', 'json', or 'binary'. Only one
output format can be used at a time.
SYNOPSIS
--------
[verse]
-'nvme fdp status' <device> [--namespace-id=<NUM> | -n <NUM>]
- [--raw-binary | -b]
- [--output-format=<FMT> | -o <FMT>]
+'nvme fdp status' <device> [--namespace-id=<NUM> | -n <NUM>] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
--raw-binary::
Print the raw buffer to the standard output stream.
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', 'json', or 'binary'. Only one
output format can be used at a time.
--------
[verse]
'nvme fdp update' <device> [--namespace-id=<NUM> | -n <NUM>]
- [--pids=<NUM,> | -p <NUM,>]
+ [--pids=<NUM,> | -p <NUM,>]
DESCRIPTION
-----------
SYNOPSIS
--------
[verse]
-'nvme fdp usage' <device> [--endgrp-id=<NUM> | -e <NUM>]
- [--raw-binary | -b]
- [--output-format=<FMT> | -o <FMT>]
+'nvme fdp usage' <device> [--endgrp-id=<NUM> | -e <NUM>] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
--raw-binary::
Print the raw buffer to the standard output stream.
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', 'json', or 'binary'. Only one
output format can be used at a time.
SYNOPSIS
--------
[verse]
-'nvme fid-support-effects-log' <device> [-o <fmt> | --output-format=<fmt>]
+'nvme fid-support-effects-log' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
-
-H::
--human-readable::
This option will parse and format many of the bit fields
into human-readable formats.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
--------
[verse]
'nvme flush' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Specify the optional namespace id for this command. Defaults to
0xffffffff, indicating flush for all namespaces.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
--------
[verse]
'nvme format' <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]
DESCRIPTION
-----------
--timeout=<timeout>::
Override default timeout value. In milliseconds.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Format the device using all defaults:
--------
[verse]
'nvme fw-commit' <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]
DESCRIPTION
-----------
Specifies the Boot partition that shall be used for the Commit Action,
if applicable (default: 0)
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* commit the last downloaded fw to slot 1.
--------
[verse]
'nvme fw-download' <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]
DESCRIPTION
-----------
the offset starts at zero and automatically adjusts based on the
'xfer' size given.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Transfer a firmware size 128KiB at a time:
--------
[verse]
'nvme fw-log' <device> [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--raw-binary::
Print the raw fw log buffer to stdout.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme gen-dhchap-key' [--hmac=<hmac-id> | -h <hmac-id>]
- [--secret=<secret> | -s <secret> ]
- [--key-length=<len> | -l <len> ]
- [--nqn=<host-nqn> | -n <host-nqn> ]
+ [--secret=<secret> | -s <secret>]
+ [--key-length=<len> | -l <len>]
+ [--nqn=<host-nqn> | -n <host-nqn>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Host-NQN to be used for the transformation. This parameter is only
valid if a non-zero HMAC function has been specified.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No Examples
SYNOPSIS
--------
[verse]
-'nvme gen-hostnqn'
+'nvme gen-hostnqn' [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
-No options needed
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme gen-tls-key' [--keyring=<name> | -k <name>]
- [--keytype=<type> | -t <type> ]
- [--hostnqn=<nqn> | -n <nqn>]
- [--subsysnqn=<nqn> | -c <nqn>]
- [--hmac=<hmac-id> | -h <hmac-id>]
- [--secret=<secret> | -s <secret> ]
- [--insert | -i ]
+ [--keytype=<type> | -t <type>]
+ [--hostnqn=<nqn> | -n <nqn>]
+ [--subsysnqn=<nqn> | -c <nqn>]
+ [--hmac=<hmac-id> | -h <hmac-id>]
+ [--secret=<secret> | -s <secret>]
+ [--insert | -i]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Insert the resulting TLS key into the keyring without printing out
the key in PSK interchange format.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No Examples
--------
[verse]
'nvme get-feature' <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]
DESCRIPTION
-----------
This option will parse and format many of the bit fields
into human-readable formats.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Retrieves the feature for Number of Queues, or feature id 7:
--------
[verse]
'nvme get-lba-status' <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]
DESCRIPTION
-----------
--timeout=<timeout>::
Override default timeout value. In milliseconds.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme get-log' <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> | -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>]
+ [--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]
DESCRIPTION
-----------
Specify the read chunk size. The length argument is expected to be
a multiple of 4096. The default size is 4096.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Get 512 bytes from log page 2
SYNOPSIS
--------
[verse]
-'nvme get-ns-id' <device>
+'nvme get-ns-id' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
-None
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme get-property' <device> [--offset=<offset> | -O <offset>]
- [--human-readable | -H ]
-
+ [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Reads and shows the defined NVMe controller property for NVMe over Fabric.
-
OPTIONS
-------
-O::
--offset::
- The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20
+ The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20
-H::
--human-readable:
Show the fields packed in the property
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
# nvme get-property /dev/nvme0 --offset=0x0 --human-readable
------------
-
BUGS
----
Currently the CAP value is truncated to 32 bits due to a limitation in
SYNOPSIS
--------
[verse]
-'nvme huawei id-ctrl' <device> [-v | --vendor-specific] [-b | --raw-binary]
- [-o <fmt> | --output-format=<fmt>]
+'nvme huawei id-ctrl' <device> [--vendor-specific | -v] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
This option will parse and format many of the bit fields
into human-readable formats.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme huawei list' [-o <fmt> | --output-format=<fmt>]
+'nvme huawei list' [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal' or 'json'. Only one output
format can be used at a time.
SYNOPSIS
--------
[verse]
-'nvme id-ctrl' <device> [-V | --vendor-specific] [-b | --raw-binary]
- [-o <fmt> | --output-format=<fmt>]
+'nvme id-ctrl' <device> [--vendor-specific | -V] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
This option will parse and format many of the bit fields
into human-readable formats.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme id-domain' <device> [--dom-id=<domian_id> | -d <domian_id>]
- [-o <fmt> | --output-format=<fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Retrieve the identify domain list data structure for the given
domain id. If this value is not given, domain id will be 0xffff.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme id-iocs' <device> [--controller-id=<cntid> | -c <cntid>]
- [-o <fmt> | --output-format=<fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
This option will parse and format many of the bit fields
into human-readable formats.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme id-ns' <device> [--uuid-index=<uuid-index> | -U <uuid_index>]
- [--lba-format-index=<lba_format_index> | -i <lba_format_index>]
- [-v | --verbose]
- [--output-format=<fmt> | -o <fmt>]
+ [--lba-format-index=<lba_format_index> | -i <lba_format_index>]
+ [--verbose | -v]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-U <uuid-index>::
--uuid-index=<uuid-index>::
UUID Index of the feature
-
+
-i <lba_format_index>::
--lba-format-index=<lba_format_index>::
This field specifies the index into the LBA Format list identifying
--verbose::
Increase the information detail in the output.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme id-ns' <device> [-V | --vendor-specific] [-b | --raw-binary]
- [--namespace-id=<nsid> | -n <nsid>] [--force]
- [--human-readable | -H]
- [--output-format=<fmt> | -o <fmt>]
+'nvme id-ns' <device> [--vendor-specific | -v] [--raw-binary | -b]
+ [--namespace-id=<nsid> | -n <nsid>] [--force]
+ [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
This option will parse and format many of the bit fields
into human-readable formats.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
-
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme id-nvmset' <device> [-i <id> | --nvmset_id=<id> ]
- [-o <fmt> | --output-format=<fmt>]
+'nvme id-nvmset' <device> [--nvmset_id=<id> | -i <id>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-------
-i <id>::
--nvmset_id=<id>::
- This field specifies the identifier of the NVM Set. If given, NVM set
+ 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.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
-------
none
-
EXAMPLES
--------
* Print the Inspur Device Vendor log page in a human readable format:
SYNOPSIS
--------
[verse]
-'nvme intel id-ctrl' <device> [-v | --vendor-specific] [-b | --raw-binary]
- [-o <fmt> | --output-format=<fmt>]
+'nvme intel id-ctrl' <device> [--vendor-specific | -v] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
This option will parse and format many of the bit fields
into human-readable formats.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
EXAMPLES
--------
When used with 'nlog', this specifies which nlog to read. -1
for all, if supported by the device.
-
EXAMPLES
--------
* Gets the nlog from the device and saves to default file:
NAME
----
-nvme-intel-smart-log-add - Send NVMe Intel Additional SMART log page request, returns result and log
+nvme-intel-smart-log-add - Send NVMe Intel Additional SMART log page request,
+returns result and log
SYNOPSIS
--------
[verse]
'nvme intel smart-log-add' <device> [--namespace-id=<nsid> | -n <nsid>]
- [--raw-binary | -b]
- [--json | -j]
+ [--raw-binary | -b] [--json | -j]
DESCRIPTION
-----------
-j::
--json::
- Dump output in json format.
+ Dump output in json format.
EXAMPLES
--------
--------
[verse]
'nvme io-mgmt-recv' <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]
DESCRIPTION
-----------
--mos=<NUM>::
Management Operation Specific parameter.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
NVME
----
--------
[verse]
'nvme io-mgmt-send' <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]
DESCRIPTION
-----------
--mos=<NUM>::
Management Operation Specific parameter.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
NVME
----
--------
[verse]
'nvme-io-passthru' <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]
+ [--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]
DESCRIPTION
-----------
--latency::
Print out the latency the IOCTL took (in us).
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme lba-status-log' <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]
+'nvme lba-status-log' <device> [--rae | -r]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--rae::
Retain an Asynchronous Event.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or 'binary'.
- Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme list-ctrl' <device> [--cntid=<cntid> | -c <cntid>]
- [--namespace-id=<nsid> | -n <nsid>] [-o <fmt> | --output-format=<fmt>]
+ [--namespace-id=<nsid> | -n <nsid>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
DESCRIPTION
-----------
For the NVMe device given, sends an identify command for controller list
command requests the controller list for the entire subsystem,
whether or not they are attached to namespace(s).
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal' or 'json'. Only one output
- format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
NAME
----
-nvme-list-endgrp - Send NVMe Identify Endurance Group List, return result and structure
+nvme-list-endgrp - Send NVMe Identify Endurance Group List, return result and
+structure
SYNOPSIS
--------
[verse]
'nvme list-endgrp' <device> [--endgrp-id=<endgrp-id> | -i <endgrp-id>]
- [-o <fmt> | --output-format=<fmt>]
-
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
DESCRIPTION
-----------
For the NVMe device given, sends an identify command for endurance group list
-------
-i <endgrp-id>::
--endgrp-id=<endgrp-id>::
- Retrieve the identify endurance group list structure starting for the given
- endurance group id.
+ Retrieve the identify endurance group list structure starting for the
+ given endurance group id.
+
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal' or 'json'. Only one output
- format can be used at a time.
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
[verse]
'nvme list-ns' <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]
DESCRIPTION
-----------
Retrieve the identify list structure for all namespaces in the
subsystem, whether attached or inactive.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', or 'json'.
- Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme list-subsys' [-o <fmt> | --output-format=<fmt>] <device>
+'nvme list-subsys' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal' or 'json'. Only one output
- format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme list' [-o <fmt> | --output-format=<fmt>]
+'nvme list' [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal' or 'json'. Only one output
- format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
-v::
--verbose::
-----------
PCI_IDS_PATH - Full path of pci.ids file in case nvme could not find it in common locations.
-
EXAMPLES
--------
No examples yet.
NAME
----
nvme-lockdown - Send an NVMe Lockdown command to prohibit or allow the execution of command
-
SYNOPSIS
--------
[verse]
[--prhbt=<prhbt> | -p <prhbt>]
[--scp=<scp> | -s <scp>]
[--uuid=<UUID_Index> | -U <UUID_Index>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
---ofi=<ofi>::
-O <ofi>::
+--ofi=<ofi>::
Opcode or Feature Identifier(OFI) specifies the command opcode or Set
Features Feature Identifier identified by the Scope field.
---ifc=<ifc>::
-f <ifc>::
+--ifc=<ifc>::
Interface (INF) field identifies the interfaces affected by this command.
---prhbt=<prhbt>::
-p <prhbt>::
+--prhbt=<prhbt>::
Prohibit (PRHBT) bit specifies whether to prohibit or allow the command
opcode or Set Features Feature Identifier specified by this command.
---scp=<scp>::
-s <scp>::
+--scp=<scp>::
Scope (SCP) field specifies the contents of the Opcode or Feature Identifier field.
-
---uuid=<UUID_Index>::
-U <UUID_Index>::
+--uuid=<UUID_Index>::
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.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
SYNOPSIS
--------
[verse]
-'nvme media-unit-stat-log' <device> [--dom-id | -d ]
- [--output-format=<fmt> | -o <fmt>]
- [--raw-binary | -b]
+'nvme media-unit-stat-log' <device> [--dom-id | -d] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- This option will set the reporting format to normal, json, or binary.
- Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ This option will set the reporting format to normal, json, or binary.
+ Only one output format can be used at a time.
-d::
--dom-id::
- To get the domain ID.
+ To get the domain ID.
+
-b::
--raw-binary::
- To show raw binary data.
+ To show raw binary data.
EXAMPLES
--------
NAME
----
nvme-mi-cmd-support-effects-log - Send NVMe MI Command Support and Effects log,
- returns results and structure
+returns results and structure
SYNOPSIS
--------
[verse]
-'nvme-mi-cmd-support-effects-log' <device> [-o <fmt> | --output-format=<fmt>]
- [-H | --human-readable]
+'nvme-mi-cmd-support-effects-log' <device> [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
-
-H::
--human-readable::
This option will parse and format many of the bit fields
into human-readable formats.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
nvme mi-cmd-support-effects-log /dev/nvme0 -H
NAME
----
-nvme-micron-internal-log - Retrieve Micron device's internal logs and save to given zip file.
+nvme-micron-internal-log - Retrieve Micron device's internal logs and save to
+given zip file.
SYNOPSIS
--------
DESCRIPTION
-----------
-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.
The <device> parameter is mandatory and may be either the NVMe
character device (ex: /dev/nvme0), or a namespace block device (ex:
/dev/nvme0n1).
-This will only work on Micron devices devices of model numbers 9200 and 54XX. 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 numbers 9200 and 54XX.
+Support for new devices may be added subsequently. Results for any other device
+are undefined.
OPTIONS
-------
-l <FILE>::
--package=<FILE>::
- name of the file (with .zip extension) to save the device logs
+ name of the file (with .zip extension) to save the device logs
EXAMPLES
--------
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.
SYNOPSIS
--------
[verse]
-'nvme micron selective-download' <device> [--fw=<FILE>, -f <FILE>] [--select=<flag>, -s <flag>]
+'nvme micron selective-download' <device> [--fw=<FILE>, -f <FILE>]
+ [--select=<flag>, -s <flag>]
DESCRIPTION
-----------
-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.
The <device> parameter is mandatory and may be either the NVMe
character device (ex: /dev/nvme0), or a namespace block device (ex:
/dev/nvme0n1).
-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.
OPTIONS
-------
-f <FILE>::
--fw=<FILE>::
- name of the firmware image file
+ name of the firmware image file
+
-s <flag>::
--select=<flag>::
- flag that has following values
- OOB:: This updates the OOB and main firmware\n"
- EEP:: This updates the eeprom and main firmware\n"
- ALL:: This updates the eeprom, OOB, and main firmware";
+ flag that has following values
+ OOB:: This updates the OOB and main firmware\n"
+ EEP:: This updates the eeprom and main firmware\n"
+ ALL:: This updates the eeprom, OOB, and main firmware";
EXAMPLES
--------
+
------------
# nvme micron selective-download /dev/nvme0 --fw=firmware_bin --select=OOB
-# nvme micron selective-download /dev/nvme0 -f firmware_bin -s OOB
+# nvme micron selective-download /dev/nvme0 -f firmware_bin -s OOB
------------
* Update OOB and main firmware
SYNOPSIS
--------
[verse]
-'nvme micron vs-smart-add-log' <device> -f <json|normal>
+'nvme micron vs-smart-add-log' <device> -f <json|normal>
DESCRIPTION
-----------
OPTIONS
-------
--f <json|normal> controls the format of displayed output.
-
+-f <json|normal>::
+ Controls the format of displayed output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme netapp ontapdevices' [-o <fmt> | --output-format=<fmt>]
+'nvme netapp ontapdevices' [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
-------
-o <fmt>::
--output-format=<fmt>::
- Set the reporting format to 'normal' (default), 'column', or
- 'json'. Only one output format can be used at a time.
+ Set the reporting format to 'normal' (default), 'column', or
+ 'json'. Only one output format can be used at a time.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme netapp smdevices' [-o <fmt> | --output-format=<fmt>]
+'nvme netapp smdevices' [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
SYNOPSIS
--------
[verse]
-'nvme ns-descs' <device> [--namespace-id=<nsid> | -n <nsid>]
- [--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]
+'nvme ns-descs' <device> [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Print the raw buffer to stdout. Structure is not parsed by
program.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or 'binary'.
- Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme ns-rescan' <device>
+'nvme ns-rescan' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
-None
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme nvm-id-ctrl' <device> [-o <fmt> | --output-format=<fmt>]
+'nvme nvm-id-ctrl' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
[verse]
'nvme nvm-id-ns-lba-format' <device> [--uuid-index=<uuid-index> | -U <uuid_index>]
[--lba-format-index=<lba_format_index> | -i <lba_format_index>]
- [-v | --verbose]
- [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
This field specifies the index into the LBA Format list identifying
the LBA Format capabilities that are to be returned
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
-v::
--verbose::
Increase the information detail in the output.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
-
EXAMPLES
--------
* Has the program interpret the returned buffer and display the known
[verse]
'nvme nvm-id-ns' <device> [--uuid-index=<uuid-index> | -U <uuid_index>]
[--namespace-id=<NUM> | -n <NUM>]
- [-v | --verbose]
- [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--uuid-index=<uuid-index>::
UUID Index of the feature
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
-v::
--verbose::
Increase the information detail in the output.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
-
EXAMPLES
--------
* Has the program interpret the returned buffer and display the known
--------
[verse]
'nvme nvme-mi-recv' <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>]
+ [--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]
DESCRIPTION
-----------
to fill the buffer sent to the device. If no file is given,
assumed to use STDIN.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Has the program issue a nvme-mi-recv to execute the VPD read.
--------
[verse]
'nvme nvme-mi-send' <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>]
+ [--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]
DESCRIPTION
-----------
to fill the buffer sent to the device. If no file is given,
assumed to use STDIN.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Has the program issue a nvme-mi-send to execute the VPD write.
-n::
--no-uuid::
Do not try to automatically detect UUID index for this command (required
- for old OCP 1.0 support)
+ for old OCP 1.0 support)
EXAMPLES
--------
-n::
--no-uuid::
Do not try to automatically detect UUID index for this command (required
- for old OCP 1.0 support)
+ for old OCP 1.0 support)
EXAMPLES
--------
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal' or 'json' or 'binary'.
Only one output format can be used at a time. The default is normal.
NAME
----
-nvme-ocp-eol-plp-failure-mode - Define and print EOL or PLP circuitry failure mode
+nvme-ocp-eol-plp-failure-mode - Define and print EOL or PLP circuitry failure
+mode
SYNOPSIS
--------
[verse]
-'nvme ocp eol-plp-failure-mode' <device> [--mode=<mode> | -m <mode>] [--no-uuid | -n] [--save | -s]
- [--sel=<select> | -s <select>]
+'nvme ocp eol-plp-failure-mode' <device> [--mode=<mode> | -m <mode>]
+ [--no-uuid | -n] [--save | -s]
+ [--sel=<select> | -s <select>]
DESCRIPTION
-----------
-m <mode>::
--mode=<mode>::
Set the EOL or PLP circuitry failure mode to [0-3] ('0: default',
- '1: rom', '2: wtm' or '3: normal'). Only one mode
+ '1: rom', '2: wtm' or '3: normal'). Only one mode
can be used at a time. The default is rom.
-n::
--no-uuid::
Do not try to automatically detect UUID index for this command (required
- for old OCP 1.0 support)
+ for old OCP 1.0 support)
-s::
--save::
- Save the attribute so that it persists through all power states and resets.
+ Save the attribute so that it persists through all power states and
+ resets.
-s <select>::
--sel=<select>::
\r
OPTIONS\r
-------\r
--o <format>::\r
---output-format=<format>::\r
+-o <fmt>::\r
+--output-format=<fmt>::\r
Set the reporting format to 'normal' or 'json' or 'binary'. \r
Only one output format can be used at a time. The default is normal.\r
\r
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal' or 'json'. Only one output format
can be used at a time. The default is normal.
SYNOPSIS
--------
[verse]
-'nvme ocp set-dssd-power-state-feature' <device> [--power-state=<fmt> | -p <fmt>] [--no-uuid | -n]
- [--save | -s]
+'nvme ocp set-dssd-power-state-feature' <device>
+ [--power-state=<fmt> | -p <fmt>] [--no-uuid | -n]
+ [--save | -s]
DESCRIPTION
-----------
OPTIONS
-------
--p <format>::
---power-state=<format>::
+-p <fmt>::
+--power-state=<fmt>::
DSSD Power State to set in watts.
EXAMPLES
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal' or 'json'. Only one output format
can be used at a time. The default is normal.
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
This option will set the reporting format to normal, json, or binary.
Only one output format can be used at a time.
--------
[verse]
'nvme persistent-event-log' <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]
DESCRIPTION
-----------
-------
-a <action>::
--action=<action>::
- While try to retrieve this log action the controller shall take
- during processing this persistent log page command. This mandatory
- field, based on the value issued it may Read Log Data, Establish
- Context and Read Log Data or Release Context can occur. For More
- details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent
- Event Log (Log Identifier 0Dh)
+ While try to retrieve this log action the controller shall take
+ during processing this persistent log page command. This mandatory
+ field, based on the value issued it may Read Log Data, Establish
+ Context and Read Log Data or Release Context can occur. For More
+ details see NVM Express 1.4 Spec. Section 5.14.1.13 Persistent
+ Event Log (Log Identifier 0Dh)
-l <log-len>::
--log-len=<log-len>::
- Allocates a buffer of <log-len> bytes size and requests this
- many bytes be returned in the constructed NVMe command. This
- param is mandatory. If <log-len> given is 0 and action is 0,
- it will read the Total Log Length(TLL) of the page.
+ Allocates a buffer of <log-len> bytes size and requests this
+ many bytes be returned in the constructed NVMe command. This
+ param is mandatory. If <log-len> given is 0 and action is 0,
+ it will read the Total Log Length(TLL) of the page.
-b::
--raw-binary::
- Print the raw persistent event log buffer to stdout.
+ Print the raw persistent event log buffer to stdout.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or 'binary'.
- Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
NAME
----
-nvme-phy-rx-eom-log - Retrieves a Physical Interface Receiver Eye Opening Measurement log page from an NVMe device
+nvme-phy-rx-eom-log - Retrieves a Physical Interface Receiver Eye Opening
+Measurement log page from an NVMe device
SYNOPSIS
--------
[verse]
'nvme phy-rx-eom-log' <device> [--lsp=<field> | -s <field>]
- [--controller=<id> | -c <id>]
- [--output-format=<fmt> | -o <fmt>]
+ [--controller=<id> | -c <id>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
Controller ID of the controller associated wit the PCIe port to be
measured.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
+
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
# nvme phy-rx-eom-log /dev/nvme0 --lsp=2 --controller=3
------------
-
NVME
----
Part of the nvme-user suite
SYNOPSIS
--------
[verse]
-'nvme pred-lat-event-agg-log' <device> [--log-entries=<log_entries> | -e <log_entries>]
+'nvme pred-lat-event-agg-log' <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]
DESCRIPTION
-----------
-------
-e <log_entries>::
--log-entries=<log_entries>::
- Retrieve the Predictable Latency Event Aggregate Log pending entries.
- This argument is mandatory and its success may depend on the device's
- statistics to provide this log For More details see NVM Express 1.4 Spec.
- Section 5.14.1.11. The maximum number of log entries supported is 2044
- for the device.
+ Retrieve the Predictable Latency Event Aggregate Log pending entries.
+ This argument is mandatory and its success may depend on the device's
+ statistics to provide this log For More details see NVM Express 1.4 Spec.
+ Section 5.14.1.11. The maximum number of log entries supported is 2044
+ for the device.
-r::
--rae::
--raw-binary::
Print the raw Predictable Latency Event Aggregate log buffer to stdout.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or 'binary'.
- Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json', or 'binary'.
+ Only one output format can be used at a time.
EXAMPLES
--------
[verse]
'nvme predictable-lat-log' <device> [--nvmset-id=<nvmset_id> | -i <nvmset_id>]
[--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-------
-i <nvmset_id>::
--nvmset-id=<nvmset_id>::
- Retrieve the Predictable latency per NVM set log for the given nvmset id.
- This argument is mandatory and its success may depend on the device's
- statistics to provide this log For More details see NVM Express 1.4 Spec.
- Section 5.14.1.10. The default nvmset id to use is 1 for the device.
+ Retrieve the Predictable latency per NVM set log for the given nvmset id.
+ This argument is mandatory and its success may depend on the device's
+ statistics to provide this log For More details see NVM Express 1.4 Spec.
+ Section 5.14.1.10. The default nvmset id to use is 1 for the device.
-b::
--raw-binary::
Print the raw Predictable latency per NVM set log buffer to stdout.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme primary-ctrl-caps' <device> [-o <format> | --output-format=<format>]
+'nvme primary-ctrl-caps' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
-
-H::
--human-readable::
This option will parse and format many of the bit fields
into human-readable formats.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Get Primary Ctrl Caps of the device in default format
[--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]
DESCRIPTION
-----------
OPTIONS
-------
---start-block=<slba>::
-s <slba>::
+--start-block=<slba>::
Start block.
---block-count::
-c::
+--block-count::
The number of blocks to transfer. This is a zeroes based value to
align with the kernel's use of this field. (ie. 0 means transfer
1 block).
---data-size=<size>::
-z <size>::
+--data-size=<size>::
Size of data, in bytes.
---metadata-size=<size>::
-y <size>::
+--metadata-size=<size>::
Size of metadata in bytes.
---data=<data-file>::
-d <data-file>::
+--data=<data-file>::
Data file. If none provided, contents are sent to STDOUT.
---metadata=<metadata-file>::
-M <metadata-file>::
+--metadata=<metadata-file>::
Metadata file, if necessary.
---prinfo=<prinfo>::
-p <prinfo>::
+--prinfo=<prinfo>::
Protection Information field definition.
+
[]
|0|Set to 1 enables checking the reference tag
|=================
---ref-tag=<reftag>::
-r <reftag>::
+--ref-tag=<reftag>::
Optional reftag when used with protection information.
---app-tag-mask=<appmask>::
-m <appmask>::
+--app-tag-mask=<appmask>::
Optional application tag mask when used with protection information.
---force-unit-access::
-f::
+--force-unit-access::
Set the force-unit access flag.
-T <type>::
Ignore namespace is currently busy and performed the operation
even though.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
SYNOPSIS
--------
[verse]
-'nvme reset' <device>
+'nvme reset' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
-None
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme resv-acquire' <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]
DESCRIPTION
-----------
--iekey::
Ignore Existing Key: If this bit is set to a '1', then the
Current Reservation Key (CRKEY) check is disabled and the command
- shall succeed regardless of the CRKEY field value.
+ shall succeed regardless of the CRKEY field value.
+
Indicator option, defaults to '0'.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet
NAME
----
nvme-resv-notif-log - Send NVMe Reservation Notification log page request,
- return result and log
+return result and log
SYNOPSIS
--------
[verse]
-'nvme resv-notif-log' <device> [--output-format=<fmt> | -o <fmt>]
+'nvme resv-notif-log' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme resv-register' <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]
DESCRIPTION
-----------
+
Indicator option, defaults to '0'.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet
--------
[verse]
'nvme resv-release' <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]
DESCRIPTION
-----------
+
Indicator option, defaults to '0'.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet
--------
[verse]
'nvme resv-report' <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]
DESCRIPTION
-----------
Print the raw buffer to stdout. Structure is not parsed by
program.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme rpmb' <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]
DESCRIPTION
-----------
nvme-rpmb without sending it to device. RPMB target 0 is used as the
default target if --target or -t is not specified. 0x0 is used as the
default address if no -address or -o option is specified,
-
+
-t <target>::
--target=<target>::
RPMB target id. This should be one of the supported RPMB targets as
The size in 512 byte sectors to be used for data transfer commands
(read or write) for a specified RPMB target.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Print RPMB support information of an NVMe device
NVME
----
Part of the nvme-user suite
-
SYNOPSIS
--------
[verse]
-'nvme sanitize-log' <device> [--rae | -r] [--output-format=<fmt> | -o <fmt>]
- [--human-readable | -H]
- [--raw-binary | -b]
+'nvme sanitize-log' <device> [--rae | -r] [--human-readable | -H]
+ [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
|Global Data Erased bit
If set to 1 then non-volatile storage in the NVM subsystem has
not been written to:
- a) since being manufactured and the NVM subsystem has never been sanitized; or
- b) since the most recent successful sanitize operation.
+ a) since being manufactured and the NVM subsystem has never been sanitized; or
+ b) since the most recent successful sanitize operation.
If cleared to 0, then non-volatile storage in the NVM subsystem has been written to:
- a) since being manufactured and the NVM subsystem has never been sanitized; or
- b) since the most recent successful sanitize operation of the NVM subsystem.
+ a) since being manufactured and the NVM subsystem has never been sanitized; or
+ b) since the most recent successful sanitize operation of the NVM subsystem.
|===
Sanitize Progress - percentage complete
--rae::
Retain an Asynchronous Event.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
-
-H::
--human-readable::
This option will parse and format many of the bit fields
Print the raw buffer to stdout. Structure is not parsed by
program. This overrides the vendor specific and human readable options.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Has the program issue Sanitize-log Command :
SYNOPSIS
--------
[verse]
-'nvme sanitize' <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]
+'nvme sanitize' <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]
DESCRIPTION
-----------
-------
-d::
--no-dealloc::
- No Deallocate After Sanitize:
- If set, then the controller shall not deallocate any logical
- blocks as a result of successfully completing the sanitize
- operation. If cleared, then the controller should deallocate
- logical blocks as a result of successfully completing the
- sanitize operation. This bit shall be ignored if the Sanitize
- Action field is set to 001b (i.e., Exit Failure Mode).
+ No Deallocate After Sanitize:
+ If set, then the controller shall not deallocate any logical
+ blocks as a result of successfully completing the sanitize
+ operation. If cleared, then the controller should deallocate
+ logical blocks as a result of successfully completing the
+ sanitize operation. This bit shall be ignored if the Sanitize
+ Action field is set to 001b (i.e., Exit Failure Mode).
-i::
--oipbp::
- Overwrite Invert Pattern Between Passes:
- If set, then the Overwrite Pattern shall be inverted between
- passes. If cleared, then the overwrite pattern shall not be
- inverted between passes. This bit shall be ignored unless the
- Sanitize Action field is set to 011b (i.e., Overwrite).
+ Overwrite Invert Pattern Between Passes:
+ If set, then the Overwrite Pattern shall be inverted between
+ passes. If cleared, then the overwrite pattern shall not be
+ inverted between passes. This bit shall be ignored unless the
+ Sanitize Action field is set to 011b (i.e., Overwrite).
-n <overwrite-pass-count>::
--owpass=<overwrite-pass-count>::
- Overwrite Pass Count:
- This field specifies the number of overwrite passes (i.e.,
- how many times the media is to be overwritten) using the data
- from the Overwrite Pattern field of this command. A value of 0
- specifies 16 overwrite passes. This field shall be ignored
- unless the Sanitize Action field is set to 011b (i.e., Overwrite).
+ Overwrite Pass Count:
+ This field specifies the number of overwrite passes (i.e.,
+ how many times the media is to be overwritten) using the data
+ from the Overwrite Pattern field of this command. A value of 0
+ specifies 16 overwrite passes. This field shall be ignored
+ unless the Sanitize Action field is set to 011b (i.e., Overwrite).
-u::
--ause::
- Allow Unrestricted Sanitize Exit:
- If set, then the sanitize operation is performed in unrestricted
- completion mode. If cleared then the sanitize operation is
- performed in restricted completion mode. This bit shall be ignored
- if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode).
+ Allow Unrestricted Sanitize Exit:
+ If set, then the sanitize operation is performed in unrestricted
+ completion mode. If cleared then the sanitize operation is
+ performed in restricted completion mode. This bit shall be ignored
+ if the Sanitize Action field is set to 001b (i.e., Exit Failure Mode).
-a <action>::
--sanact=<action>::
- Sanitize Action:
+ Sanitize Action:
+
[]
|=================
-p <overwrite-pattern>::
--ovrpat=<overwrite-pattern>::
- Overwrite Pattern:
- This field is ignored unless the Sanitize Action field in
- Command Dword 10 is set to 011b (i.e., Overwrite). This field
- specifies a 32-bit pattern that is used for the Overwrite
- sanitize operation.
+ Overwrite Pattern:
+ This field is ignored unless the Sanitize Action field in
+ Command Dword 10 is set to 011b (i.e., Overwrite). This field
+ specifies a 32-bit pattern that is used for the Overwrite
+ sanitize operation.
--force::
- Ignore namespace is currently busy and performed the operation
- even though.
+ Ignore namespace is currently busy and performed the operation
+ even though.
+
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
DESCRIPTION
-----------
-This command will only work on Seagate devices supporting this feature. Not
+This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.
The '<device>' may be either an NVMe character device (ex: /dev/nvme0) or an
-------
-s
--save::
- specifies that the controller shall save the attribute.
+ specifies that the controller shall save the attribute.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme seagate clear-pcie-correctable-errors [<device>] [OPTIONS]'
+'nvme seagate clear-pcie-correctable-errors [<device>] [OPTIONS]'
DESCRIPTION
-----------
-This command will only work on Seagate devices supporting this feature. Not
+This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.
The '<device>' parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0), or an
-------
-s::
--save::
- Specifies that the controller shall save the attribute
+ Specifies that the controller shall save the attribute
EXAMPLES
--------
DESCRIPTION
-----------
-This command will only work on Seagate devices supporting this feature. Not
+This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.
The '<device>'parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an
-------
-n <NUM>::
--namespace-id=<NUM>::
- Desired namespace
+ Desired namespace
-b::
--raw-binary::
- Output in raw format
+ Output in raw format
EXAMPLES
--------
DESCRIPTION
-----------
-This will only work on Seagate devices supporting this feature. Not all
+This will only work on Seagate devices supporting this feature. Not all
commands work across all product families.
-The '<device>' parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an
-nvme block device (ex: /dev/nvme0n1).
+The '<device>' parameter is mandatory and may be either an NVMe character device
+(ex: /dev/nvme0) or an block device (ex: /dev/nvme0n1).
OPTIONS
-------
-n <NUM>::
--namespace-id=<NUM>::
- desired namespace
+ desired namespace
-i <NUM>::
--log_specific=<NUM>::
- 1 - controller shall capture Data representing the internal state of the controller at the time the command is processed.
- 0 - controller shall not update the Telemetry Host Initiated Data.
+ 1 - controller shall capture Data representing the internal state of the
+ controller at the time the command is processed.
+ 0 - controller shall not update the Telemetry Host Initiated Data.
-b::
--raw-binary::
- output in raw format
+ output in raw format
EXAMPLES
--------
DESCRIPTION
-----------
-This command will only work on Seagate devices supporting this feature. Not
+This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.
The '<device>' may be either an NVMe character device (ex: /dev/nvme0) or an
-------
-n <NUM>::
--namespace-id=<NUM>::
- Desired namespace
+ Desired namespace
-f <FILE>::
--dump-file=<FILE>::
- Dump file
+ Dump file
EXAMPLES
--------
DESCRIPTION
-----------
-This command will only work on Seagate devices supporting this feature. Not
+This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.
-The '<device>' parameter is mandatory and may be either an NVMe character device (ex: /dev/nvme0) or an
-nvme block device (ex: /dev/nvme0n1).
+The '<device>' parameter is mandatory and may be either an NVMe character device
+(ex: /dev/nvme0) or an nvme block device (ex: /dev/nvme0n1).
OPTIONS
-------
-n <NUM>::
--namespace-id=<NUM>::
- Desired namespace
+ Desired namespace
-f <FILE>::
--dump-file=<FILE>::
- Dump file
+ Dump file
EXAMPLES
--------
-Get the Seagate vendor specific Controller-Initiated telemetry log for the specified device.
+Get the Seagate vendor specific Controller-Initiated telemetry log for the
+specified device.
------------
# nvme seagate vs-internal-log /dev/nvme0
DESCRIPTION
-----------
-This command will only work on Seagate devices supporting this feature. Not
+This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.
The '<device>' may be either an NVMe character device (ex: /dev/nvme0) or an
OPTIONS
-------
--o <FMT>::
---output-format=<FMT>::
- Output in binary format
+-o <fmt>::
+--output-format=<fmt>::
+ Output in binary format
EXAMPLES
--------
DESCRIPTION
-----------
-This command will only work on Seagate devices supporting this feature. Not
+This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.
The '<device>' parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an
OPTIONS
-------
--o <FMT>::
---output-format=<FMT>::
- Output in binary format
+-o <fmt>::
+--output-format=<fmt>::
+ Output in binary format
EXAMPLES
--------
Two logs exist, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM Supercap SMART log page)
-This command will only work on Seagate devices supporting this feature. Not
+This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.
OPTIONS
-------
-l <NUM>::
--log=<NUM>::
- Log number, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM
- Supercap SMART log page)
+ Log number, page 0xC4 (Extended SMART log page) and page 0xCF (DRAM
+ Supercap SMART log page)
-n <NUM>::
--namespace-id=<NUM>::
- Namespace number
+ Namespace number
-o <FILE>::
--output-file=<FILE>::
- Output in binary format. Defaults to text-formatted dump to stdout
+ Output in binary format. Defaults to text-formatted dump to stdout
EXAMPLES
--------
DESCRIPTION
-----------
-This command will only work on Seagate devices supporting this feature. Not
+This command will only work on Seagate devices supporting this feature. Not
all commands work across all product families.
The '<device>'parameter is mandatory and it may be either an NVMe character device (ex: /dev/nvme0) or an
OPTIONS
-------
--o <FMT>::
---output-format=<FMT>::
- Output in binary format
+-o <fmt>::
+--output-format=<fmt>::
+ Output in binary format
EXAMPLES
--------
--------
[verse]
'nvme security-recv' <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]
DESCRIPTION
-----------
--raw-binary::
Print the raw buffer to stdout. Defaults to print in hex.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No Examples
--------
[verse]
'nvme security-send' <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]
DESCRIPTION
-----------
Transfer Length: The value of this field is specific to the
Security Protocol as defined in SPC-4.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No Examples
--------
[verse]
'nvme self-test'-log <device> [--log-entries=<entries> | -e <entries>]
- [--output-format=<FMT> | -o <FMT>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
the device. This must be at least one, and shouldn't exceed the
20 entries. Defaults to 20 DST log entries.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme set-feature' <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]
DESCRIPTION
-----------
--uuid-index=<uuid-index>::
UUID Index of the feature
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
-* Sets the Power State (PS) to 1 in feature id 2:
+* Sets the Power State (PS) to 1 in feature id 2:
+
------------
# nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -V 0x1
--------
[verse]
'nvme set-property' <device> [--offset=<offset> | -O <offset>]
- [--value=<val> | -V <val>]
-
+ [--value=<val> | -V <val>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-------
-O::
--offset::
- The offset of the property.
+ The offset of the property.
-V::
--value:
The value of the property to be set.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples (yet).
SYNOPSIS
--------
[verse]
-'nvme show-hostnqn'
+'nvme show-hostnqn' [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-Show the host NQN configured for the system. If @SYSCONFDIR@/nvme/hostnqn is
+Show the host NQN configured for the system. If @SYSCONFDIR@/nvme/hostnqn is
not present and systemd application-specific machine IDs are available,
this will show the systemd-generated host NQN for the system.
OPTIONS
-------
-No options needed
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme show-regs' <device> [--human-readable | -H]
- [--output-format=<FMT> | -o <FMT>]
+'nvme show-regs' <device> [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
-------
-H::
--human-readable::
- Display registers or supported properties in human readable format.
+ Display registers or supported properties in human readable format.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme show-topology'
+'nvme show-topology' [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal' or 'json'. Only one output
format can be used at a time.
has only an effect for output format 'normal'. The JSON output is
always 'namespace' ordered.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
nvme show-topology
[verse]
'nvme smart-log' <device> [--namespace-id=<nsid> | -n <nsid>]
[--raw-binary | -b]
- [--output-format=<fmt> | -o <fmt>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--raw-binary::
Print the raw SMART log buffer to stdout.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
--------
[verse]
'nvme subsystem-reset' <device>
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
-None
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme supported-cap-config-log' <device> [--dom-id | -d ]
- [--output-format=<fmt> | -o <fmt>]
- [--raw-binary | -b]
+'nvme supported-cap-config-log' <device> [--dom-id | -d] [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
-
--o <format>::
---output-format=<format>::
- This option will set the reporting format to normal, json, or binary.
- Only one output format can be used at a time.
-
-d::
--dom-id::
- To get the domain ID.
+ To get the domain ID.
+
-b::
--raw-binary::
To show raw binary data.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples provided yet.
SYNOPSIS
--------
[verse]
-'nvme supported-log-pages' <device> [--output-format=<fmt> | -o <fmt>]
- [--verbose | -v]
+'nvme supported-log-pages' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- This option will set the reporting format to normal, json, or binary.
- Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
-v::
--verbose::
- 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.
EXAMPLES
--------
--------
[verse]
'nvme telemetry-log' <device> [--output-file=<file> | -O <file>]
- [--host-generate=<gen> | -g <gen>]
+ [--host-generate=<gen> | -g <gen>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
this option is not specified, the default value is 3, since data area
4 may not be supported.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
* Retrieve Telemetry Host-Initiated data to telemetry_log.bin
[verse]
'nvme toshiba clear-pcie-correctable-errors ' <device>
-
DESCRIPTION
-----------
For the NVMe device given, sends the Toshiba clear PCIe correctable errors
character device (ex: /dev/nvme0), or a namespace block device (ex:
/dev/nvme0n1).
-
EXAMPLES
--------
* Clear the PCIe correctable errors count:
OPTIONS
-------
-
-o <FILE>::
--output-file=<FILE>::
Output binary file. Defaults to text-formatted dump to stdout
-
-p::
--prev-log::
Use previous log contents. Defaults to the current log contents.
NAME
----
-nvme-toshiba-vs-smart-add-log - Retrieve a Toshiba device's vendor specific extended SMART log page contents and either save to file or dump the contents.
+nvme-toshiba-vs-smart-add-log - Retrieve a Toshiba device's vendor specific
+extended SMART log page contents and either save to file or dump the contents.
SYNOPSIS
--------
[--namespace-id=<NUM>, -n <NUM>]
[--output-file=<FILE>, -o <FILE>]
-
DESCRIPTION
-----------
For the NVMe device given, sends the Toshiba vendor log
character device (ex: /dev/nvme0), or a namespace block device (ex:
/dev/nvme0n1).
-The log contents may be associated with the controller, in which case the namespace parameter is ignored.
+The log contents may be associated with the controller, in which case the
+namespace parameter is ignored.
Two logs exist, page 0xC0 (log page directory) and page 0xCA (vendor log page)
-l <NUM>::
--log=<NUM>::
- Log page: 0xC0 or 0xCA (defaults to 0xCA)
+ Log page: 0xC0 or 0xCA (defaults to 0xCA)
-n <NUM>::
--namespace-id=<NUM>::
--output-file=<FILE>::
Output binary file. Defaults to text-formatted dump to stdout
-
-
EXAMPLES
--------
* Get the current log from the device and dumps it to stdout:
-------
none
-
EXAMPLES
--------
* Print the Transcend device's bad blocks in a human readable format:
NAME
----
-nvme-transcend-healthvalue - Use NVMe SMART table to analyze the health value of Transcend device.
+nvme-transcend-healthvalue - Use NVMe SMART table to analyze the health value of
+Transcend device.
SYNOPSIS
--------
DESCRIPTION
-----------
-Retrieves the NVMe Device SMART log page from the Transcend device and evaluate health status of Transcend device.
+Retrieves the NVMe Device SMART log page from the Transcend device and evaluate
+health status of Transcend device.
The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
-------
none
-
EXAMPLES
--------
* Print the Transcend Device health value in a human readable format:
--------
[verse]
'nvme-verify' <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]
DESCRIPTION
-----------
OPTIONS
-------
---namespace-id=<nsid>::
-n <nsid>::
+--namespace-id=<nsid>::
Namespace ID use in the command.
---start-block=<slba>::
-s <slba>::
+--start-block=<slba>::
Start block address.
---block-count=<nlb>::
-c <nlb>::
+--block-count=<nlb>::
Number of logical blocks to Verify.
---limited-retry::
-l::
+--limited-retry::
Sets the limited retry flag.
---force-unit-access::
-f::
+--force-unit-access::
Set the force-unit access flag.
---prinfo=<prinfo>::
-p <prinfo>::
+--prinfo=<prinfo>::
Protection Information field definition.
+
[]
|0|Set to 1 enables checking the reference tag
|=================
---ref-tag=<reftag>::
-r <reftag>::
+--ref-tag=<reftag>::
Optional reftag when used with protection information.
---app-tag-mask=<appmask>::
-m <appmask>::
+--app-tag-mask=<appmask>::
Optional application tag mask when used with protection information.
---app-tag=<apptag>::
-a <apptag>::
+--app-tag=<apptag>::
Optional application tag when used with protection information.
-S <storage-tag>::
--storage-tag-check::
This flag enables Storage Tag field checking as part of Verify operation.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
NAME
----
-nvme-virtium-save-smart-to-vtview-log - Periodically save smart attributes into a log file (csv format).
+nvme-virtium-save-smart-to-vtview-log - Periodically save smart attributes into
+a log file (csv format).
SYNOPSIS
--------
[--freq=<NUM> | -f <NUM>]
[--output-file=<FILE> | -o <FILE>]
[--test-name=<NAME> | -n <NAME>]
-
+
DESCRIPTION
-----------
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.
+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.
The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
-On success, the command generates a log file, which contains an entry for identify device
-(current features & settings) and periodic entries of SMART data.
+On success, the command generates a log file, which contains an entry for
+identify device (current features & settings) and periodic entries of SMART data.
-This command runs for the time specified by the option <run-time>, and collects SMART data
-at the frequency specified by the option <freq>. If the output file name is not specified,
-this command will generate a file name that include model string and serial number of the device.
+This command runs for the time specified by the option <run-time>, and collects
+SMART data at the frequency specified by the option <freq>. If the output file
+name is not specified, this command will generate a file name that include model
+string and serial number of the device.
-If the test-name option is specified, it will be recorded in the log file and be used as part
-of the log file name.
+If the test-name option is specified, it will be recorded in the log file and be
+used as part of the log file name.
OPTIONS
-------
-f <NUM>::
--freq=<NUM>::
- (optional) How often you want to log SMART data
- (0.25 = 15' , 0.5 = 30' , 1 = 1 hour, 2 = 2 hours, etc.). Default = 10 hours.
+ (optional) How often you want to log SMART data (0.25 = 15', 0.5 = 30',
+ 1 = 1 hour, 2 = 2 hours, etc.). Default = 10 hours.
-o <FILE>::
--output-file=<FILE>::
- (optional) Name of the log file (give it a name that easy for you to remember
- what the test is). You can leave it blank too, the file name will be generated
- as <model string>-<serial number>-<test name>.txt.
+ (optional) Name of the log file (give it a name that easy for you to
+ remember what the test is). You can leave it blank too, the file name
+ will be generated as <model string>-<serial number>-<test name>.txt.
-n <NAME>::
--test-name=<NAME>::
- (optional) Name of the test you are doing. We use this string as part of the name of the log file.
-
-
+ (optional) Name of the test you are doing. We use this string as part of
+ the name of the log file.
+
EXAMPLES
--------
* Temperature characterization:
--------
[verse]
'nvme virtium show-identify' <device>
-
+
DESCRIPTION
-----------
This command prints complete detail of the identify device information. The
OPTIONS
-------
none
-
-
+
EXAMPLES
--------
* Show Identify Device:
-s <SIZE>::
--transfer-size=<SIZE>::
- Transfer size; defaults to 0x10000 (65536 decimal) bytes
+ Transfer size; defaults to 0x10000 (65536 decimal) bytes
EXAMPLES
--------
# nvme wdc clear-assert-dump /dev/nvme0
------------
-
NVME
----
Part of the nvme-user suite
# nvme wdc clear-fw-activate-history /dev/nvme0
------------
-
NVME
----
Part of the nvme-user suite
# nvme wdc clear-pcie-correctable-errors /dev/nvme0
------------
-
NVME
----
Part of the nvme-user suite
NAME
----
-nvme-wdc-drive-essentials - Retrieve WDC device's drive essentials bin files and save to a tar file.
+nvme-wdc-drive-essentials - Retrieve WDC device's drive essentials bin files and
+save to a tar file.
SYNOPSIS
--------
DESCRIPTION
-----------
-For the NVMe device given, captures the drive essential bin files and saves them into a tar file.
-The tar file will be in the following format: DRIVE_ESSENTIALS_<Serial Num>_<FW Revision>_<Date>_<Time>.tar.gz
- e.g. DRIVE_ESSENTIALS_A00FD8CA_1048_20170713_091731.tar.gz
+For the NVMe device given, captures the drive essential bin files and saves them
+into a tar file. The tar file will be in the following format:
+DRIVE_ESSENTIALS_<Serial Num>_<FW Revision>_<Date>_<Time>.tar.gz
+ e.g. DRIVE_ESSENTIALS_A00FD8CA_1048_20170713_091731.tar.gz
The <device> parameter is mandatory; NVMe character device (ex: /dev/nvme0).
--output-file=<FILE>::
Output file; defaults to device serial number followed by "drive_log" suffix
-
EXAMPLES
--------
* Gets the drive log from the device and saves to default file in current directory (e.g. STM00019F3F9drive_log.bin):
NAME
----
-nvme-wdc-enc-get-log - Send NVMe WDC enc-get-log Vendor Unique Command, return result.
+nvme-wdc-enc-get-log - Send NVMe WDC enc-get-log Vendor Unique Command, return
+result.
SYNOPSIS
--------
[verse]
-'nvme wdc enc-get-log' <device> [--log-id=<NUM>, -l <NUM>] [--output-file=<FILE>, -o <FILE>] [--transfer-size=<SIZE>, -s <SIZE>]
+'nvme wdc enc-get-log' <device> [--log-id=<NUM>, -l <NUM>]
+ [--output-file=<FILE>, -o <FILE>]
+ [--transfer-size=<SIZE>, -s <SIZE>]
DESCRIPTION
-----------
The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0).
-The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2, 0xd3, 0xd4, 0xe2 and 0xe4.
+The --log-id=<NUM>, -l <NUM> parameter is mandatory and may be either 0xd1, 0xd2,
+0xd3, 0xd4, 0xe2 and 0xe4.
This will only work on WDC devices supporting this feature.
Results for any other device are undefined.
-------
-o <FILE>::
--output-file=<FILE>::
- Output file pathname
+ Output file pathname
-s <SIZE>::
--transfer-size=<NUM>::
- Data retrieval transfer size, maximum transfer size should be 0x2000 (decimal 8192)
+ Data retrieval transfer size, maximum transfer size should be 0x2000
+ (decimal 8192)
EXAMPLES
--------
-* 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:
+* 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:
+
------------
# nvme wdc enc-get-log /dev/nvme0 -l 0xd1 -o d1_log.bin -s 0x2000
NAME
----
nvme-wdc-get-dev-capabilities-log - Send NVMe WDC get-dev-capabilities-log
- plugin command, return parsed log output
+plugin command, return parsed log output
SYNOPSIS
--------
[verse]
-'nvme wdc get-dev-capabilities-log' <device> [--output-format=<normal|json>
--o <normal|json>]
+'nvme wdc get-dev-capabilities-log' <device> [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', or
'json'. Only one output format can be used at a time.
Default is normal.
NAME
----
-nvme-wdc-get-drive-status - Send the NVMe WDC get-drive-status command, return result
+nvme-wdc-get-drive-status - Send the NVMe WDC get-drive-status command, return
+result
SYNOPSIS
--------
|The percentage of drive function used.
|*EOL (End of Life) Status*
-|The 3 possible states are : Normal, Read Only, or End of Life.
+|The 3 possible states are : Normal, Read Only, or End of Life.
|*Assert Dump Status*
-|The 2 possible states are : Present or Not Present.
+|The 2 possible states are : Present or Not Present.
|*Thermal Throttling Status*
-|The 3 possible states are : Off, On, or Unavailable.
+|The 3 possible states are : Off, On, or Unavailable.
|*Format Corrupt Reason*
-|The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.
+|The 3 possible states are : Not Corrupted, Corrupt due to FW Assert, or Corrupt for Unknown Reason.
|===
-
EXAMPLES
--------
* Has the program issue WDC get-drive-status command :
NAME
----
nvme-wdc-get-error-recovery-log - Send NVMe WDC get-error-recovery-log plugin
- command, return parsed log output
+command, return parsed log output
SYNOPSIS
--------
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', or
'json'. Only one output format can be used at a time.
Default is normal.
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal' or 'json'. Only one output format
can be used at a time. The default is normal.
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', or
'json'. Only one output format can be used at a time.
Default is normal.
SYNOPSIS
--------
[verse]
-'nvme wdc id-ctrl' <device> [-v | --vendor-specific] [-b | --raw-binary]
- [-H | --human-readable]
- [-o <fmt> | --output-format=<fmt>]
+'nvme wdc id-ctrl' <device> [--vendor-specific | -v] [--raw-binary | -b]
+ [--human-readable | -H]
+ [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
This option will parse and format many of the bit fields
into human-readable formats.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
EXAMPLES
--------
DESCRIPTION
-----------
For the NVMe device given, retrieves the log page directory which contains the list of
-log page IDs supported by the drive. The --output-format option will format the output as
+log page IDs supported by the drive. The --output-format option will format the output as
specified.
The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', 'json', or 'binary'. Only one output format
can be used at a time. The default is normal.
SYNOPSIS
--------
[verse]
-'nvme wdc namespace-resize' <device> [--nsid=<NAMSPACE ID>, -n <NAMSPACE ID>] [--op_option=<OP OPTION>, -o <OP OPTION>]
+'nvme wdc namespace-resize' <device> [--nsid=<NAMSPACE ID>, -n <NAMSPACE ID>]
+ [--op_option=<OP OPTION>, -o <OP OPTION>]
DESCRIPTION
-----------
-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.
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
-o <OP OPTION>::
--op-option=<OP OPTION>::
- 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
+ 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
EXAMPLES
--------
|Purge State Error : Purge operation interrupted by power cycle or reset.
|===
-
The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
--------
[verse]
'nvme wdc set-latency-monitor-feature' <device>
- [--active_bucket_timer_threshold=<NUM> | -t <NUM>]
- [--active_threshold_a=<NUM> | -a <NUM>]
- [--active_threshold_b=<NUM> | -b <NUM>]
- [--active_threshold_c=<NUM> | -c <NUM>]
- [--active_threshold_d=<NUM> | -d <NUM>]
- [--active_latency_config=<NUM> | -f <NUM>]
- [--active_latency_minimum_window=<NUM> | -w <NUM>]
- [--debug_log_trigger_enable=<NUM> | -r <NUM>]
- [--discard_debug_log=<NUM> | -l <NUM>]
- [--latency_monitor_feature_enable=<NUM> | -e <NUM>]
+ [--active_bucket_timer_threshold=<NUM> | -t <NUM>]
+ [--active_threshold_a=<NUM> | -a <NUM>]
+ [--active_threshold_b=<NUM> | -b <NUM>]
+ [--active_threshold_c=<NUM> | -c <NUM>]
+ [--active_threshold_d=<NUM> | -d <NUM>]
+ [--active_latency_config=<NUM> | -f <NUM>]
+ [--active_latency_minimum_window=<NUM> | -w <NUM>]
+ [--debug_log_trigger_enable=<NUM> | -r <NUM>]
+ [--discard_debug_log=<NUM> | -l <NUM>]
+ [--latency_monitor_feature_enable=<NUM> | -e <NUM>]
DESCRIPTION
-----------
-------
-t <NUM>::
--active_bucket_timer_threshold=<NUM>::
- The value that loads the Active Bucket Timer Threshold; default value is 07E0h.
+ The value that loads the Active Bucket Timer Threshold; default value is 07E0h.
-a <NUM>::
--active_threshold_a=<NUM>::
- The value that loads into the Active Threshold A; default value is 05h.
+ The value that loads into the Active Threshold A; default value is 05h.
-b <NUM>::
--active_threshold_b=<NUM>::
- The value that loads into the Active Threshold B; default value is 13h.
+ The value that loads into the Active Threshold B; default value is 13h.
-c <NUM>::
--active_threshold_c=<NUM>::
- The value that loads into the Active Threshold C; default value is 1Eh.
+ The value that loads into the Active Threshold C; default value is 1Eh.
-d <NUM>::
--active_threshold_d=<NUM>::
- The value that loads into the Active Threshold D; default value is 2Eh.
+ The value that loads into the Active Threshold D; default value is 2Eh.
-f <NUM>::
--active_latency_config=<NUM>::
- The value that loads into the Active Latency Configuration. This configures how both the Active
- Latency Stamp, and the Active Measured Latency Fields are updated on a per I/O command (Read,
- Write, Deallocate) counter basis; default value is 0FFFh.
+ The value that loads into the Active Latency Configuration. This
+ configures how both the Active Latency Stamp, and the Active Measured
+ Latency Fields are updated on a per I/O command (Read, Write, Deallocate)
+ counter basis; default value is 0FFFh.
-w <NUM>::
--active_latency_minimum_window=<NUM>::
- The value that loads into the Active Latency Minimum Window; default value is 0Ah.
+ The value that loads into the Active Latency Minimum Window; default value is 0Ah.
-r <NUM>::
--debug_log_trigger_enable=<NUM>::
- The value that loads into the Debug Log Trigger Enable; When set to 1b the first time the
- bucket/counter combination is incremented a debug log is triggered. When cleared to 0b a
- debug log will not be triggered when the bucket/counter combination is incremented.
+ The value that loads into the Debug Log Trigger Enable; When set to 1b
+ the first time the bucket/counter combination is incremented a debug log
+ is triggered. When cleared to 0b a debug log will not be triggered when
+ the bucket/counter combination is incremented.
-l <NUM>::
--discard_debug_log=<NUM>::
- Discard Debug Log. When cleared to 00h the debug log, if it exists, will not be cleared.
- When set to 01h the debug log will be discarded so another log can be triggered. All the fields in
- the Set Features Data structure are valid. When set to 02h the debug log will be discarded so
- another log can be triggered. None of the other fields of the Set Features Data structure are valid.
+ Discard Debug Log. When cleared to 00h the debug log, if it exists, will
+ not be cleared. When set to 01h the debug log will be discarded so
+ another log can be triggered. All the fields in the Set Features Data
+ structure are valid. When set to 02h the debug log will be discarded so
+ another log can be triggered. None of the other fields of the Set
+ Features Data structure are valid.
-e <NUM>::
--latency_monitor_feature_enable=<NUM>::
- Latency Monitor Feature Enable; When set to 01h the Latency Monitor Feature is
- enabled. When cleared to 00h the Latency Monitor Feature is disabled.
+ Latency Monitor Feature Enable; When set to 01h the Latency Monitor
+ Feature is enabled. When cleared to 00h the Latency Monitor Feature is
+ disabled.
EXAMPLES
--------
NVME
----
-Part of the nvme-user suite.
\ No newline at end of file
+Part of the nvme-user suite.
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', or
'json'. Only one output format can be used at a time.
Default is normal.
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', or
'json'. Only one output format can be used at a time.
Default is normal.
TCG Device Ownership
-
EXAMPLE
--------
# nvme wdc vs-drive-info /dev/nvme0
-
NVME
----
Part of the nvme-user suite.
DESCRIPTION
-----------
For the NVMe device given, retrieve the telemetry log error reason id field for either the host generated or
-controller initiated log. The controller initiated telemetry log page option must be enabled to retrieve the
-error reason id for that log page id.
+controller initiated log. The controller initiated telemetry log page option must be enabled to retrieve the
+error reason id for that log page id.
The <device> parameter is mandatory and must be the NVMe character device (ex: /dev/nvme0).
-------
-i <id>::
--log-id=<id>::
- Specifies the telemetry log id of the error reason identifier to retrieve.
+ Specifies the telemetry log id of the error reason identifier to retrieve.
Use id 7 for the host generated log page.
Use id 8 for the controller initiated log page.
The default is 7/host generated
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', or
'json'. Only one output format can be used at a time.
Default is normal.
-
Firmware Activate History Log Page Data Output Explanation
-----------------------------------------------------------
[cols="2*", frame="topbot", align="center", options="header"]
|Field |Description
|*Entry Number*
-|The number of fw activate entry. The most recent 20 entries will be displayed.
+|The number of fw activate entry. The most recent 20 entries will be displayed.
|*Power on Hour*
|The time since the power on in hours:minutes:seconds.
|The commit action type associated with the firmware activation event
|*Result*
-|The result of the firmware activation event. The output shall be in the format:
+|The result of the firmware activation event. The output shall be in the format:
Pass or Failed + error code
|===
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', or
'json'. Only one output format can be used at a time.
Default is normal.
SYNOPSIS
--------
[verse]
-'nvme wdc vs-internal-log' <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]
+'nvme wdc vs-internal-log' <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]
DESCRIPTION
-----------
-For the NVMe device given, sends the WDC Vendor Specific Internal Log request and saves
-the result to a file.
+For the NVMe device given, sends the WDC Vendor Specific Internal Log request
+and saves the result to a file.
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
-------
-o <FILE>::
--output-file=<FILE>::
- Output file; defaults to device serial number followed by "_internal_fw_log_<date>_<time>.bin" suffix
+ Output file; defaults to device serial number followed by
+ "_internal_fw_log_<date>_<time>.bin" suffix
-s <SIZE>::
--transfer-size=<SIZE>::
- Transfer size; defaults to 0x10000 (65536 decimal) bytes
+ Transfer size; defaults to 0x10000 (65536 decimal) bytes
-d <DATA AREA>::
--data-area=<DATA AREA>::
- DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will be retrieved. This parameter
- is currently only supported on the SN340, SN640, SN730, and SN840 devices.
+ DUI data area to retrieve. The DUI data areas from 1 to <DATA AREA> will
+ be retrieved. This parameter is currently only supported on the SN340,
+ SN640, SN730, and SN840 devices.
-f <FILE SIZE>::
--file-size=<FILE SIZE>::
- Specifies the desired size of the data file starting at the passed in offset. This allows the user to
- retrieve the data in several smaller files of the passed in size. This parameter is currently only
- supported on the SN340 device.
+ Specifies the desired size of the data file starting at the passed in
+ offset. This allows the user to retrieve the data in several smaller
+ files of the passed in size. This parameter is currently only supported
+ on the SN340 device.
-e <OFFSET>::
--offset=<OFFSET>::
- Specifies the data offset at which to start retrieving the data. This parameter is used in combination
- with the file size parameter to retrieve the data in several smaller files. This parameter is currently
- only supported on the SN340 device.
+ Specifies the data offset at which to start retrieving the data. This
+ parameter is used in combination with the file size parameter to
+ retrieve the data in several smaller files. This parameter is currently
+ only supported on the SN340 device.
-t <TYPE>::
--type=<TYPE>::
- Specifies the telemetry type - NONE, HOST, or CONTROLLER. This parameter is used to get either the host
- generated or controller initiated telemetry log page. If not specified or none is specified, the command
- will return the default E6 log data. This parameter is currently only supported on the SN640 and SN840
- devices.
+ Specifies the telemetry type - NONE, HOST, or CONTROLLER. This parameter
+ is used to get either the host generated or controller initiated
+ telemetry log page. If not specified or none is specified, the command
+ will return the default E6 log data. This parameter is currently only
+ supported on the SN640 and SN840 devices.
-v <VERBOSE>::
--verbose=<VERBOSE>::
OPTIONS
-------
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', or
'json'. Only one output format can be used at a time.
Default is normal.
NAME
----
-nvme-wdc-vs-smart-add-log - Send NVMe WDC vs-smart-add-log Vendor Unique Command, return result
+nvme-wdc-vs-smart-add-log - Send NVMe WDC vs-smart-add-log Vendor Unique Command,
+return result
SYNOPSIS
--------
-------
-i <NUM>::
--interval=<NUM>::
- 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.
+ 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.
--o <format>::
---output-format=<format>::
+-o <fmt>::
+--output-format=<fmt>::
Set the reporting format to 'normal', or
'json'. Only one output format can be used at a time.
Default is normal.
-l <NUM>::
--log-page-version=<NUM>::
- Log Page Version: 0 = vendor, 1 = WDC. This parameter is only valid for the 0xC0 log page and ignored for all
- other log pages.
+ Log Page Version: 0 = vendor, 1 = WDC. This parameter is only valid for
+ the 0xC0 log page and ignored for all other log pages.
-p <LIST>::
--log-page-mask=<LIST>::
- Supply a comma separated list of desired log pages to display.
- The possible values are 0xc0, 0xc1, 0xca, 0xd0.
- Note: Not all pages are supported on all drives.
- The default is to display all supported log pages.
+ Supply a comma separated list of desired log pages to display.
+ The possible values are 0xc0, 0xc1, 0xca, 0xd0.
+ Note: Not all pages are supported on all drives.
+ The default is to display all supported log pages.
-n <nsid>::
--namespace-id=<nsid>::
|The statistical set accumulated during the entire lifetime of the device.
|===
-
EXAMPLES
--------
* Has the program issue WDC vs-smart-add-log Vendor Unique Command with default interval (14) :
NAME
----
-nvme-wdc-vs-telemetry-controller-option - Disable/Enable the controller initiated option of the telemetry log page.
+nvme-wdc-vs-telemetry-controller-option - Disable/Enable the controller
+initiated option of the telemetry log page.
SYNOPSIS
--------
[verse]
-'nvme wdc vs-telemetry-controller-option' <device> [--disable, -d] [--enable, -e]
- [--status, -s]
+'nvme wdc vs-telemetry-controller-option' <device>
+ [--disable, -d] [--enable, -e] [--status, -s]
DESCRIPTION
-----------
-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.
The <device> parameter is mandatory NVMe character device (ex: /dev/nvme0).
-s::
--status::
- Returns the current status (enabled or disabled) of the controller initiated option of the telemetry log page.
-
+ Returns the current status (enabled or disabled) of the controller
+ initiated option of the telemetry log page.
EXAMPLES
--------
[--namespace-id=<nsid> | -n <nsid>]
[--dir-type=<dtype> | -T <dtype>]
[--dir-spec=<dspec> | -S <dspec>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
OPTIONS
-------
---start-block=<slba>::
-s <slba>::
+--start-block=<slba>::
Start block.
---block-count=<nlb>::
-c::
+--block-count=<nlb>::
Number of logical blocks to write uncorrectable.
---namespace-id=<nsid>::
-n <nsid>::
+--namespace-id=<nsid>::
Namespace ID use in the command.
-T <dtype>::
--dir-spec=<dspec>::
Directive specific
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
[--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]
DESCRIPTION
-----------
OPTIONS
-------
---start-block=<slba>::
-s <slba>::
+--start-block=<slba>::
Start block.
---block-count=<nlb>::
-c <nlb>::
+--block-count=<nlb>::
Number of logical blocks to write zeroes.
---prinfo=<prinfo>::
-p <prinfo>::
+--prinfo=<prinfo>::
Protection Information field definition.
+
[]
|0|Set to 1 enables checking the reference tag
|=================
---ref-tag=<reftag>::
-r <reftag>::
+--ref-tag=<reftag>::
Optional reftag when used with protection information.
---app-tag-mask=<appmask>::
-m <appmask>::
+--app-tag-mask=<appmask>::
Optional application tag mask when used with protection information.
---app-tag=<apptag>::
-a <apptag>::
+--app-tag=<apptag>::
Optional application tag when used with protection information.
---limited-retry::
-l::
+--limited-retry::
Sets the limited retry flag.
---deac::
-d::
+--deac::
Sets the DEAC bit, requesting controller deallocate the logical blocks.
---force-unit-access::
-f::
+--force-unit-access::
Set the force-unit access flag.
---namespace-id=<nsid>::
-n <nsid>::
+--namespace-id=<nsid>::
Namespace ID use in the command.
---storage-tag=<storage-tag>::
-S <storage-tag>::
+--storage-tag=<storage-tag>::
Variable Sized Logical Block Storage Tag(LBST).
---storage-tag-check=<storage-tag-check>::
-C <storage-tag-check>::
+--storage-tag-check=<storage-tag-check>::
This bit specifies the Storage Tag field shall be checked as part of end-to-end
data protection processing.
--dir-spec=<dspec>::
Directive specific
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
EXAMPLES
--------
No examples yet.
[--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]
DESCRIPTION
-----------
OPTIONS
-------
---start-block=<slba>::
-s <slba>::
+--start-block=<slba>::
Start block.
---block-count::
-c::
+--block-count::
The number of blocks to transfer. This is a zeroes based value to
align with the kernel's use of this field. (ie. 0 means transfer
1 block).
---data-size=<size>::
-z <size>::
+--data-size=<size>::
Size of data, in bytes.
---metadata-size=<size>::
-y <size>::
+--metadata-size=<size>::
Size of metadata in bytes.
---data=<data-file>::
-d <data-file>::
+--data=<data-file>::
Data file. If none provided, contents are sent from STDIN.
---metadata=<metadata-file>::
-M <metadata-file>::
+--metadata=<metadata-file>::
Metadata file, if necessary.
---prinfo=<prinfo>::
-p <prinfo>::
+--prinfo=<prinfo>::
Protection Information field definition.
+
[]
|0|Set to 1 enables checking the reference tag
|=================
---ref-tag=<reftag>::
-r <reftag>::
+--ref-tag=<reftag>::
Optional reftag when used with protection information.
---app-tag-mask=<appmask>::
-m <appmask>::
+--app-tag-mask=<appmask>::
Optional application tag mask when used with protection information.
---app-tag=<apptag>::
-a <apptag>::
+--app-tag=<apptag>::
Optional application tag when used with protection information.
---limited-retry::
-l::
+--limited-retry::
Sets the limited retry flag.
---force-unit-access::
-f::
+--force-unit-access::
Set the force-unit access flag.
-T <type>::
data protection processing.
--force::
- Ignore namespace is currently busy and performed the operation
- even though.
+ Ignore namespace is currently busy and performed the operation
+ even though.
+
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
EXAMPLES
--------
SYNOPSIS
--------
[verse]
-'nvme zns changed-zone-list' <device> [-o <fmt> | --output-format=<fmt>]
- [--namespace-id=<NUM> | -n <NUM>]
- [--rae | -r]
+'nvme zns changed-zone-list' <device> [--output-format=<fmt> | -o <fmt>]
+ [--namespace-id=<NUM> | -n <NUM>] [--rae | -r]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
-r::
--rae::
NAME
----
nvme-zns-id-ctrl - Send NVMe Zoned Command Set Identify Controller, return
- result and structure
+result and structure
SYNOPSIS
--------
[verse]
-'nvme zns id-ctrl' <device> [-o <fmt> | --output-format=<fmt>]
+'nvme zns id-ctrl' <device> [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
OPTIONS
-------
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
EXAMPLES
--------
NAME
----
-nvme-zns-id-ns - Send NVMe Zoned Command Set Identify namespace, return
- result and structure
+nvme-zns-id-ns - Send NVMe Zoned Command Set Identify namespace, return result
+and structure
SYNOPSIS
--------
[verse]
-'nvme zns id-ns' <device> [--namespace-id=<NUM> | -n <NUM>]
- [-o <fmt> | --output-format=<fmt>]
- [-v | --verbose]
+'nvme zns id-ns' <device> [--namespace-id=<NUM> | -n <NUM>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
-----------
--verbose::
Increase the information detail in the output.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
EXAMPLES
--------
--------
[verse]
'nvme zns open-zone' <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>]
DESCRIPTION
-----------
[--extended | -e]
[--partial | -p]
[--verbose | -v]
- [--output-format=<FMT> | -o <FMT>]
+ [--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
--verbose::
Increase the information detail in the output.
--o <format>::
---output-format=<format>::
- Set the reporting format to 'normal', 'json', or
- 'binary'. Only one output format can be used at a time.
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
EXAMPLES
--------
--------
[verse]
'nvme zns reset-zone' <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>]
DESCRIPTION
-----------
--------
[verse]
'nvme zns set-zone-desc' <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>]
DESCRIPTION
-----------
--zrwaa::
Allocate Zone Random Write Area to zone.
--d <FILE::
--data=<FILE>::
+-d <FILE>::
+--data=<FILE>::
Optional file for data (default stdin)
-t <timeout>::
--------
[verse]
'nvme zns zone-mgmt-recv' <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>]
DESCRIPTION
-----------
--start-lba=<lba>::
The starting LBA of the zone to manage receive.
---data-len=<NUM>
-l <NUM>
+--data-len=<NUM>
Received data buffer length
-z <NUM>::
--zra-spec-feat::
Enable Zone Receive Action Specific features
--o <FMT>::
---output-format=<FMT>::
+-o <fmt>::
+--output-format=<fmt>::
Output format: normal|json|binary
EXAMPLES
--------
[verse]
'nvme zns zone-mgmt-send' <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>]
DESCRIPTION
-----------
--zsaso::
Zone Send Action Specific Option
---select-all::
-a::
+--select-all::
Send command to all zones
-z <NUM>::
--data-len=<IONUM>::
Buffer length if data required
--d <FILE::
+-d <FILE>::
--data=<FILE>::
Optional file for data (default stdin)
--------
[verse]
'nvme zns zrwa-flush-zone' <device> [--namespace-id=<NUM> | -n <NUM>]
- [--lba=<LBA> | -l <LBA>]
- [--timeout=<timeout> | -t <timeout> ]
+ [--lba=<LBA> | -l <LBA>]
+ [--timeout=<timeout> | -t <timeout>]
DESCRIPTION
-----------
projects / users / sagi / nvme-cli.git / commitdiff