NVME-REGISTRY-UPDA(1)

NAME
nvme-registry-update - Write an attribute to a controller's registry entry

SYNOPSIS

nvme [<global-options>] registry update <device>
                        --attr=<ATTR> | -a <ATTR>
                        --value=<VAL> | -V <VAL>

DESCRIPTION

Write an attribute to the ownership registry entry for an NVMe-oF controller. The registry is stored under /run/nvme/registry/ as one directory per live controller, with one plain-text file per attribute. The entry directory is created if it does not already exist.

The <device> is the NVMe controller name (e.g. nvme3), given as a positional argument; the /dev/ prefix is optional.

The owner attribute is normally recorded when the connection is created (e.g. by nvme connect --owner). Changing it by hand can stop an orchestrator from protecting the controller, so updating owner prompts for confirmation when run interactively; non-interactive callers (scripts) proceed without prompting. This is a guard against accidental mistakes, not access control — a user with root can edit the files under /run/nvme/registry/ directly.

Writes are atomic: a temporary file is written and synced, then renamed into place, preventing corruption under concurrent access.

OPTIONS

-a <ATTR>, --attr=<ATTR>
    Attribute name to write (e.g. note, owner).

-V <VAL>, --value=<VAL>
    New attribute value.

GLOBAL OPTIONS

The following options are defined at the top-level nvme command and are available to this subcommand:

--dry-run
    Print the command that would be executed, but do not actually execute it.

--no-ioctl-probing
    Disable probing for 64-bit IOCTL support.

--no-retries
    Disable retry logic on transient errors.

-o <fmt>, --output-format=<fmt>
    Set the reporting format to normal, tabular, 'json, or binary. Only one output format may be used at a time.

--output-format-version=<version>
    Select the output format version. Version 1 uses the original field naming, while version 2 (default) provides more consistent and script-friendly field names.

--timeout=<ms>
    Set the timeout for the command in milliseconds.

-v, --verbose
    Increase 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.

EXAMPLES

    • Attach a free-form note to nvme3:

        # nvme registry update nvme3 --attr note --value "maintenance 2026-07"

    • Update a previously written note:

        # nvme registry update nvme3 --attr note --value "released"

SEE ALSO

nvme-registry-list(1) nvme-registry-retrieve(1) nvme-registry-delete(1) nvme-disconnect-all(1)

NVME

Part of the nvme-user suite