nvme-list-ns

NVME-ID-NS(1) NVMe Manual NVME-ID-NS(1)

NAME

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

SYNOPSIS

   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]
                           [--timeout=<timeout> | -t <timeout>]

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.

   -t <timeout>, --timeout=<timeout>
       Override default timeout value. In milliseconds.

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

NVMe 05/02/2025 NVME-ID-NS(1)