summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-resv-report.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2021-07-02 20:40:30 +0000
commitdc597ce8df5ae6efd2728a2d7ba7d92486028f79 (patch)
tree55b9e9257eba4579667f9522368aa29f5be6754a /Documentation/nvme-resv-report.txt
parentInitial commit. (diff)
downloadnvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.tar.xz
nvme-cli-dc597ce8df5ae6efd2728a2d7ba7d92486028f79.zip
Adding upstream version 1.12.upstream/1.12
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-resv-report.txt')
-rw-r--r--Documentation/nvme-resv-report.txt63
1 files changed, 63 insertions, 0 deletions
diff --git a/Documentation/nvme-resv-report.txt b/Documentation/nvme-resv-report.txt
new file mode 100644
index 0000000..b53c141
--- /dev/null
+++ b/Documentation/nvme-resv-report.txt
@@ -0,0 +1,63 @@
+nvme-resv-report(1)
+===================
+
+NAME
+----
+nvme-resv-report - Send NVMe Reservation Report, parse the result
+
+SYNOPSIS
+--------
+[verse]
+'nvme resv-report' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--numd=<num-dwords> | -d <num-dwords>]
+ [--cdw11=<cdw11> | -c <cdw11>]
+ [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>]
+
+DESCRIPTION
+-----------
+The Reservation Report command returns a Reservation Status data structure
+to host memory that describes the registration and reservation status
+of a namespace.
+
+The size of the Reservation Status data structure is a function of the
+number of controllers in the NVM Subsystem that are associated with
+hosts that are registrants of the namespace (i.e., there is a Registered
+Controller data structure for each such controller).
+
+OPTIONS
+-------
+-n <nsid>::
+--namespace-id=<nsid>::
+ Retrieve the reservation report structure for the given nsid. This
+ is required for the character devices, or overrides the block nsid
+ if given.
+
+-d <num-dwords>::
+--numd=<num-dwords>::
+ Specify the number of Dwords of the Reservation Status structure
+ to transfer. Defaults to 4k.
+
+-c <cdw11>::
+--cdw11=<cdw11>::
+ The value for command dword 11. Setting bit 0 specifies that the
+ controller returns the Extended Data Structure.
+
+-b::
+--raw-binary::
+ Print the raw buffer to stdout. Structure is not parsed by
+ program.
+
+-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
+--------
+No examples yet.
+
+NVME
+----
+Part of the nvme-user suite