summaryrefslogtreecommitdiffstats
path: root/Documentation/nvme-disconnect.txt
diff options
context:
space:
mode:
Diffstat (limited to 'Documentation/nvme-disconnect.txt')
-rw-r--r--Documentation/nvme-disconnect.txt64
1 files changed, 64 insertions, 0 deletions
diff --git a/Documentation/nvme-disconnect.txt b/Documentation/nvme-disconnect.txt
new file mode 100644
index 0000000..d3b8c52
--- /dev/null
+++ b/Documentation/nvme-disconnect.txt
@@ -0,0 +1,64 @@
+nvme-disconnect(1)
+==================
+
+NAME
+----
+nvme-disconnect - Disconnect one or more Fabrics controller(s).
+
+SYNOPSIS
+--------
+[verse]
+'nvme disconnect' [--nqn=<subnqn> | -n <subnqn>]
+ [--device=<device> | -d <device>]
+ [--output-format=<fmt> | -o <fmt>] [--verbose | -v]
+
+DESCRIPTION
+-----------
+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.
+
+OPTIONS
+-------
+-n <subnqn>::
+--nqn <subnqn>::
+ Indicates that all controllers for the NVMe subsystems specified
+ should be removed.
+
+-d <device>::
+--device <device>::
+ Indicates that the controller with the specified name should be
+ removed.
+
+-o <fmt>::
+--output-format=<fmt>::
+ Set the reporting format to 'normal', 'json' or 'binary'. Only one
+ output format can be used at a time.
+
+-v::
+--verbose::
+ Increase the information detail in the output.
+
+EXAMPLES
+--------
+* Disconnect all controllers for a subsystem named
+nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432:
++
+------------
+# nvme disconnect --nqn=nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+------------
+
+* Disconnect the controller nvme4
++
+------------
+# nvme disconnect --device=nvme4
+------------
+
+SEE ALSO
+--------
+nvme-connect(1)
+
+NVME
+----
+Part of the nvme-user suite