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

NAME
----
nvme-list-ctrl - Send NVMe Identify List Controllers, return result and structure

SYNOPSIS
--------
[verse]
'nvme list-ctrl' <device> [--cntid=<cntid> | -c <cntid>]
			[--namespace-id=<nsid> | -n <nsid>] [-o <fmt> | --output-format=<fmt>]
DESCRIPTION
-----------
For the NVMe device given, sends an identify command for controller list
and provides the result and returned structure. This uses either mode
12h or 13h depending on the requested namespace identifier.

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).
The starting controller in the list always begins with 0 unless the
`'--cntid'` option is given to override.

On success, the controller array is printed for each index and controller
identifier.

OPTIONS
-------
-c <cntid>::
--cntid=<cntid>::
	Retrieve the identify list structure starting with the given controller id.

-n <nsid>::
--namespace-id=<nsid>::
	If provided, will request the controllers attached to the
	specified namespace. If no namespace is given, or set to 0, the
	command requests the controller list for the entire subsystem,
	whether or not they are attached to namespace(s).

-o <format>::
--output-format=<format>::
	Set the reporting format to 'normal' or 'json'. Only one output
	format can be used at a time.

EXAMPLES
--------
No examples yet.

NVME
----
Part of the nvme-user suite