1NVME-NS-DESCS(1)                  NVMe Manual                 NVME-NS-DESCS(1)
2
3
4

NAME

6       nvme-ns-descs - Send NVMe Identify for a list of Namespace
7       Identification Descriptor structure, return result and structure
8

SYNOPSIS

10       nvme ns-descs <device> [--namespace-id=<nsid> | -n <nsid>]
11                               [--raw-binary | -b]
12                               [--output-format=<fmt> | -o <fmt>]
13

DESCRIPTION

15       For the NVMe device given, sends an identify for a list of namespace
16       identification descriptor structures command and provides the result
17       and returned structure.
18
19       The <device> parameter is mandatory and may be either the NVMe
20       character device (ex: /dev/nvme0), or a namespace block device (ex:
21       /dev/nvme0n1). If the character device is given, the '--namespace-id'
22       option is mandatory, otherwise it will use the ns-id of the namespace
23       for the block device you opened. For block devices, the ns-id used can
24       be overridden with the same option.
25
26       On success, the structure may be returned in one of several ways
27       depending on the option flags; the structure may be parsed by the
28       program or the raw buffer may be printed to stdout.
29

OPTIONS

31       -n <nsid>, --namespace-id=<nsid>
32           Retrieve the identify namespace identification descriptor structure
33           for the given nsid. This is required for the character devices, or
34           overrides the block nsid if given.
35
36       -b, --raw-binary
37           Print the raw buffer to stdout. Structure is not parsed by program.
38
39       -o <format>, --output-format=<format>
40           Set the reporting format to normal, json, or binary. Only one
41           output format can be used at a time.
42

EXAMPLES

44       ·   If using the character device or overriding namespace #2:
45
46               # nvme ns-descs /dev/nvme0 -n 1
47               # nvme ns-descs /dev/nvme0n1 -n 2
48               # nvme ns-descs /dev/nvme0 --namespace-id=1
49
50       ·   Have the program return the raw structure in binary:
51
52               # nvme ns-descs /dev/nvme0n1 --raw-binary > ns_descs.raw
53               # nvme ns-descs /dev/nvme0n1 -b > ns_descs.raw
54
55           It is probably a bad idea to not redirect stdout when using this
56           mode.
57

NVME

59       Part of the nvme-user suite
60
61
62
63NVMe                              06/05/2018                  NVME-NS-DESCS(1)
Impressum