bionic (1) nvme-connect-all.1.gz
NAME
nvme-connect-all - Discover and Connect to Fabrics controllers.
SYNOPSIS
nvme connect-all
[--transport=<trtype> | -t <trtype>]
[--traddr=<traddr> | -a <traddr>]
[--trsvcid=<trsvcid> | -s <trsvcid>]
[--host-traddr=<traddr> | -w <traddr>]
[--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
necessary 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 IP-based address (ex. IPv4).
-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.
-w <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. 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, and
may be used by the 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.
-Q <#>, --queue-size=<#>
Overrides the default number of elements in the I/O queues created by the driver.
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