'\" t
.\"     Title: nvme-resv-report
.\"    Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author]
.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/>
.\"      Date: 10/30/2026
.\"    Manual: NVMe Manual
.\"    Source: NVMe
.\"  Language: English
.\"
.TH "NVME\-RESV\-REPORT" "1" "10/30/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-resv-report \- Send NVMe Reservation Report, parse the result
.SH "SYNOPSIS"
.sp
.nf
\fInvme\fR [<global\-options>] \fIresv report\fR <device>
                        [\-\-namespace\-id=<nsid> | \-n <nsid>]
                        [\-\-numd=<num\-dwords> | \-d <num\-dwords>]
                        [\-\-eds | \-e]
                        [\-\-raw\-binary | \-b]
.fi
.SH "DESCRIPTION"
.sp
The Reservation Report command returns a Reservation Status data structure to host memory that describes the registration and reservation status of a namespace\&.
.sp
The size of the Reservation Status data structure is a function of the number of controllers in the NVM Subsystem that are associated with hosts that are registrants of the namespace (i\&.e\&., there is a Registered Controller data structure for each such controller)\&.
.sp
That size is not known in advance, so the transfer is sized automatically: the fixed\-size header of the structure is read first, and the structure is then read again with a buffer large enough to hold every registrant the namespace reports\&. Pass \fI\-\-numd\fR to transfer a fixed length instead\&.
.sp
The bare \fInvme resv\-report\fR form (without a space) still works as a deprecated alias and will be removed in a future major version\&. New scripts should use \fInvme resv report\fR instead\&.
.SH "OPTIONS"
.PP
\-n <nsid>, \-\-namespace\-id=<nsid>
.RS 4
Retrieve the reservation report structure for the given nsid\&. This is required for the character devices, or overrides the block nsid if given\&. The broadcast value 0xffffffff can also be given as
\fIall\fR
or
\fI\-1\fR\&.
.RE
.PP
\-d <num\-dwords>, \-\-numd=<num\-dwords>
.RS 4
Transfer a fixed number of Dwords of the Reservation Status structure instead of sizing the transfer automatically\&. The count is zero\-based, so one Dword more than requested is transferred\&.
.RE
.PP
\-e, \-\-eds
.RS 4
Request extended Data Structure: If this bit is set to a
\fI1\fR, then the controller returns the Extended Data Structure\&.
.RE
.PP
\-b, \-\-raw\-binary
.RS 4
Print the raw buffer to stdout\&. Structure is not parsed by program\&.
.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\&. Other versions are rejected\&.
.RE
.PP
\-\-quiet
.RS 4
Suppress informational messages\&. Errors are still reported, and \-\-quiet cancels any \-\-verbose for the library log level\&.
.RE
.PP
\-\-set\-options=<key=value>[,<key=value>\&...]
.RS 4
Set libnvme library options for this invocation\&. Supported keys are
\fIforce\-4k\fR,
\fImi\-probe\-enabled\fR,
\fItest\-base\-dir\fR
and
\fItest\-sysfs\-dir\fR\&.
.RE
.PP
\-\-timeout=<ms>
.RS 4
Set the timeout for the command in milliseconds\&.
\fIinfinite\fR
or
\fI\-1\fR
waits without a time limit (0xffffffff)\&.
.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
No examples yet\&.
.SH "NVME"
.sp
Part of the nvme\-user suite