From f26f66d866ba1a9f3204e6fdfe2b07e67b5492ad Mon Sep 17 00:00:00 2001 From: Daniel Baumann Date: Wed, 10 Apr 2024 21:41:32 +0200 Subject: Adding upstream version 2.8. Signed-off-by: Daniel Baumann --- Documentation/nvme-resv-register.html | 967 ++++++++++++++++++++++++++++++++++ 1 file changed, 967 insertions(+) create mode 100644 Documentation/nvme-resv-register.html (limited to 'Documentation/nvme-resv-register.html') diff --git a/Documentation/nvme-resv-register.html b/Documentation/nvme-resv-register.html new file mode 100644 index 0000000..fb78ac7 --- /dev/null +++ b/Documentation/nvme-resv-register.html @@ -0,0 +1,967 @@ + + + + + + +nvme-resv-register(1) + + + + + +
+
+

SYNOPSIS

+
+
+
nvme resv-register <device> [--namespace-id=<nsid> | -n <nsid>]
+                        [--crkey=<crkey> | -c <crkey>]
+                        [--nrkey=<nrkey> | -k <nrkey>]
+                        [--rrega=<rrega> | -r <rrega>]
+                        [--cptpl=<cptpl> | -p <cptpl>] [--iekey | -i]
+                        [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+
+
+
+
+

DESCRIPTION

+
+

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

+
+
+
+

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: If the Reservation Register Action is + 001b (i.e., Unregister Reservation Key) or 010b (i.e., Replace + Reservation Key), then this field contains the current reservation + key associated with the host. For all other Reservation Register + Action values, this field is reserved. The controller ignores + the value of this field when the Ignore Existing Key (IEKEY) + bit is set to ‘1’. +

+
+
+-k <nrkey> +
+
+--nrkey=<nrkey> +
+
+

+ New Reservation Key: If the Reservation Register Action is + 000b (i.e., Register Reservation Key) or 010b (i.e., Replace + Reservation Key), then this field contains the new reservation + key associated with the host. For all other Reservation Register + Action values, this field is reserved. +

+
+
+-p <cptpl> +
+
+--cptpl=<cptpl> +
+
+

+ Change Persist Through Power Loss State: This field allows the + Persist Through Power Loss state associated with the namespace + to be modified as a side effect of processing this command. +

+
+ +++ + + + + + + + + + + + + + + + + + + + + + +

Value

Definition

0

No change to PTPL state

1

Reserved

2

Set PTPL state to ‘0’. Reservations are released and registrants +are cleared on a power on.

3

Set PTPL state to ‘1’. Reservations and registrants persist across +a power loss.

+
+
+
+-r <rrega> +
+
+--rrega=<rrega> +
+
+

+ Reservation Register Action: This field specifies the registration + action that is performed by the command. +

+
+ +++ + + + + + + + + + + + + + + + + + + + + + +

Value

Definition

0

Register Reservation Key

1

Unregister Reservation Key

2

Replace Reservation Key

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 + 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. +

+
+
+
+
+
+

EXAMPLES

+
+

No examples yet

+
+
+
+

NVME

+
+

Part of the nvme-user suite

+
+
+
+
+ + + -- cgit v1.2.3