NVME-GET-LOG(1) | NVMe Manual | NVME-GET-LOG(1) |
NAME
nvme-get-log - Retrieves a log page from an NVMe device
SYNOPSIS
nvme get-log <device> [--log-id=<log-id> | -i <log-id>] [--log-len=<log-len> | -l <log-len>] [--aen=<aen> | -a <aen>] [--namespace-id=<nsid> | -n <nsid>] [--raw-binary | -b] [--lpo=<offset> | -L <offset>] [--lsp=<field> | -s <field>] [--lsi=<field> | -S <field>] [--rae | -r] [--csi=<command_set_identifier> | -y <command_set_identifier>] [--ot=<offset_type> | -O <offset_type>] [--xfer-len=<length> | -x <length>] [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
DESCRIPTION
Retrieves an arbitrary NVMe log page from an NVMe device and provides the 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).
On success, the returned log structure may be returned in one of several ways depending on the option flags; the structure may be displayed in hex by the program or the raw buffer may be printed to stdout for another program to parse.
OPTIONS
-l <log-len>, --log-len=<log-len>
-i <log-id>, --log-id=<log-id>
-a <aen>, --aen=<aen>
-n <nsid>, --namespace-id=<nsid>
-b, --raw-binary
-L <offset>, --lpo=<offset>
-s <field>, --lsp=<field>
-S <field>, --lsi=<field>
-r, --rae
-y <command_set_identifier>, --csi=<command_set_identifier>
-O, --ot
-x <length>
-o <fmt>, --output-format=<fmt>
-v, --verbose
EXAMPLES
# nvme get-log /dev/nvme0 --log-id=2 --log-len=512
The above example will get log page 2 (SMART), and request 512 bytes. On success, the returned log will be dumped in hex and not interpreted by the program.
# nvme get-log /dev/nvme0 -log-id=2 --log-len=512 --raw-binary > log_page_2.raw # nvme get-log /dev/nvme0 -i 2 -l 512 -b > log_page_2.raw
It is not a good idea to not redirect stdout when using this mode.
NVME
Part of the nvme-user suite
11/16/2024 | NVMe |