'\" t
.\"     Title: nvme-registry-update
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 09/07/2026
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-REGISTRY\-UPDA" "1" "09/07/2026" "NVMe" "NVMe Manual"
.\" -----------------------------------------------------------------
.\" * Define some portability stuff
.\" -----------------------------------------------------------------
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.\" http://bugs.debian.org/507673
.\" http://lists.gnu.org/archive/html/groff/2009-02/msg00013.html
.\" ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.ie \n(.g .ds Aq \(aq
.el       .ds Aq '
.\" -----------------------------------------------------------------
.\" * set default formatting
.\" -----------------------------------------------------------------
.\" disable hyphenation
.nh
.\" disable justification (adjust text to left margin only)
.ad l
.\" -----------------------------------------------------------------
.\" * MAIN CONTENT STARTS HERE *
.\" -----------------------------------------------------------------
.SH "NAME"
nvme-registry-update \- Write an attribute to a controller\*(Aqs registry entry
.SH "SYNOPSIS"
.sp
.nf
\fInvme\fR [<global\-options>] \fIregistry update\fR <device>
                        \-\-attr=<ATTR> | \-a <ATTR>
                        \-\-value=<VAL> | \-V <VAL>
.fi
.SH "DESCRIPTION"
.sp
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\&.
.sp
The <device> is the NVMe controller name (e\&.g\&. nvme3), given as a positional argument; the /dev/ prefix is optional\&.
.sp
The \fIowner\fR attribute is normally recorded when the connection is created (e\&.g\&. by \fInvme connect \-\-owner\fR)\&. Changing it by hand can stop an orchestrator from protecting the controller, so updating \fIowner\fR prompts for confirmation when run interactively; non\-interactive callers (scripts) proceed without prompting\&. This is a guard against accidental mistakes, not access control \(em a user with root can edit the files under /run/nvme/registry/ directly\&.
.sp
Writes are atomic: a temporary file is written and synced, then renamed into place, preventing corruption under concurrent access\&.
.SH "OPTIONS"
.PP
\-a <ATTR>, \-\-attr=<ATTR>
.RS 4
Attribute name to write (e\&.g\&. note, owner)\&.
.RE
.PP
\-V <VAL>, \-\-value=<VAL>
.RS 4
New attribute value\&.
.RE
.SH "GLOBAL OPTIONS"
.sp
The following options are defined at the top\-level nvme command and are available to this subcommand:
.PP
\-\-dry\-run
.RS 4
Print the command that would be executed, but do not actually execute it\&.
.RE
.PP
\-\-no\-ioctl\-probing
.RS 4
Disable probing for 64\-bit IOCTL support\&.
.RE
.PP
\-\-no\-retries
.RS 4
Disable retry logic on transient errors\&.
.RE
.PP
\-o <fmt>, \-\-output\-format=<fmt>
.RS 4
Set the reporting format to
\fInormal\fR,
\fItabular, \*(Aqjson\fR, or
\fIbinary\fR\&. Only one output format may be used at a time\&.
.RE
.PP
\-\-output\-format\-version=<version>
.RS 4
Select the output format version\&. Version
\fI1\fR
uses the original field naming, while version
\fI2\fR
(default) provides more consistent and script\-friendly field names\&.
.RE
.PP
\-\-timeout=<ms>
.RS 4
Set the timeout for the command in milliseconds\&.
.RE
.PP
\-v, \-\-verbose
.RS 4
Increase the level of detail in the output\&. May be specified multiple times to further increase verbosity\&.
.RE
.sp
These options can also be set as machine\-wide defaults in nvme\-cli\&.conf(5)\&. A command\-line flag always overrides the file\&.
.SH "EXAMPLES"
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Attach a free\-form note to nvme3:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme registry update nvme3 \-\-attr note \-\-value "maintenance 2026\-07"
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Update a previously written note:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme registry update nvme3 \-\-attr note \-\-value "released"
.fi
.if n \{\
.RE
.\}
.RE
.SH "SEE ALSO"
.sp
nvme\-registry\-list(1) nvme\-registry\-retrieve(1) nvme\-registry\-delete(1) nvme\-disconnect\-all(1)
.SH "NVME"
.sp
Part of the nvme\-user suite