Skip to contentSkip to conversation

nvme-cli fabrics man pages updates

PATCH New Christoph Hellwig 2 participants 5 messages Nov 17, 2016

Subsystems (2)
Documentation NVMe
lore
Share & tools
lore

Christoph Hellwig

author maintainer
#0 lore raw

This completes the remaining missing pieces for documenting the fabrics commands.

author maintainer
#1 lore raw

PATCH 1/3 update discover and connect-all man pages

Document the --host-traddr option, and add the missing description of the --raw command to the connect-all man page.

Signed-off-by Christoph Hellwig <hch at lst.de>
---
 Documentation/nvme-connect-all.txt | 24 ++++++++++++++++++------
 Documentation/nvme-discover.txt    | 16 +++++++++++-----
 2 files changed, 29 insertions(+), 11 deletions(-)
Documentation/nvme-connect-all.txt +18 -6
index 1dc1782..9a65148 100644
@@ -9,11 +9,12 @@ 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>]
+		[--transport=<trtype>     | -t <trtype>]
+		[--traddr=<traddr>        | -a <traddr>]
+		[--trsvcid=<trsvcid>      | -s <trsvcid>]
+		[--host_traddr=<traddr>   | -s <traddr>]
+		[--hostnqn=<hostnqn>      | -q <hostnqn>]
+		[--raw=<filename>         | -r <filename>]
 
 DESCRIPTION
 -----------

@@ -58,7 +59,12 @@ OPTIONS
 	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.
- 
+
+-s <traddr>::
+--host_traddr=<traddr>::
+	This field specifies the network address used on the host to connect
+	to the Discovery Controller.
+
 -q <hostnqn>::
 --hostnqn=<hostnqn>::
 	Overrides the default Host NQN that identifies the NVMe Host.

@@ -69,6 +75,12 @@ OPTIONS
 	the Discovery Controller to control what NVMe Target resources are
 	allocated to the NVMe Host for a connection.
 
+-r <filename>::
+--raw=<filename>::
+	This field will take the output of the 'nvme connect-all' command
+	and dump it to a raw binary file. By default 'nvme connect-all' will
+	dump the output to stdout.
+
 EXAMPLES
 --------
 * Connect to all records returned by the Discover Controller with IP4 address
Documentation/nvme-discover.txt +11 -5
index e9f04b2..6862bdb 100644
@@ -9,11 +9,12 @@ SYNOPSIS
 --------
 [verse]
 'nvme discover'
-		[--transport=<trtype> | -t <trtype>]
-		[--traddr=<traddr>    | -a <traddr>]
-		[--trsvcid=<trsvcid>  | -s <trsvcid>]
-		[--hostnqn=<hostnqn>  | -q <hostnqn>]
-		[--raw=<filename>     | -r <filename>]
+		[--transport=<trtype>     | -t <trtype>]
+		[--traddr=<traddr>        | -a <traddr>]
+		[--trsvcid=<trsvcid>      | -s <trsvcid>]
+		[--host_traddr=<traddr>   | -s <traddr>]
+		[--hostnqn=<hostnqn>      | -q <hostnqn>]
+		[--raw=<filename>         | -r <filename>]
 
 DESCRIPTION
 -----------

@@ -87,6 +88,11 @@ OPTIONS
 	/etc/nvme/hostnqn first. If that does not exist, the autogenerated
 	NQN value from the NVMe Host kernel module is used next.
 
+-s <traddr>::
+--host_traddr=<traddr>::
+	This field specifies the network address used on the host to connect
+	to the Discovery Controller.
+
 -r <filename>::
 --raw=<filename>::
 	This field will take the output of the 'nvme discover' command
Signature · 1 line
2.1.4
#2 lore raw

PATCH 1/3 update discover and connect-all man pages

Quoted 2 lines · Christoph Hellwig

Document the --host-traddr option, and add the missing description of the --raw command to the connect-all man page.

This isn't quite merged up to the latest. The short option for host-traddr needed to change since -s is already used.

Quoted 6 lines
Documentation/nvme-connect-all.txt +6 -0
+		[--transport=<trtype>     | -t <trtype>]
+		[--traddr=<traddr>        | -a <traddr>]
+		[--trsvcid=<trsvcid>      | -s <trsvcid>]
+		[--host_traddr=<traddr>   | -s <traddr>]
+		[--hostnqn=<hostnqn>      | -q <hostnqn>]
+		[--raw=<filename>         | -r <filename>]
author maintainer
#3 lore raw

PATCH 2/3 add a full blown connect man page

In reply to Christoph Hellwig

Mostly based on the wording in connect-all.

Signed-off-by Christoph Hellwig <hch at lst.de>
---
 Documentation/nvme-connect.txt | 95 +++++++++++++++++++++++++++++-------------
 1 file changed, 65 insertions(+), 30 deletions(-)
Documentation/nvme-connect.txt +65 -30
index 9ba969e..193bfc6 100644
@@ -3,74 +3,109 @@ nvme-connect(1)
 
 NAME
 ----
-nvme-connect - Connect to an NVMe-over-Fabrics subsystem.
+nvme-connect - Connect to a Fabrics controller.
 
 SYNOPSIS
 --------
 [verse]
-'nvme connect'	[device]
-		[--transport=<trtype>  | -t <trtype>]
-		[--traddr=<traddr>     | -a <traddr>]
-		[--trsvcid=<trsvcid>   | -s <trsvcid>]
-		[--hostnqn=<hostnqn>   | -q <hostnqn>]
-		[--nqn=<subnqn>        | -n <subnqn>]
-		[--nr-io-queues=<#>    | -i <#>]
-		[--keep-alive-tmo=<#>  | -k <#>]
-		[--reconnect-delay=<#> | -c <#>]
+'nvme connect'
+		[--transport=<trtype>     | -t <trtype>]
+		[--nqn=<subnqn>           | -n <subnqn>]
+		[--traddr=<traddr>        | -a <traddr>]
+		[--trsvcid=<trsvcid>      | -s <trsvcid>]
+		[--host_traddr=<traddr>   | -s <traddr>]
+		[--hostnqn=<hostnqn>      | -q <hostnqn>]
+		[--nr-io-queues=<#>       | -i <#>]
+		[--keep-alive-tmo=<#>     | -k <#>]
+		[--reconnect-delay=<#>    | -c <#>]
+		[--raw=<filename>         | -r <filename>]
 
 DESCRIPTION
 -----------
-TBD (note 'device' is optional)
-
-BACKGROUND
-----------
-TBD
+Create a transport connection to a remote system (specified by --traddr and
+--trsvcid) and create a NVMe over Fabrics controller for the NVMe subsystem
+specified by the --nqn option.
 
 OPTIONS
 -------
 -t <trtype>::
 --transport=<trtype>::
-	TBD
+	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
+|=================
+
+-n <subnqn>::
+--nqn <subnqn>::
+	This field specifies the name for the NVMe subsystem to connect to.
 
 -a <traddr>::
 --traddr=<traddr>::
-	TBD
+	This field specifies the network address of the Controller.
+	For transports using IP addressing (e.g. rdma) this should be an
+	IP-based address (ex. IPv4).
 
 -s <trsvcid>::
 --trsvcid=<trsvcid>::
-	TBD
- 
+	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.
+
+-s <traddr>::
+--host_traddr=<traddr>::
+	This field specifies the network address used on the host to connect
+	to the Controller.
+
 -q <hostnqn>::
 --hostnqn=<hostnqn>::
-	TBD
-
--n <subnqn>::
---nqn=<subnqn>::
-	TBD
+	Overrides the default Host NQN that identifies the NVMe Host.
+	If this option is not specified, the default is read from
+	/etc/nvme/hostnqn first. If that does not exist, the autogenerated
+	NQN value from the NVMe Host kernel module is used next.
+	The Host NQN uniquely identifies the NVMe Host.
 
 -i <#>::
---nr-io-queues<#>::
-	TBD
+--nr-io-queues=<#>::
+	Overrides the default number of I/O queues create by the driver.
 
 -k <#>::
 --keep-alive-tmo=<#>::
-	TBD
+	Overrides the default keep alive timeout (in seconds).
 
 -c <#>::
 --reconnect-delay=<#>::
-	TBD
+	Overrides the default delay (in seconds) before reconnect is attempted
+	after a connect loss.
+
+-r <filename>::
+--raw=<filename>::
+	This field will take the output of the 'nvme connect' command
+	and dump it to a raw binary file. By default 'nvme connect' will
+	dump the output to stdout.
 
 EXAMPLES
 --------
-* TBD
+* Connect to a subsystem named nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+on the IP4 address 192.168.1.3. Port 4420 is used by default:
 +
 ------------
-# nvme connect... 
+# nvme connect --transport=rdma --traddr=192.168.1.3 \
+--nqn=nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
+------------
+
 ------------
 
 SEE ALSO
 --------
 nvme-discover(1)
+nvme-connect-all(1)
+
 
 AUTHORS
 -------
Signature · 1 line
2.1.4
author maintainer
#4 lore raw

PATCH 3/3 add a disconnet man page

In reply to Christoph Hellwig
Signed-off-by Christoph Hellwig <hch at lst.de>
---
 Documentation/nvme-disconnect.txt | 58 +++++++++++++++++++++++++++++++++++++++
 1 file changed, 58 insertions(+)
 create mode 100644 Documentation/nvme-disconnect.txt
Documentation/nvme-disconnect.txt new file +58 -0
new file mode 100644
index 0000000..703d901
@@ -0,0 +1,58 @@
+nvme-disconnect(1)
+==================
+
+NAME
+----
+nvme-disconnect - Disonnect one or more Fabrics controller(s).
+
+SYNOPSIS
+--------
+[verse]
+'nvme connect'
+		[--nqn=<subnqn>           | -n <subnqn>]
+		[--device=<device>        | -d <device>]
+
+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.
+
+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
Signature · 1 line
2.1.4