Blame Documentation/nvme-id-nvmset.txt

Packit Service b7b338
nvme-id-nvmset(1)
Packit Service b7b338
=================
Packit Service b7b338
Packit Service b7b338
NAME
Packit Service b7b338
----
Packit Service b7b338
nvme-id-nvmset - Send NVMe Identify NVM Set List, return result and structure
Packit Service b7b338
Packit Service b7b338
SYNOPSIS
Packit Service b7b338
--------
Packit Service b7b338
[verse]
Packit Service b7b338
'nvme id-nvmset' <device> [-i <id> | --nvmset_id=<id> ]
Packit Service b7b338
			[-o <fmt> | --output-format=<fmt>]
Packit Service b7b338
Packit Service b7b338
DESCRIPTION
Packit Service b7b338
-----------
Packit Service b7b338
For the NVMe device given, sends an identify NVM set list command and
Packit Service b7b338
provides the result and returned structure.
Packit Service b7b338
Packit Service b7b338
The <device> parameter is mandatory and may be either the NVMe character
Packit Service b7b338
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
Packit Service b7b338
Packit Service b7b338
On success, the structure may be returned in one of several ways depending
Packit Service b7b338
on the option flags; the structure may be parsed by the program or the
Packit Service b7b338
raw buffer may be printed to stdout.
Packit Service b7b338
Packit Service b7b338
OPTIONS
Packit Service b7b338
-------
Packit Service b7b338
-i <id>::
Packit Service b7b338
--nvmset_id=<id>::
Packit Service b7b338
	This field specifies the identifier of the NVM Set.  If given, NVM set
Packit Service b7b338
	identifier whose entry is to be in result data will be greater than or
Packit Service b7b338
	equal to this value.
Packit Service b7b338
Packit Service b7b338
-o <format>::
Packit Service b7b338
--output-format=<format>::
Packit Service b7b338
              Set the reporting format to 'normal', 'json', or
Packit Service b7b338
              'binary'. Only one output format can be used at a time.
Packit Service b7b338
Packit Service b7b338
EXAMPLES
Packit Service b7b338
--------
Packit Service b7b338
* Has the program interpret the returned buffer and display the known
Packit Service b7b338
fields in a human readable format:
Packit Service b7b338
+
Packit Service b7b338
------------
Packit Service b7b338
# nvme id-nvmset /dev/nvme0
Packit Service b7b338
------------
Packit Service b7b338
+
Packit Service b7b338
Packit Service b7b338
* Have the program return the raw structure in binary:
Packit Service b7b338
+
Packit Service b7b338
------------
Packit Service b7b338
# nvme id-nvmset /dev/nvme0 --output-format=binary > id_nvmset.raw
Packit Service b7b338
# nvme id-nvmset /dev/nvme0 -o binary > id_nvmset.raw
Packit Service b7b338
------------
Packit Service b7b338
+
Packit Service b7b338
It is probably a bad idea to not redirect stdout when using this mode.
Packit Service b7b338
Packit Service b7b338
* Alternatively you may want to send the data to another program that
Packit Service b7b338
can parse the raw buffer.
Packit Service b7b338
+
Packit Service b7b338
------------
Packit Service b7b338
# nvme id-nvmset /dev/nvme0 -o binary | nvme_parse_id_nvmset
Packit Service b7b338
------------
Packit Service b7b338
+
Packit Service b7b338
The parse program in the above example can be a program that shows the
Packit Service b7b338
structure in a way you like. The following program is such an example
Packit Service b7b338
that will parse it and can accept the output through a pipe, `'|'`,
Packit Service b7b338
as shown in the above example, or you can `'cat'` a saved output buffer to it.
Packit Service b7b338
------------
Packit Service b7b338
Packit Service b7b338
NVME
Packit Service b7b338
----
Packit Service b7b338
Part of the nvme-user suite