nvme-exclusion-add1
Add an entry to an nvme-of exclusion list
Usage
nvme {[<global-options>]
exclusion
add
[{--name=<NAME> | -N
<NAME>}]
--entry=<ENTRY> | -e
<ENTRY>}
Overview
Append an entry to the NVMe-oF exclusion list named <NAME>, creating the list if it does not exist. The entry is a semicolon-separated list of key=value fields; a controller is excluded when it matches every field present in the entry.
The recognized field keys are the nvme connect option names: transport, traddr, trsvcid, nqn, host-traddr, host-iface, hostnqn and hostid. Only the fields given are matched, so a single key excludes broadly and more keys narrow the match. See the exclusion list overview (EXCLUSIONS.md) for the full match semantics.
The entry is validated before it is written; an entry with an unknown key, or with no recognized field, is rejected. This command requires root.
Options
-
-N <NAME>, --name=<NAME> -
Name of the exclusion list to add to. Omit to add to the default list (/etc/nvme/exclusions.conf).
-
-e <ENTRY>, --entry=<ENTRY> -
The entry to add, e.g. "transport=tcp;traddr=192.0.2.10;nqn=...".
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
• Exclude a single path to a subsystem:
# nvme exclusion add --name user \
--entry "transport=tcp;traddr=192.0.2.10;trsvcid=4420;nqn=nqn.2024-01.com.example:vol1"
• Exclude a whole subsystem on every transport and address:
# nvme exclusion add --name user --entry "nqn=nqn.2024-01.com.example:retired"
Nvme
Part of the nvme-user suite