summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-id-iocs.txt
blob: bb85aef1e4efa5433838ed35492caa9396974f28 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
nvme-id-iocs(1)
===============

NAME
----
nvme-id-iocs - Send NVMe Identify I/O Command Set, return result and structure

SYNOPSIS
--------
[verse]
'nvme id-iocs' <device> [--controller-id=<cntid> | -c <cntid>]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
For the NVMe device given, send an identify command and return the Identify I/O
Command Set data structure.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

OPTIONS
-------
-c <cntid>::
--controller-id=<cntid>::
	Retrieve the identify I/O Command set data structure for the given
	cntid. If this value is not given, cntid will be 0xffff.
-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
--------
* Have the program interpret the returned buffer and display the known
fields in a human readable format:
+
------------
# nvme id-iocs /dev/nvme0
------------
+
* show the fields in human readable format
+
------------
# nvme id-iocs /dev/nvme0 -H
------------
NVME
----
Part of the nvme-user suite