summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-resv-report.txt
diff options
context:
space:
mode:
Diffstat (limited to '')
-rw-r--r--Documentation/nvme-resv-report.txt65
1 files changed, 65 insertions, 0 deletions
diff --git a/Documentation/nvme-resv-report.txt b/Documentation/nvme-resv-report.txt
new file mode 100644
index 0000000..2e12826
--- /dev/null
+++ b/Documentation/nvme-resv-report.txt
@@ -0,0 +1,65 @@
+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>] [--eds | -e]
+ [--raw-binary | -b]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+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.
+
+-e::
+--eds::
+ Request extended Data Structure: If this bit is set to a '1', then the
+ controller returns the Extended Data Structure.
+
+-b::
+--raw-binary::
+ Print the raw buffer to stdout. Structure is not parsed by
+ program.
+
+-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
+--------
+No examples yet.
+
+NVME
+----
+Part of the nvme-user suite