'\" t
.\"     Title: nvme-exclusion-add
.\"    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\-EXCLUSION\-ADD" "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-exclusion-add \- Add an entry to an NVMe\-oF exclusion list
.SH "SYNOPSIS"
.sp
.nf
\fInvme\fR [<global\-options>] \fIexclusion add\fR [\-\-name=<NAME> | \-N <NAME>]
                        \-\-entry=<ENTRY> | \-e <ENTRY>
.fi
.SH "DESCRIPTION"
.sp
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\&.
.sp
The recognized field keys are the \fInvme connect\fR 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\&.
.sp
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\&.
.SH "OPTIONS"
.PP
\-N <NAME>, \-\-name=<NAME>
.RS 4
Name of the exclusion list to add to\&. Omit to add to the default list (/etc/nvme/exclusions\&.conf)\&.
.RE
.PP
\-e <ENTRY>, \-\-entry=<ENTRY>
.RS 4
The entry to add, e\&.g\&. "transport=tcp;traddr=192\&.0\&.2\&.10;nqn=\&..."\&.
.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
.\}
Exclude a single path to a subsystem:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme exclusion add \-\-name user \e
        \-\-entry "transport=tcp;traddr=192\&.0\&.2\&.10;trsvcid=4420;nqn=nqn\&.2024\-01\&.com\&.example:vol1"
.fi
.if n \{\
.RE
.\}
.RE
.sp
.RS 4
.ie n \{\
\h'-04'\(bu\h'+03'\c
.\}
.el \{\
.sp -1
.IP \(bu 2.3
.\}
Exclude a whole subsystem on every transport and address:
.sp
.if n \{\
.RS 4
.\}
.nf
# nvme exclusion add \-\-name user \-\-entry "nqn=nqn\&.2024\-01\&.com\&.example:retired"
.fi
.if n \{\
.RE
.\}
.RE
.SH "SEE ALSO"
.sp
nvme\-exclusion\-remove(1) nvme\-exclusion\-list(1) nvme\-exclusion\-edit(1) nvme\-disconnect(1)
.SH "NVME"
.sp
Part of the nvme\-user suite