nvme-resv-acquire - Man Page

Acquire an nvme reservation

Synopsis

nvme resv-acquire <device> [--namespace-id=<nsid> | -n <nsid>]
                        [--crkey=<crkey> | -c <crkey>]
                        [--prkey=<prkey> | -p <prkey>]
                        [--rtype=<rtype> | -t <rtype>]
                        [--racqa=<racqa> | -a <racqa>] [--iekey | -i]
                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
                        [--timeout=<timeout>]

Description

The Reservation Acquire command is used to acquire a reservation on a namespace, preempt a reservation held on a namespace, and abort 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: The field specifies the current reservation key associated with the host​. If the IEKEY bit is set to ‘1’ in the command, then the CRKEY check succeeds regardless of the value in this field​.

-p <prkey>, --prkey=<prkey>

Preempt Reservation Key: If the Reservation Acquire Action is set to 001b (i​.e​., Preempt) or 010b (i​.e​., Preempt and Abort), then this field specifies the reservation key to be unregistered from the namespace​. For all other Reservation Acquire Action values, this field is reserved​.

-t <rtype>, --rtype=<rtype>

Reservation Type: This field specifies the type of reservation to be created​.

ValueDefinition
0hReserved
1hWrite Exclusive Reservation
2hExclusive Access Reservation
3hWrite Exclusive - Registrants Only Reservation
4hExclusive Access - Registrants Only Reservation
5hWrite Exclusive - All Registrants Reservation
6hExclusive Access - All Registrants Reservation
07h-FFhReserved
-a <racqa>, --racqa=<racqa>

Reservation Acquire Action: This field specifies the action that is performed by the command​.

ValueDefinition
0Acquire
1Preempt
2Preempt and Abort
3-7Reserved
-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​.

-o <fmt>, --output-format=<fmt>

Set the reporting format to normal, json or binary​. Only one output format can be used at a time​.

-v,  --verbose

Increase the information detail in the output​.

--timeout=<timeout>

Override default timeout value​. In milliseconds​.

Examples

No examples yet

Nvme

Part of the nvme-user suite

Referenced By

nvme(1).

08/18/2026 NVMe Manual