SYNOPSIS

nvme [<global-options>] error-log <device>
                        [--log-entries=<entries> | -e <entries>]
                        [--raw-binary | -b]
                        [--valid-entry | -V]
                        [--sqid=<sqid> | -S <sqid>]
                        [--status=<status> | -s <status>]
                        [--lba=<lba> | -l <lba>]
                        [--namespace-id=<nsid> | -n <nsid>]
                        [--trtype=<trtype> | -t <trtype>]
                        [--csi=<csi> | -c <csi>]
                        [--opcode=<opcode> | -O <opcode>]

DESCRIPTION

Retrieves NVMe Error log page from an NVMe device and provides the returned structure. All the returned structure fields including the ordering of the entries are described in the spec.

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 error log structure may be returned in one of several ways depending on the option flags; the structure may parsed by the program and printed in a readable format or the raw buffer may be printed to stdout for another program to parse.

OPTIONS

-e <entries>
--log-entries=<entries>

Specifies how many log entries the program should request from the device. This must be at least one, and shouldn’t exceed the device’s capabilities. Defaults to 64 log entries.

-b
--raw-binary

Print the raw error log buffer to stdout.

-V
--valid-entry

Output valid entry only.

-S <sqid>
--sqid=<sqid>

Output specified SQID entry only.

-s <status>
--status=<status>

Output specified STATUS entry only.

-l <lba>
--lba=<lba>

Output specified LBA entry only.

-n <nsid>
--namespace-id=<nsid>

Output specified NSID entry only.

-t <trtype>
--trtype=<trtype>

Output specified TRTYPE entry only.

-c <csi>
--csi=<csi>

Output specified CSI entry only.

-O <opcode>
--opcode=<opcode>

Output specified OPC entry only.

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.

EXAMPLES

  • Get the error log and print it in a human readable format: 

    # nvme error-log /dev/nvme0

  • Print the raw output to a file: 

    # nvme error-log /dev/nvme0 --raw-binary > error_log.raw

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

NVME

Part of the nvme-user suite