summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-resv-release.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-release.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-release.txt')
-rw-r--r--Documentation/nvme-resv-release.txt84
1 files changed, 84 insertions, 0 deletions
diff --git a/Documentation/nvme-resv-release.txt b/Documentation/nvme-resv-release.txt
new file mode 100644
index 0000000..a6a895e
--- /dev/null
+++ b/Documentation/nvme-resv-release.txt
@@ -0,0 +1,84 @@
+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]
+
+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>::
+--rtyep=<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'.
+
+EXAMPLES
+--------
+No examples yet
+
+NVME
+----
+Part of the nvme-user suite