nvme-registry-retrieve1
Read an attribute from a controller's registry entry
Usage
nvme {[<global-options>]
registry
retrieve
<device>
--attr=<ATTR> | -a
<ATTR>}
Overview
Read a single attribute from 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 (e.g. /run/nvme/registry/nvme3/owner).
The <device> is the NVMe controller name (e.g. nvme3), given as a positional argument; the /dev/ prefix is optional.
Options
-
-a <ATTR>, --attr=<ATTR> -
Attribute name to retrieve (e.g. owner, note). Required.
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
• Retrieve the owner of nvme3:
# nvme registry retrieve nvme3 --attr owner stas
Nvme
Part of the nvme-user suite