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

NAME

6       nvme-resv-acquire - Acquire an nvme reservation
7

SYNOPSIS

9       nvme resv-acquire <device> [--namespace-id=<nsid> | -n <nsid>]
10                                    [--crkey=<crkey> | -c <crkey>]
11                                    [--prkey=<prkey> | -p <prkey>]
12                                    [--rtype=<rtype> | -t <rtype>]
13                                    [--racqa=<racqa> | -a <racqa>]
14                                    [--iekey | -i]
15

DESCRIPTION

17       The Reservation Acquire command is used to acquire a reservation on a
18       namespace, preempt a reservation held on a namespace, and abort a
19       reservation held on a namespace.
20

OPTIONS

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

EXAMPLES

95       No examples yet
96

NVME

98       Part of the nvme-user suite
99
100
101
102NVMe                              09/29/2023              NVME-RESV-ACQUIRE(1)