summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-error-recovery-log.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-ocp-error-recovery-log.txt')
-rw-r--r--Documentation/nvme-ocp-error-recovery-log.txt42
1 files changed, 42 insertions, 0 deletions
diff --git a/Documentation/nvme-ocp-error-recovery-log.txt b/Documentation/nvme-ocp-error-recovery-log.txt
new file mode 100644
index 0000000..7a26150
--- /dev/null
+++ b/Documentation/nvme-ocp-error-recovery-log.txt
@@ -0,0 +1,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.