nvme-log-error(1)
=================

NAME
----
nvme-log-error - Send NVME Error log page request, return result and log

SYNOPSIS
--------
[verse]
'nvme' [<global-options>] 'log error' <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.

include::global-options.txt[]

EXAMPLES
--------
* Get the error log and print it in a human readable format:
+
------------
# nvme log error /dev/nvme0
------------
+

* Print the raw output to a file:
+
------------
# nvme log error /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
