nvme-resv-report(1)

SYNOPSIS

nvme [<global-options>] resv report <device>
                        [--namespace-id=<nsid> | -n <nsid>]
                        [--numd=<num-dwords> | -d <num-dwords>]
                        [--eds | -e]
                        [--raw-binary | -b]

DESCRIPTION

The Reservation Report command returns a Reservation Status data structure to host memory that describes the registration and reservation status of a namespace.

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

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 --numd to transfer a fixed length instead.

The bare nvme resv-report form (without a space) still works as a deprecated alias and will be removed in a future major version. New scripts should use nvme resv report instead.

OPTIONS

-n <nsid>
--namespace-id=<nsid>: 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 all or -1.
-d <num-dwords>
--numd=<num-dwords>: 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.
-e
--eds: Request extended Data Structure: If this bit is set to a 1, then the controller returns the Extended Data Structure.
-b
--raw-binary: Print the raw buffer to stdout. Structure is not parsed by program.

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. Other versions are rejected.
--quiet: Suppress informational messages. Errors are still reported, and --quiet cancels any --verbose for the library log level.
--set-options=<key=value>[,<key=value>…]: Set libnvme library options for this invocation. Supported keys are force-4k, mi-probe-enabled, test-base-dir and test-sysfs-dir.
--timeout=<ms>: Set the timeout for the command in milliseconds. infinite or -1 waits without a time limit (0xffffffff).
-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

No examples yet.

NVME

Part of the nvme-user suite