From mboxrd@z Thu Jan 1 00:00:00 1970 From: hch@lst.de (Christoph Hellwig) Date: Thu, 17 Nov 2016 17:26:26 +0100 Subject: [PATCH 2/3] add a full blown connect man page In-Reply-To: <1479399987-9220-1-git-send-email-hch@lst.de> References: <1479399987-9220-1-git-send-email-hch@lst.de> Message-ID: <1479399987-9220-3-git-send-email-hch@lst.de> Mostly based on the wording in connect-all. Signed-off-by: Christoph Hellwig --- Documentation/nvme-connect.txt | 89 +++++++++++++++++++++++++++--------------- 1 file changed, 58 insertions(+), 31 deletions(-) diff --git a/Documentation/nvme-connect.txt b/Documentation/nvme-connect.txt index affcedf..ef1b3c4 100644 --- a/Documentation/nvme-connect.txt +++ b/Documentation/nvme-connect.txt @@ -3,39 +3,52 @@ 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= | -t ] - [--traddr= | -a ] - [--host-traddr=| -w ] - [--trsvcid= | -s ] - [--hostnqn= | -q ] - [--nqn= | -n ] - [--nr-io-queues=<#> | -i <#>] - [--keep-alive-tmo=<#> | -k <#>] - [--reconnect-delay=<#> | -c <#>] +'nvme connect' + [--transport= | -t ] + [--nqn= | -n ] + [--traddr= | -a ] + [--trsvcid= | -s ] + [--host_traddr= | -w ] + [--hostnqn= | -q ] + [--nr-io-queues=<#> | -i <#>] + [--keep-alive-tmo=<#> | -k <#>] + [--reconnect-delay=<#> | -c <#>] 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 :: --transport=:: - 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 :: +--nqn :: + This field specifies the name for the NVMe subsystem to connect to. -a :: --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). -w :: --host-traddr=:: @@ -43,39 +56,53 @@ OPTIONS -s :: --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 :: +--host_traddr=:: + This field specifies the network address used on the host to connect + to the Controller. + -q :: --hostnqn=:: - TBD - --n :: ---nqn=:: - 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. 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 ------- -- 2.1.4