2025-02-16 11:09:01 +01:00
|
|
|
|
nvme-resv-acquire(1)
|
|
|
|
|
|
====================
|
|
|
|
|
|
|
|
|
|
|
|
NAME
|
|
|
|
|
|
----
|
|
|
|
|
|
nvme-resv-acquire - Acquire an nvme reservation
|
|
|
|
|
|
|
|
|
|
|
|
SYNOPSIS
|
|
|
|
|
|
--------
|
|
|
|
|
|
[verse]
|
|
|
|
|
|
'nvme resv-acquire' <device> [--namespace-id=<nsid> | -n <nsid>]
|
2025-02-16 12:25:41 +01:00
|
|
|
|
[--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]
|
2025-02-16 11:09:01 +01:00
|
|
|
|
|
|
|
|
|
|
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>::
|
2025-02-16 11:31:10 +01:00
|
|
|
|
--rtype=<rtype>::
|
2025-02-16 11:09:01 +01:00
|
|
|
|
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 <racqa>::
|
|
|
|
|
|
--racqa=<racqa>::
|
|
|
|
|
|
Reservation Acquire Action: This field specifies the action that
|
|
|
|
|
|
is performed by the command.
|
|
|
|
|
|
+
|
|
|
|
|
|
[]
|
|
|
|
|
|
|=================
|
|
|
|
|
|
|Value|Definition
|
|
|
|
|
|
|0|Acquire
|
|
|
|
|
|
|1|Preempt
|
|
|
|
|
|
|2|Preempt and Abort
|
|
|
|
|
|
|3-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
|
2025-02-16 12:25:41 +01:00
|
|
|
|
shall succeed regardless of the CRKEY field value.
|
2025-02-16 11:09:01 +01:00
|
|
|
|
+
|
|
|
|
|
|
Indicator option, defaults to '0'.
|
|
|
|
|
|
|
2025-02-16 12:25:41 +01:00
|
|
|
|
-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.
|
|
|
|
|
|
|
2025-02-16 11:09:01 +01:00
|
|
|
|
EXAMPLES
|
|
|
|
|
|
--------
|
|
|
|
|
|
No examples yet
|
|
|
|
|
|
|
|
|
|
|
|
NVME
|
|
|
|
|
|
----
|
|
|
|
|
|
Part of the nvme-user suite
|
