nvme-ns-descs - Man Page

Send NVMe Identify for a list of Namespace Identification Descriptor structure, return result and structure

Synopsis

nvme ns-descs <device> [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b]
                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]

Description

For the NVMe device given, sends an identify for a list of namespace identification descriptor structures command 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 character device is given, the '--namespace-id' option is mandatory, otherwise it will use the ns-id of the namespace for the block device you opened. For block devices, the ns-id used can be overridden with the same option.

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 <nsid>, --namespace-id=<nsid>

Retrieve the identify namespace identification descriptor structure for the given nsid. This is required for the character devices, or overrides the block nsid if given.

-b, ā€‰--raw-binary

Print the raw buffer to stdout. Structure is not parsed by program.

-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.

Examples

Nvme

Part of the nvme-user suite

Referenced By

nvme(1).

08/26/2024 NVMe Manual