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

NAME

6       nvme-show-regs - Reads and shows the defined NVMe controller registers
7       for NVMe over PCIe or the controller properties for NVMe over Fabrics.
8

SYNOPSIS

10       nvme show-regs <device>       [--human-readable | -H]
11                                       [--output-format=<FMT> | -o <FMT>]
12

DESCRIPTION

14       For the NVMe over PCIe device given, sends an identify namespace
15       command and provides the result and returned structure. For the NVMe
16       over Fabrics device given, sends a fabric command and provides the
17       result and returned structure.
18
19       The <device> parameter is mandatory and must be the nvme admin
20       character device (ex: /dev/nvme0). For NVMe over PCIe, the program uses
21       knowledge of the sysfs layout to map the device to the pci resource
22       stored there and mmaps the memory to get access to the registers. For
23       NVMe over Fabrics, the programs sends a fabric command to get the
24       properties of the target NVMe controller. Only the supported properties
25       are displayed.
26

OPTIONS

28       -H, --human-readable
29           Display registers or supported properties in human readable format.
30
31       -o <format>, --output-format=<format>
32           Set the reporting format to normal, json, or binary. Only one
33           output format can be used at a time.
34

EXAMPLES

36       ·   Show the NVMe over PCIe controller registers or the NVMe over
37           Fabric controller properties in a binary format:
38
39               # nvme show-regs /dev/nvme0 -o binary
40
41       ·   Show the NVMe over PCIe controller registers or the NVMe over
42           Fabric controller properties in a human readable format:
43
44               # nvme show-regs /dev/nvme0 -H
45
46       ·   Show the NVMe over PCIe controller registers or NVMe-oF controller
47           properties in a json format:
48
49               # nvme show-regs /dev/nvme0 -o json
50

NVME

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