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

NAME

6       nvme-resv-register - Register an nvme reservation
7

SYNOPSIS

9       nvme resv-register <device> [--namespace-id=<nsid> | -n <nsid>]
10                                     [--crkey=<crkey> | -c <crkey>]
11                                     [--nrkey=<nrkey> | -k <nrkey>]
12                                     [--rrega=<rrega> | -r <rrega>]
13                                     [--cptpl=<cptpl> | -p <cptpl>]
14                                     [--iekey | -i]
15

DESCRIPTION

17       The Reservation Register command is used to register, unregister, or
18       replace a reservation key.
19

OPTIONS

21       -n <nsid>, --namespace-id=<nsid>
22           Override the nsid field. If using the admin character device, this
23           parameter is required.
24
25       -c <crkey>, --crkey=<crkey>
26           Current Reservation Key: If the Reservation Register Action is 001b
27           (i.e., Unregister Reservation Key) or 010b (i.e., Replace
28           Reservation Key), then this field contains the current reservation
29           key associated with the host. For all other Reservation Register
30           Action values, this field is reserved. The controller ignores the
31           value of this field when the Ignore Existing Key (IEKEY) bit is set
32           to ‘1’.
33
34       -k <nrkey>, --nrkey=<nrkey>
35           New Reservation Key: If the Reservation Register Action is 000b
36           (i.e., Register Reservation Key) or 010b (i.e., Replace Reservation
37           Key), then this field contains the new reservation key associated
38           with the host. For all other Reservation Register Action values,
39           this field is reserved.
40
41       -p <cptpl>, --cptpl=<cptpl>
42           Change Persist Through Power Loss State: This field allows the
43           Persist Through Power Loss state associated with the namespace to
44           be modified as a side effect of processing this command.
45
46           ┌──────┬────────────────────────────┐
47           │Value │ Definition                 │
48           ├──────┼────────────────────────────┤
49           │0     │ No change to PTPL state    │
50           ├──────┼────────────────────────────┤
51           │1     │ Reserved                   │
52           ├──────┼────────────────────────────┤
53           │2     │ Set PTPL state to ‘0’.     │
54           │      │ Reservations are released  │
55           │      │ and registrants are        │
56           │      │ cleared on a power on.     │
57           ├──────┼────────────────────────────┤
58           │3     │ Set PTPL state to ‘1’.     │
59           │      │ Reservations and           │
60           │      │ registrants persist across │
61           │      │ a power loss.              │
62           └──────┴────────────────────────────┘
63
64       -a <rrega>, --rrega=<rrega>
65           Reservation Register Action: This field specifies the registration
66           action that is performed by the command.
67
68           ┌──────┬────────────────────────────┐
69           │Value │ Definition                 │
70           ├──────┼────────────────────────────┤
71           │0     │ Register Reservation Key   │
72           ├──────┼────────────────────────────┤
73           │1     │ Unregister Reservation Key │
74           ├──────┼────────────────────────────┤
75           │2     │ Replace Reservation Key    │
76           ├──────┼────────────────────────────┤
77           │3-7   │ Reserved                   │
78           └──────┴────────────────────────────┘
79
80       -i, --iekey
81           Ignore Existing Key: If this bit is set to a 1, then the Current
82           Reservation Key (CRKEY) check is disabled and the command shall
83           succeed regardless of the CRKEY field value.
84
85           Indicator option, defaults to 0.
86

EXAMPLES

88       No examples yet
89

NVME

91       Part of the nvme-user suite
92
93
94
95NVMe                              01/07/2020             NVME-RESV-REGISTER(1)
Impressum