blob: 8afeba580a92fc67e3029f85f3589c0f2567c71a (
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
71
72
73
74
|
nvme-ns-descs(1)
================
NAME
----
nvme-ns-descs - Send NVMe Identify for a list of Namespace Identification
Descriptor structure, return result and structure
SYNOPSIS
--------
[verse]
'nvme ns-descs' <device> [--namespace-id=<nsid> | -n <nsid>]
[--raw-binary | -b]
[--output-format=<fmt> | -o <fmt>]
DESCRIPTION
-----------
For the NVMe device given, sends an identify for a list of namespace
identification descriptor structures 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).
If the character device is given, the `'--namespace-id'` option is
mandatory, otherwise it will use the ns-id of the namespace for the block
device you opened. For block devices, the ns-id used can be overridden
with the same option.
On success, the structure may be returned in one of several ways depending
on the option flags; the structure may be parsed by the program or the
raw buffer may be printed to stdout.
OPTIONS
-------
-n <nsid>::
--namespace-id=<nsid>::
Retrieve the identify namespace identification descriptor structure
for the given nsid. This is required for the character devices, or
overrides the block nsid if given.
-b::
--raw-binary::
Print the raw buffer to stdout. Structure is not parsed by
program.
-o <format>::
--output-format=<format>::
Set the reporting format to 'normal', 'json', or 'binary'.
Only one output format can be used at a time.
EXAMPLES
--------
* If using the character device or overriding namespace #2:
+
------------
# nvme ns-descs /dev/nvme0 -n 1
# nvme ns-descs /dev/nvme0n1 -n 2
# nvme ns-descs /dev/nvme0 --namespace-id=1
------------
+
* Have the program return the raw structure in binary:
+
------------
# nvme ns-descs /dev/nvme0n1 --raw-binary > ns_descs.raw
# nvme ns-descs /dev/nvme0n1 -b > ns_descs.raw
------------
+
It is probably a bad idea to not redirect stdout when using this mode.
NVME
----
Part of the nvme-user suite
|
