NVME-RESV-REGISTER(1)

📦
version 3.2 · 14 versions
, in arch rolling

💅 NVME-RESV-REGISTER(1) — the nvme-resv-register page, but make it make sense

okay so bestie, this is a page from the NVMe Manual and it's literally all about registering an nvme reservation. yes it's as niche as it sounds and yes you're gonna slay it. 🎀

✨ NAME ✨

nvme-resv-register — register an nvme reservation 🦋

✨ SYNOPSIS ✨

nvme [<global-options>] 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]

✨ DESCRIPTION ✨

so the Reservation Register command is the main character here — it's the one that registers, unregisters, or replaces a reservation key. that's the whole vibe. 💅

and listen — the old bare nvme resv-register form (no space in the middle, iykyk) still works, but it's a deprecated alias and it's getting yeeted in a future major version. so like, new scripts should use nvme resv register instead, okay? don't be that person. 🫶

✨ OPTIONS ✨

  • -n <nsid>, --namespace-id=<nsid> — overrides the nsid field. 🎀 if you're using the admin character device, this one is required — no skipping it. the broadcast value 0xffffffff can also be given as all or -1.
  • -c <crkey>, --crkey=<crkey> — Current Reservation Key. so if the Reservation Register Action is 001b (that's Unregister Reservation Key) or 010b (Replace Reservation Key), then this field holds the current reservation key associated with the host 🦋. for every other Reservation Register Action value, this field is reserved. oh and — the controller ignores this field's value when the Ignore Existing Key (IEKEY) bit is set to '1'. so like, don't stress about it then 💀.
  • -k <nrkey>, --nrkey=<nrkey> — New Reservation Key. if the Reservation Register Action is 000b (Register Reservation Key) or 010b (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. periodt.
  • -p <cptpl>, --cptpl=<cptpl> — Change Persist Through Power Loss State. this field lets the Persist Through Power Loss state associated with the namespace be modified as a side effect of processing this command 🧚. the values:
    • 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.

(yes i turned the table into bullets, you're welcome, it reads so much better 💖)

  • -r <rrega>, --rrega=<rrega> — Reservation Register Action. this field specifies the registration action that gets performed by the command 👑:
    • 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.

✨ GLOBAL OPTIONS ✨

these bad boys are defined at the top-level nvme command, and they're available to this subcommand too — so you're never locked out 🫶:

  • --dry-run — prints the command that would be executed, but doesn't actually execute it. vibe check first, commit later 💅
  • --no-ioctl-probing — disables probing for 64-bit IOCTL support.
  • --no-retries — disables retry logic on transient errors.
  • -o <fmt>, --output-format=<fmt> — sets the reporting format to normal, tabular, 'json, or binary. only one output format at a time, bestie — pick a lane ✨.
  • --output-format-version=<version> — selects the output format version. version 1 uses the original field naming, while version 2 (the default) provides more consistent and script-friendly field names. other versions are rejected 🙈.
  • --quiet — suppresses informational messages. errors are still reported, and --quiet cancels any --verbose for the library log level 🤫.
  • --set-options=<key=value>[,<key=value>...] — sets libnvme library options for this invocation. supported keys are force-4k, mi-probe-enabled, test-base-dir and test-sysfs-dir 🎀.
  • --timeout=<ms> — sets the timeout for the command in milliseconds. infinite or -1 waits without a time limit (0xffffffff) ⭐.
  • -v, --verbose — increases the level of detail in the output. may be specified multiple times to further increase verbosity 🔥.
these options can also be set as machine-wide defaults in nvme-cli.conf(5). a command-line flag always overrides the file. no cap. 💜

✨ EXAMPLES ✨

No examples yet 😭 (literally just vibes and an empty section, we move)

✨ NVME ✨

Part of the nvme-user suite 🌈

and that's the whole page bestie, go forth and register those reservations 💖✨🦋

sign-off: this gorgeous little manual page is from the nvme-user suite, dated 10/30/2026 — the NVMe version of "posted from my phone" 🎀

📦 where this page comes from