diff options
Diffstat (limited to 'Documentation/nvme-disconnect.1')
-rw-r--r-- | Documentation/nvme-disconnect.1 | 115 |
1 files changed, 115 insertions, 0 deletions
diff --git a/Documentation/nvme-disconnect.1 b/Documentation/nvme-disconnect.1 new file mode 100644 index 0000000..2fcf331 --- /dev/null +++ b/Documentation/nvme-disconnect.1 @@ -0,0 +1,115 @@ +'\" t +.\" Title: nvme-disconnect +.\" Author: [FIXME: author] [see http://www.docbook.org/tdg5/en/html/author] +.\" Generator: DocBook XSL Stylesheets vsnapshot <http://docbook.sf.net/> +.\" Date: 02/14/2024 +.\" Manual: NVMe Manual +.\" Source: NVMe +.\" Language: English +.\" +.TH "NVME\-DISCONNECT" "1" "02/14/2024" "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-disconnect \- Disconnect one or more Fabrics controller(s)\&. +.SH "SYNOPSIS" +.sp +.nf +\fInvme disconnect\fR [\-\-nqn=<subnqn> | \-n <subnqn>] + [\-\-device=<device> | \-d <device>] + [\-\-output\-format=<fmt> | \-o <fmt>] [\-\-verbose | \-v] +.fi +.SH "DESCRIPTION" +.sp +Disconnects and removes one or more existing NVMe over Fabrics controllers\&. If the \-\-nqn option is specified all controllers connecting to the Subsystem identified by subnqn will be removed\&. If the \-\-device option is specified the controller specified by the \-\-device option will be removed\&. +.SH "OPTIONS" +.PP +\-n <subnqn>, \-\-nqn <subnqn> +.RS 4 +Indicates that all controllers for the NVMe subsystems specified should be removed\&. +.RE +.PP +\-d <device>, \-\-device <device> +.RS 4 +Indicates that the controller with the specified name should be removed\&. +.RE +.PP +\-o <fmt>, \-\-output\-format=<fmt> +.RS 4 +Set the reporting format to +\fInormal\fR, +\fIjson\fR +or +\fIbinary\fR\&. Only one output format can be used at a time\&. +.RE +.PP +\-v, \-\-verbose +.RS 4 +Increase the information detail in the output\&. +.RE +.SH "EXAMPLES" +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Disconnect all controllers for a subsystem named nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432: +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme disconnect \-\-nqn=nqn\&.2014\-08\&.com\&.example:nvme:nvm\-subsystem\-sn\-d78432 +.fi +.if n \{\ +.RE +.\} +.RE +.sp +.RS 4 +.ie n \{\ +\h'-04'\(bu\h'+03'\c +.\} +.el \{\ +.sp -1 +.IP \(bu 2.3 +.\} +Disconnect the controller nvme4 +.sp +.if n \{\ +.RS 4 +.\} +.nf +# nvme disconnect \-\-device=nvme4 +.fi +.if n \{\ +.RE +.\} +.RE +.SH "SEE ALSO" +.sp +nvme\-connect(1) +.SH "NVME" +.sp +Part of the nvme\-user suite |