Documentation/nvme-error-log.1 - master - githubmirror/nvme-cli

Documentation/nvme-error-log.1
199 строк5 KB
Daniel Wagner
doc: Regenerate all docs for v3.0-b.5
07 авг 2026, 18:03
07 авг 2026, 18:038c9e089
'\" t
.\"     Title: nvme-error-log
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 08/07/2026
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-ERROR\-LOG" "1" "08/07/2026" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-error-log \- Send NVME Error log page request, return result and log
.SH "SYNOPSIS"
.sp
.nf
\fInvme\fR [<global\-options>] \fIerror\-log\fR <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>]
.fi
.SH "DESCRIPTION"
.sp
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\&.
.sp
The <device> parameter is mandatory and may be either the NVMe character device (ex: /dev/nvme0), or a namespace block device (ex: /dev/nvme0n1)\&.
.sp
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\&.
.SH "OPTIONS"
.PP
\-e <entries>, \-\-log\-entries=<entries>
.RS 4
Specifies how many log entries the program should request from the device\&. This must be at least one, and shouldn\(cqt exceed the device\(cqs capabilities\&. Defaults to 64 log entries\&.
.RE
.PP
\-b, \-\-raw\-binary
.RS 4
Print the raw error log buffer to stdout\&.
.RE
.PP
\-V, \-\-valid\-entry
.RS 4
Output valid entry only\&.
.RE
.PP
\-S <sqid>, \-\-sqid=<sqid>
.RS 4
Output specified SQID entry only\&.
.RE
.PP
\-s <status>, \-\-status=<status>
.RS 4
Output specified STATUS entry only\&.
.RE
.PP
\-l <lba>, \-\-lba=<lba>
.RS 4
Output specified LBA entry only\&.
.RE
.PP
\-n <nsid>, \-\-namespace\-id=<nsid>
.RS 4
Output specified NSID entry only\&.
.RE
.PP
\-t <trtype>, \-\-trtype=<trtype>
.RS 4
Output specified TRTYPE entry only\&.
.RE
.PP
\-c <csi>, \-\-csi=<csi>
.RS 4
Output specified CSI entry only\&.
.RE
.PP
\-O <opcode>, \-\-opcode=<opcode>
.RS 4
Output specified OPC entry only\&.
.RE
.SH "GLOBAL OPTIONS"
.sp
The following options are defined at the top\-level nvme command and are available to this subcommand:
.PP
\-\-dry\-run
.RS 4
Print the command that would be executed, but do not actually execute it\&.
.RE
.PP
\-\-no\-ioctl\-probing
.RS 4
Disable probing for 64\-bit IOCTL support\&.
.RE
.PP
\-\-no\-retries
.RS 4
Disable retry logic on transient errors\&.
.RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fItabular, \*(Aqjson\fR, or
\fIbinary\fR\&. Only one output format may be used at a time\&.
.RE
.PP
\-\-output\-format\-version=<version>
.RS 4
Select the output format version\&. Version
\fI1\fR
uses the original field naming, while version
\fI2\fR
(default) provides more consistent and script\-friendly field names\&.
.RE
.PP
\-\-timeout=<ms>
.RS 4
Set the timeout for the command in milliseconds\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the level of detail in the output\&. May be specified multiple times to further increase verbosity\&.
.RE
.sp
These options can also be set as machine\-wide defaults in nvme\-cli\&.conf(5)\&. A command\-line flag always overrides the file\&.
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Get the error log and print it in a human readable format:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme error\-log /dev/nvme0
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Print the raw output to a file:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme error\-log /dev/nvme0 \-\-raw\-binary > error_log\&.raw
.fi
.if n \{\
.RE
.\}
.sp
It is probably a bad idea to not redirect stdout when using this mode\&.
.RE
.SH "NVME"
.sp
Part of the nvme\-user suite