summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-error-recovery-log.txt
blob: 7a261503dc0c29b50f3451bbb3fb0ef174e2e19f (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
nvme-ocp-error-recovery-log(1)
==============================

NAME
----
nvme-ocp-error-recovery-log - Retrieves OCP Error Recovery Log Page

SYNOPSIS
--------
[verse]
'nvme ocp error-recovery-log' <device> [--output-format=<fmt> | -o <fmt>]

DESCRIPTION
-----------
For the NVMe device given, retrieves OCP Error Recovery Log Page

The <device> parameter is mandatory and may be either the NVMe character
device (ex: /dev/nvme0) or block device (ex: /dev/nvme0n1).

This will only work on OCP compliant devices supporting this feature.
Results for any other device are undefined.

On success it returns 0, error code otherwise.

OPTIONS
-------
-o <fmt>::
--output-format=<fmt>::
	Set the reporting format to 'normal' or 'json' or 'binary'. 
	Only one output format can be used at a time. The default is normal.

EXAMPLES
--------
* Has the program issue a error-recovery-log command to retrieve the 0xC1 log page.
+
------------
# nvme ocp error-recovery-log /dev/nvme0 -o normal
------------

NVME
----
Part of the nvme-user suite.