NVME-ID-NS-LIST(1)

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

SYNOPSIS

nvme [<global-options>] id ns-list <device> [--namespace-id=<nsid> | -n <nsid>]
                        [--csi=<command_set_identifier> | -y
                        <command_set_identifier>]
                        [--all | -a]

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.

GLOBAL OPTIONS

The following options are defined at the top-level nvme command and are available to this subcommand:

--dry-run
    Print the command that would be executed, but do not actually execute it.

--no-ioctl-probing
    Disable probing for 64-bit IOCTL support.

--no-retries
    Disable retry logic on transient errors.

-o <fmt>, --output-format=<fmt>
    Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time.

--output-format-version=<version>
    Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names.

--timeout=<ms>
    Set the timeout for the command in milliseconds.

-v, --verbose
    Increase the level of detail in the output. May be specified multiple times to further increase verbosity.

These options can also be set as machine-wide defaults in nvme-cli.conf(5). A command-line flag always overrides the file.

EXAMPLES

    • Print the namespaces present for zoned command set in JSON format

        # nvme id ns-list /dev/nvme0 -y 2 -a -o json

    • Print the namespaces present for NVM Command Set in normal format

        # nvme id ns-list /dev/nvme0

NVME

Part of the nvme-user suite