1NVME-RESV-RELEASE(1)              NVMe Manual             NVME-RESV-RELEASE(1)
2
3
4

NAME

6       nvme-resv-release - Release an nvme reservation
7

SYNOPSIS

9       nvme resv-release <device> [--namespace-id=<nsid> | -n <nsid>]
10                                    [--crkey=<crkey> | -c <crkey>]
11                                    [--rtype=<rtype> | -t <rtype>]
12                                    [--rrela=<rrela> | -a <rrela>]
13                                    [--iekey | -i]
14

DESCRIPTION

16       The Reservation Release command is used to release or clear a
17       reservation held on a namespace.
18

OPTIONS

20       -n <nsid>, --namespace-id=<nsid>
21           Override the nsid field. If using the admin character device, this
22           parameter is required.
23
24       -c <crkey>, --crkey=<crkey>
25           Current Reservation Key: If the Reservation Register Action is 001b
26           (i.e., Unregister Reservation Key) or 010b (i.e., Replace
27           Reservation Key), then this field contains the current reservation
28           key associated with the host. For all other Reservation Register
29           Action values, this field is reserved. The controller ignores the
30           value of this field when the Ignore Existing Key (IEKEY) bit is set
31           to ‘1’.
32
33       -t <rtype>, --rtype=<rtype>
34           Reservation Type: This field specifies the type of reservation to
35           be created.
36
37           ┌────────┬─────────────────────────┐
38           │Value   │ Definition              │
39           ├────────┼─────────────────────────┤
40           │0h      │ Reserved                │
41           ├────────┼─────────────────────────┤
42           │1h      │ Write Exclusive         │
43           │        │ Reservation             │
44           ├────────┼─────────────────────────┤
45           │2h      │ Exclusive Access        │
46           │        │ Reservation             │
47           ├────────┼─────────────────────────┤
48           │3h      │ Write Exclusive -       │
49           │        │ Registrants Only        │
50           │        │ Reservation             │
51           ├────────┼─────────────────────────┤
52           │4h      │ Exclusive Access -      │
53           │        │ Registrants Only        │
54           │        │ Reservation             │
55           ├────────┼─────────────────────────┤
56           │5h      │ Write Exclusive - All   │
57           │        │ Registrants Reservation │
58           ├────────┼─────────────────────────┤
59           │6h      │ Exclusive Access - All  │
60           │        │ Registrants Reservation │
61           ├────────┼─────────────────────────┤
62           │07h-FFh │ Reserved                │
63           └────────┴─────────────────────────┘
64
65       -a <rrela>, --rrela=<rrela>
66           Reservation Release Action: This field specifies the registration
67           action that is performed by the command.
68
69           ┌──────┬────────────┐
70           │Value │ Definition │
71           ├──────┼────────────┤
72           │0     │ Release    │
73           ├──────┼────────────┤
74           │1     │ Clear      │
75           ├──────┼────────────┤
76           │2-7   │ Reserved   │
77           └──────┴────────────┘
78
79       -i, --iekey
80           Ignore Existing Key: If this bit is set to a 1, then the Current
81           Reservation Key (CRKEY) check is disabled and the command shall
82           succeed regardless of the CRKEY field value.
83
84           Indicator option, defaults to 0.
85

EXAMPLES

87       No examples yet
88

NVME

90       Part of the nvme-user suite
91
92
93
94NVMe                              10/06/2023              NVME-RESV-RELEASE(1)