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

NAME

6       nvme-list-ns - Send NVMe Identify List Namespaces, return result and
7       structure
8

SYNOPSIS

10       nvme list-ns <device> [--namespace-id=<nsid> | -n <nsid>]
11                               [--csi=<command_set_identifier> | -y <command_set_identifier>]
12                               [--all | -a] [--output-format=<fmt> | -o <fmt>]
13

DESCRIPTION

15       For the NVMe device given, sends an identify command for namespace list
16       and provides the result and returned structure.
17
18       The <device> parameter is mandatory and may be either the NVMe
19       character device (ex: /dev/nvme0), or a namespace block device (ex:
20       /dev/nvme0n1). If the starting namespace in the list always begins with
21       0 unless the '--namespace-id' option is given to override.
22
23       On success, the namespace array is printed for each index and nsid for
24       a valid nsid.
25

OPTIONS

27       -n <nsid>, --namespace-id=<nsid>
28           Retrieve the identify list structure starting with the given nsid.
29
30       -y <command_set_identifier>, --csi=<command_set_identifier>
31           If this value is given, retrieve the identify list structure
32           associated with the speicified I/O command set.
33
34       -a, --all
35           Retrieve the identify list structure for all namespaces in the
36           subsystem, whether attached or inactive.
37
38       -o <format>, --output-format=<format>
39           Set the reporting format to normal, or json. Only one output format
40           can be used at a time.
41

EXAMPLES

43       •   Print the namespaces present for zoned command set in JSON format
44
45               # nvme list-ns /dev/nvme0 -y 2 -a -o json
46
47       •   Print the namespaces present for NVM Command Set in normal format
48
49               # nvme list-ns /dev/nvme0
50

NVME

52       Part of the nvme-user suite
53
54
55
56NVMe                              04/11/2022                     NVME-ID-NS(1)
Impressum