summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-resv-release.txt
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:41:32 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-10 19:41:32 +0000
commitf26f66d866ba1a9f3204e6fdfe2b07e67b5492ad (patch)
treec953c007cbe4f60a147ab62f97937d58abb2e9ca /Documentation/nvme-resv-release.txt
parentInitial commit. (diff)
downloadnvme-cli-f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad.tar.xz
nvme-cli-f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad.zip
Adding upstream version 2.8.upstream/2.8
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'Documentation/nvme-resv-release.txt')
-rw-r--r--Documentation/nvme-resv-release.txt93
1 files changed, 93 insertions, 0 deletions
diff --git a/Documentation/nvme-resv-release.txt b/Documentation/nvme-resv-release.txt
new file mode 100644
index 0000000..c3dc90d
--- /dev/null
+++ b/Documentation/nvme-resv-release.txt
@@ -0,0 +1,93 @@
+nvme-resv-release(1)
+====================
+
+NAME
+----
+nvme-resv-release - Release an nvme reservation
+
+SYNOPSIS
+--------
+[verse]
+'nvme resv-release' <device> [--namespace-id=<nsid> | -n <nsid>]
+ [--crkey=<crkey> | -c <crkey>]
+ [--rtype=<rtype> | -t <rtype>]
+ [--rrela=<rrela> | -a <rrela>] [--iekey | -i]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+The Reservation Release command is used to release or clear a reservation
+held on a namespace.
+
+OPTIONS
+-------
+-n <nsid>::
+--namespace-id=<nsid>::
+ Override the nsid field. If using the admin character device,
+ this parameter is required.
+
+-c <crkey>::
+--crkey=<crkey>::
+ Current Reservation Key: If the Reservation Register Action is
+ 001b (i.e., Unregister Reservation Key) or 010b (i.e., Replace
+ Reservation Key), then this field contains the current reservation
+ key associated with the host. For all other Reservation Register
+ Action values, this field is reserved. The controller ignores
+ the value of this field when the Ignore Existing Key (IEKEY)
+ bit is set to ‘1’.
+
+-t <rtype>::
+--rtype=<rtype>::
+ Reservation Type: This field specifies the type of reservation
+ to be created.
++
+[]
+|=================
+|Value|Definition
+|0h|Reserved
+|1h|Write Exclusive Reservation
+|2h|Exclusive Access Reservation
+|3h|Write Exclusive - Registrants Only Reservation
+|4h|Exclusive Access - Registrants Only Reservation
+|5h|Write Exclusive - All Registrants Reservation
+|6h|Exclusive Access - All Registrants Reservation
+|07h-FFh|Reserved
+|=================
+
+-a <rrela>::
+--rrela=<rrela>::
+ Reservation Release Action: This field specifies the registration
+ action that is performed by the command.
++
+[]
+|=================
+|Value|Definition
+|0|Release
+|1|Clear
+|2-7|Reserved
+|=================
+
+-i::
+--iekey::
+ Ignore Existing Key: If this bit is set to a '1', then the
+ Current Reservation Key (CRKEY) check is disabled and the command
+ shall succeed regardless of the CRKEY field value.
++
+Indicator option, defaults to '0'.
+
+-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