add documentation for the connect-all command

Signed-off-by: Christoph Hellwig <hch@lst.de>

diff --git a/Documentation/nvme-connect-all.txt b/Documentation/nvme-connect-all.txt
new file mode 100644 (file)
index 0000000..fa40b41
--- /dev/null
+++ b/Documentation/nvme-connect-all.txt
@@ -0,0 +1,103 @@
+nvme-connect-all(1)
+==============
+
+NAME
+----
+nvme-connect-all - Discover and Connect to Fabrics controllers.
+
+SYNOPSIS
+--------
+[verse]
+'nvme connect-all'
+               [--transport=<trtype> | -t <trtype>]
+               [--traddr=<traddr>    | -a <traddr>]
+               [--trsvcid=<trsvcid>  | -s <trsvcid>]
+               [--hostnqn=<hostnqn>  | -q <hostnqn>]
+               [--raw=<filename>     | -r <filename>]
+
+DESCRIPTION
+-----------
+Send one or more Discovery requests to a NVMe over Fabrics Discovery
+Controller, and create controllers for the returned discovery records.
+
+If no parameters are given, then 'nvme connect-all' will attempt to
+find a /etc/nvme/discovery.conf file to use to supply a list of
+Connect-all commands to run. If no /etc/nvme/discovery.conf file exists,
+the command will quit with an error.
+
+Otherwise a specific Discovery Controller should be specified using the
+--transport, --traddr and if nessecary the --trsvcid and a Diѕcovery
+request will be sent to the specified Discovery Controller.
+
+See the documentation for the nvme-discover(1) command for further
+background.
+
+OPTIONS
+-------
+-t <trtype>::
+--transport=<trtype>::
+       This field specifies the network fabric being used for
+       a NVMe-over-Fabrics network.  Current string values include:
++
+[]
+|=================
+|Value|Definition
+|rdma|The network fabric is an rdma network (RoCE, iWARP, Infiniband, basic rdma, etc)
+|fc  |*WIP* The network fabric is a Fibre Channel network.
+|loop|Connect to a NVMe over Fabrics target on the local host
+|=================
+
+-a <traddr>::
+--traddr=<traddr>::
+       This field specifies the network address of the Discovery Controller.
+       For transports using IP addressing (e.g. rdma) this should be an IPv4
+       address.
+
+-s <trsvcid>::
+--trsvcid=<trsvcid>::
+       This field specifies the transport service id.  For transports using IP
+       addressing (e.g. rdma) this field is the port number. By default, the IP
+       port number for the RDMA transport is 4420.
+ 
+-q <hostnqn>::
+--hostnqn=<hostnqn>::
+       Overrides the default host NQN that identifies the NVMe Host.  If this
+       option is not specified the default is read from /etc/nvme/hostnqn or
+       autogenerated by the kernel (in that order).
+       The Host NQN uniquely identifies the NVMe Host, and may be used by the
+       the Discovery Controller to control what NVMe Target resources are
+       allocated to the NVMe Host for a connection.
+
+EXAMPLES
+--------
+* Connect to all records returned by the Discover Controller with IP4 address
+192.168.1.3 for all resources allocated for NVMe Host name host1-rogue-nqn on
+the RDMA network. Port 4420 is used by default:
++
+------------
+# nvme connect-all --transport=rdma --traddr=192.168.1.3 \
+--hostnqn=host1-rogue-nqn
+------------
++
+* Issue a 'nvme connect-all' command using a /etc/nvme/discovery.conf file:
+-----------
+# Machine default 'nvme discover' commands.  Query the
+# Discovery Controller's two ports (some resources may only
+# be accessible on a single port).  Note an official
+# nqn (Host) name defined in the NVMe specification is being used
+# in this example.
+-t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+-t rdma -a 192.168.1.4   -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+
+At the prompt type "nvme connect-all".
+
+------------
+
+SEE ALSO
+--------
+nvme-discover(1)
+nvme-connect(1)
+
+NVME
+----
+Part of the nvme-user suite

diff --git a/Documentation/nvme-discover.txt b/Documentation/nvme-discover.txt
index 96c21f6e9b502180a7c3c2205e8f5e972a2016c5..d43f088c7ffd95920c764dabbfe5b6b96e18c640 100644 (file)
--- a/Documentation/nvme-discover.txt
+++ b/Documentation/nvme-discover.txt
@@ -120,6 +120,7 @@ At the prompt type "nvme discover".
 SEE ALSO
 --------
 nvme-connect(1)
+nvme-connect-all(1)
 
 AUTHORS
 -------