summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-list-ns.txt
blob: d24128765f396a6694b2e7c4556849c0aefe3fbb (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
59
60
61
62
63
64
65
66
67
68
69
70
nvme-id-ns(1)
=============

NAME
----
nvme-list-ns - Send NVMe Identify List Namespaces, return result and structure

SYNOPSIS
--------
[verse]
'nvme list-ns' <device> [--namespace-id=<nsid> | -n <nsid>]
			[--csi=<command_set_identifier> | -y <command_set_identifier>]
			[--all | -a]
			[--output-format=<fmt> | -o <fmt>] [--verbose | -v]

DESCRIPTION
-----------
For the NVMe device given, sends an identify command for namespace list
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).
If the starting namespace in the list always begins with 0 unless the
`'--namespace-id'` option is given to override.

On success, the namespace array is printed for each index and nsid for
a valid nsid.

OPTIONS
-------
-n <nsid>::
--namespace-id=<nsid>::
	Retrieve the identify list structure starting with the given nsid.

-y <command_set_identifier>::
--csi=<command_set_identifier>::
	If this value is given, retrieve the identify list structure associated
	with the specified I/O command set.

-a::
--all::
	Retrieve the identify list structure for all namespaces in the
	subsystem, whether attached or inactive.

-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
--------
* Print the namespaces present for zoned command set in JSON format
+
------------
# nvme list-ns /dev/nvme0 -y 2 -a -o json
------------

* Print the namespaces present for NVM Command Set in normal format
+
------------
# nvme list-ns /dev/nvme0
------------

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