summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-resv-notif-log.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-resv-notif-log.txt')
-rw-r--r--Documentation/nvme-resv-notif-log.txt55
1 files changed, 55 insertions, 0 deletions
diff --git a/Documentation/nvme-resv-notif-log.txt b/Documentation/nvme-resv-notif-log.txt
new file mode 100644
index 0000000..f8d828b
--- /dev/null
+++ b/Documentation/nvme-resv-notif-log.txt
@@ -0,0 +1,55 @@
+nvme-resv-notif-log(1)
+======================
+
+NAME
+----
+nvme-resv-notif-log - Send NVMe Reservation Notification log page request,
+return result and log
+
+SYNOPSIS
+--------
+[verse]
+'nvme resv-notif-log' <device> [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+Retrieves NVMe Reservation Notification log page from an NVMe device and
+provides the returned structure.
+
+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 Reservation Notification 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
+-------
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
+EXAMPLES
+--------
+* Get the Reservation Notification log and print it in a human readable format:
++
+------------
+# nvme resv-notif-log /dev/nvme0
+------------
++
+
+* Print the output in json format:
++
+------------
+# nvme resv-notif-log /dev/nvme0 -o json
+------------
+
+NVME
+----
+Part of the nvme-user suite