summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-nvm-id-ctrl.txt
blob: eabc4b1f05b612b413874497a17aa1dc2fa0eeb2 (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
nvme-nvm-id-ctrl(1)
===================

NAME
----
nvme-nvm-id-ctrl - Send NVMe Identify Controller, return NVM command set structure

SYNOPSIS
--------
[verse]
'nvme nvm-id-ctrl' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
For the NVMe device given, sends the NVM command set's identify controller
command and provides the result and returned 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).

On success, the data structure returned by the device will be decoded and
displayed in one of several ways.

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 interpret the returned buffer and display the known
fields in a human readable format:
+
------------
# nvme nvm-id-ctrl /dev/nvme0
------------
+

* Show the output in json format
+
------------
# nvme nvm-id-ctrl /dev/nvme0 -o json
------------

NVME
----
Part of nvme-cli