summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-id-iocs.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-id-iocs.txt')
-rw-r--r--Documentation/nvme-id-iocs.txt58
1 files changed, 58 insertions, 0 deletions
diff --git a/Documentation/nvme-id-iocs.txt b/Documentation/nvme-id-iocs.txt
new file mode 100644
index 0000000..bb85aef
--- /dev/null
+++ b/Documentation/nvme-id-iocs.txt
@@ -0,0 +1,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