summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-ocp-unsupported-reqs-log-pages.txt')
-rw-r--r--Documentation/nvme-ocp-unsupported-reqs-log-pages.txt45
1 files changed, 45 insertions, 0 deletions
diff --git a/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt b/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt
new file mode 100644
index 0000000..65818d3
--- /dev/null
+++ b/Documentation/nvme-ocp-unsupported-reqs-log-pages.txt
@@ -0,0 +1,45 @@
+unsupported-reqs-log
+====================
+
+NAME
+----
+unsupported-reqs-log - Retrieves unsupported requirements log page of given OCP
+compliant device
+
+SYNOPSIS
+--------
+[verse]
+'nvme ocp unsupported-reqs-log' <device> [--output-format=<fmt> | -o <fmt>]
+
+DESCRIPTION
+-----------
+For the NVMe device given, send a unsupported-reqs-log command and
+provide the unsupported requirements 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 <format>::
+--output-format=<format>::
+ This option will set the reporting format to normal, json, or binary.
+ Only one output format can be used at a time.
+
+EXAMPLES
+--------
+* Has the program issue a unsupported-reqs-log command to retrieve the 0xC5 log page.
++
+------------
+# nvme ocp unsupported-reqs-log /dev/nvme0
+------------
+
+NVME
+----
+Part of the nvme-user suite \ No newline at end of file