summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-resv-notif-log.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:41:05 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-29 04:41:05 +0000
commit1cc8413aaf5f8fa6595aece1933462c096e88639 (patch)
treee97b4f25c511372d73bdd96c389c5f468d99138a /Documentation/nvme-resv-notif-log.txt
parentInitial commit. (diff)
downloadnvme-cli-1cc8413aaf5f8fa6595aece1933462c096e88639.tar.xz
nvme-cli-1cc8413aaf5f8fa6595aece1933462c096e88639.zip
Adding upstream version 2.4+really2.3.upstream/2.4+really2.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-resv-notif-log.txt')
-rw-r--r--Documentation/nvme-resv-notif-log.txt51
1 files changed, 51 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..a9c5cdd
--- /dev/null
+++ b/Documentation/nvme-resv-notif-log.txt
@@ -0,0 +1,51 @@
+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>]
+
+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 <format>::
+--output-format=<format>::
+ Set the reporting format to 'normal', 'json', or
+ 'binary'. Only one output format can be used at a time.
+
+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