SYNOPSIS

nvme [<global-options>] id nvm-ns <device>
                        [--uuid-index=<uuid-index> | -U <uuid_index>]
                        [--namespace-id=<NUM> | -n <NUM>]

DESCRIPTION

Identify NVM Command Set specific Namespace data structure for the specified NSID for the NVM Command Set specified in the CSI field.

The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1).

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 <NUM>
--namespace-id=<NUM>

Use the provided namespace id for the command. If not provided, the namespace id of the block device will be used. If the command is issued to a non-block device, the parameter is required.

-U <uuid-index>
--uuid-index=<uuid-index>

UUID Index of the feature

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

  • Has the program interpret the returned buffer and display the known fields in a human readable format: 

    # nvme id nvm-ns /dev/nvme0n1

  • If using the character device or overriding namespace id: 

    # nvme id nvm-ns /dev/nvme0 -n 1
# nvme id nvm-ns /dev/nvme0n1 -n 1
# nvme id nvm-ns /dev/nvme0 --namespace-id=1

  • Have the program return the raw structure in binary: 

    # nvme id nvm-ns /dev/nvme0n1 -o binary > id_ns.raw
# nvme id nvm-ns /dev/nvme0n1 --output-format=binary > id_ns.raw

    It is probably a bad idea to not redirect stdout when using this mode.

  • Alternatively you may want to send the data to another program that can parse the raw buffer. 

    NVME

Part of the nvme-user suite