Skip site navigation (1)Skip section navigation (2)

FreeBSD Manual Pages

  
 
  

home | help
NVME-RESV-ACQUIRE(1)		   NVMe Manual		    NVME-RESV-ACQUIRE(1)

NAME
     nvme-resv-acquire - 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 name-
     space,  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  pa-
	 rameter 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  re-
	 served.

     -t <rtype>, --rtype=<rtype>
	 Reservation  Type:  This  field specifies the type of reservation to be
	 created.
	 +---------+-----------------------------+
	 | Value   | Definition 		 |
	 +---------+-----------------------------+
	 | 0h	   | Reserved			 |
	 +---------+-----------------------------+
	 | 1h	   | Write Exclusive Reservation |
	 +---------+-----------------------------+
	 | 2h	   | Exclusive	Access	Reserva- |
	 |	   | tion			 |
	 +---------+-----------------------------+
	 | 3h	   | Write  Exclusive  -  Regis- |
	 |	   | trants Only Reservation	 |
	 +---------+-----------------------------+
	 | 4h	   | Exclusive Access  -  Regis- |
	 |	   | trants Only Reservation	 |
	 +---------+-----------------------------+
	 | 5h	   | Write  Exclusive - All Reg- |
	 |	   | istrants Reservation	 |
	 +---------+-----------------------------+
	 | 6h	   | Exclusive Access - All Reg- |
	 |	   | istrants 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 Reser-
	 vation  Key (CRKEY) check is disabled and the command shall succeed re-
	 gardless 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

NVMe				   10/31/2024		    NVME-RESV-ACQUIRE(1)

Want to link to this manual page? Use this URL:
<https://man.freebsd.org/cgi/man.cgi?query=nvme-resv-acquire&sektion=1&manpath=FreeBSD+Ports+15.1.quarterly>

home | help