summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-show-topology.txt
blob: 32ffad1e7517f916a5b2234a153f62452f277c70 (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-show-topology(1)
=====================

NAME
----
nvme-show-topology - Show topology of all NVMe subsystems

SYNOPSIS
--------
[verse]
'nvme show-topology' [--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
Show the topology of all NVMe subsystems.

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

-v::
--verbose::
	Increase the information in the output, showing nvme subsystems,
	controllers and namespaces separately and how they're related to each
	other.

-r <order>::
--ranking=<order>::
	Set the ranking orer to 'namespace' (default) or 'ctrl'. This option
	has only an effect for output format 'normal'. The JSON output is
	always 'namespace' ordered.

-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
--------
nvme show-topology

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