summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-resv-release.txt
blob: a6a895e891370150b8ffd734e0b66008cdb803ea (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
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