SYNOPSIS
--------
[verse]
-'nvme-admin-passthru' <device> [--opcode=<opcode> | -o <opcode>]
+'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>]
OPTIONS
-------
--o <opcode>::
+-O <opcode>::
--opcode=<opcode>::
The NVMe opcode to send to the device in the command
SYNOPSIS
--------
[verse]
-'nvme capacity-mgmt' <device> [--operation=<operation> | -o <operation>]
+'nvme capacity-mgmt' <device> [--operation=<operation> | -O <operation>]
[--element-id=<element-id> | -i <element-id>]
[--cap-lower=<cap-lower> | -l <cap-lower>]
[--cap-upper=<cap-upper> | -u <cap-upper>]
OPTIONS
-------
--o <operation>::
+-O <operation>::
--operation=<operation>::
Operation to be performed by the controller
[--dir-type=<type> | -T <type>]
[--dir-spec=<spec> | -S <spec>]
[--dsm=<dsm> | -D <dsm>]
- [--show-command | -v]
+ [--show-command | -V]
[--dry-run | -w]
[--latency | -t]
[--storage-tag<storage-tag> | -g <storage-tag>]
among other things, as well as yet to be defined types. Please
consult the NVMe specification for detailed breakdown of how to
use this field.
--v::
+-V::
--show-cmd::
Print out the command to be sent.
[--ncap-si=<ncap-si> | -C <ncap-si>]
[--azr | -z]
[--rar=<rar> | -r <rar>]
- [--ror=<ror> | -o <ror>]
+ [--ror=<ror> | -O <ror>]
[--rnumzrwa=<rnumzrwa> | -u <rnumzrwa>]
[--phndls=<placement-handle-list,> | -p <placement-handle-list,>]
Requested Active Resources. This field specifies the number of active
resources to be allocated to the created namespace.
--o <ror>::
+-O <ror>::
--ror=<ror>::
Requested Open Resources. This field specifies the number of open resources
to be allocated to the created namespace.
[verse]
'nvme fw-download' <device> [--fw=<firmware-file> | -f <firmware-file>]
[--xfer=<transfer-size> | -x <transfer-size>]
- [--offset=<offset> | -o <offset>]
+ [--offset=<offset> | -O <offset>]
DESCRIPTION
-----------
the device has a max transfer size requirement for firmware. It
defaults to 4k.
--o <offset>::
+-O <offset>::
--offset=<offset>::
This specifies the starting offset in dwords. This is really only
useful if your firmware is split in multiple files; otherwise
[--aen=<aen> | -a <aen>]
[--namespace-id=<nsid> | -n <nsid>]
[--raw-binary | -b]
- [--lpo=<offset> | -o <offset>]
+ [--lpo=<offset> | -L <offset>]
[--lsp=<field> | -s <field>]
[--lsi=<field> | -S <field>]
[--rae | -r]
--raw-binary::
Print the raw log buffer to stdout.
--o <offset>::
+-L <offset>::
--lpo=<offset>::
The log page offset specifies the location within a log page to start
returning data from. It's Dword-aligned and 64-bits.
SYNOPSIS
--------
[verse]
-'nvme get-property' <device> [--offset=<offset> | -o <offset>]
+'nvme get-property' <device> [--offset=<offset> | -O <offset>]
[--human-readable | -H ]
OPTIONS
-------
--o::
+-O::
--offset::
The offset of the property. One of CAP=0x0, VS=0x8, CC=0x14, CSTS=0x1c, NSSR=0x20
SYNOPSIS
--------
[verse]
-'nvme id-ctrl' <device> [-v | --vendor-specific] [-b | --raw-binary]
+'nvme id-ctrl' <device> [-V | --vendor-specific] [-b | --raw-binary]
[-o <fmt> | --output-format=<fmt>]
DESCRIPTION
Print the raw buffer to stdout. Structure is not parsed by
program. This overrides the vendor specific and human readable options.
--v::
+-V::
--vendor-specific::
In addition to parsing known fields, this option will dump
the vendor specific region of the structure in hex with ascii
+
------------
# nvme id-ctrl /dev/nvme0 --vendor-specific
-# nvme id-ctrl /dev/nvme0 -v
+# nvme id-ctrl /dev/nvme0 -V
------------
+
The above will dump the 'vs' buffer in hex since it doesn't know how to
SYNOPSIS
--------
[verse]
-'nvme id-ns' <device> [-v | --vendor-specific] [-b | --raw-binary]
+'nvme id-ns' <device> [-V | --vendor-specific] [-b | --raw-binary]
[--namespace-id=<nsid> | -n <nsid>] [--force]
[--human-readable | -H]
[--output-format=<fmt> | -o <fmt>]
Print the raw buffer to stdout. Structure is not parsed by
program. This overrides the vendor specific and human readable options.
--v::
+-V::
--vendor-specific::
In addition to parsing known fields, this option will dump
the vendor specific region of the structure in hex with ascii
+
------------
# nvme id-ns /dev/nvme0n1 --vendor-specific
-# nvme id-ns /dev/nvme0n1 -v
+# nvme id-ns /dev/nvme0n1 -V
------------
+
The above will dump the \'vs' buffer in hex since it doesn't know how to
SYNOPSIS
--------
[verse]
-'nvme-io-passthru' <device> [--opcode=<opcode> | -o <opcode>]
+'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>]
OPTIONS
-------
--o <opcode>::
+-O <opcode>::
--opcode=<opcode>::
The NVMe opcode to send to the device in the command
SYNOPSIS
--------
[verse]
-'nvme-lockdown' <device> [--ofi=<ofi> | -o <ofi>]
+'nvme-lockdown' <device> [--ofi=<ofi> | -O <ofi>]
[--ifc=<ifc> | -f <ifc>]
[--prhbt=<prhbt> | -p <prhbt>]
[--scp=<scp> | -s <scp>]
OPTIONS
-------
--ofi=<ofi>::
--o <ofi>::
+-O <ofi>::
Opcode or Feature Identifier(OFI) specifies the command opcode or Set
Features Feature Identifier identified by the Scope field.
SYNOPSIS
--------
[verse]
-'nvme nvme-mi-recv' <device> [--opcode=<opcode> | -o <opcode>]
- [--namespace-id=<nsid>]
+'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>]
OPTIONS
-------
--o <opcode>::
+-O <opcode>::
--opcode=<opcode>::
The NVMe-MI opcode to send to the device in the command
* Has the program issue a nvme-mi-recv to execute the VPD read.
+
------------
-# nvme nvme-mi-recv /dev/nvme0n1 -o 5 -m 1 -0 0 -1 0x100 -l 256
+# nvme nvme-mi-recv /dev/nvme0n1 -O 5 -m 1 -0 0 -1 0x100 -l 256
------------
NVME
SYNOPSIS
--------
[verse]
-'nvme nvme-mi-send' <device> [--opcode=<opcode> | -o <opcode>]
- [--namespace-id=<nsid>]
+'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>]
OPTIONS
-------
--o <opcode>::
+-O <opcode>::
--opcode=<opcode>::
The NVMe-MI opcode to send to the device in the command
* Has the program issue a nvme-mi-send to execute the VPD write.
+
------------
-# nvme nvme-mi-send /dev/nvme0n1 -o 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin
+# nvme nvme-mi-send /dev/nvme0n1 -O 6 -m 1 -0 0 -1 0x100 -l 256 -i vpd.bin
------------
NVME
[--dir-type=<type> | -T <type>]
[--dir-spec=<spec> | -S <spec>]
[--dsm=<dsm> | -D <dsm>]
- [--show-command | -v]
+ [--show-command | -V]
[--dry-run | -w]
[--latency | -t]
[--storage-tag<storage-tag> | -g <storage-tag>]
consult the NVMe specification for detailed breakdown of how to
use this field.
--v::
+-V::
--show-cmd::
Print out the command to be sent.
--------
[verse]
'nvme set-feature' <device> [--namespace-id=<nsid> | -n <nsid>]
- [--feature-id=<fid> | -f <fid>] [--value=<value> | -v <value>]
+ [--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>]
Range Type and host identifier. This defaults to STDIN so files
and echo can be piped.
--v <value>::
+-V <value>::
--value=<value>::
The value for command dword 11, the value you want to set the
feature to.
* Sets the Power State (PS) to 1 in feature id 2:
+
------------
-# nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -v 0x1
+# nvme set-feature /dev/nvme0 -f 2 /dev/nvme0n1 -V 0x1
------------
+
SYNOPSIS
--------
[verse]
-'nvme set-property' <device> [--offset=<offset> | -o <offset>]
- [--value=<val> | -v <val>]
+'nvme set-property' <device> [--offset=<offset> | -O <offset>]
+ [--value=<val> | -V <val>]
DESCRIPTION
OPTIONS
-------
--o::
+-O::
--offset::
The offset of the property.
--v::
+-V::
--value:
The value of the property to be set.
SYNOPSIS
--------
[verse]
-'nvme telemetry-log' <device> [--output-file=<file> | -o <file>]
+'nvme telemetry-log' <device> [--output-file=<file> | -O <file>]
[--host-generate=<gen> | -g <gen>]
DESCRIPTION
OPTIONS
-------
--o <file>::
+-O <file>::
--output-file=<file>::
File name to which raw binary data will be saved to.
[--dir-type=<type> | -T <type>]
[--dir-spec=<spec> | -S <spec>]
[--dsm=<dsm> | -D <dsm>]
- [--show-command | -v]
+ [--show-command | -V]
[--dry-run | -w]
[--latency | -t]
[--storage-tag<storage-tag> | -g <storage-tag>]
consult the NVMe specification for detailed breakdown of how to
use this field.
--v::
+-V::
--show-cmd::
Print out the command to be sent.