1NVME-CONNECT(1) NVMe Manual NVME-CONNECT(1)
2
6 nvme-connect - Connect to a Fabrics controller.
7
9 nvme connect
10 [--transport=<trtype> | -t <trtype>]
11 [--nqn=<subnqn> | -n <subnqn>]
12 [--traddr=<traddr> | -a <traddr>]
13 [--trsvcid=<trsvcid> | -s <trsvcid>]
14 [--host-traddr=<traddr> | -w <traddr>]
15 [--host-iface=<iface> | -f <iface>]
16 [--hostnqn=<hostnqn> | -q <hostnqn>]
17 [--hostid=<hostid> | -I <hostid>]
18 [--config-file=<cfg> | -J <cfg> ]
19 [--dhchap-secret=<secret> | -S <secret>]
20 [--dhchap-ctrl-secret=<secret> | -C <secret>]
21 [--nr-io-queues=<#> | -i <#>]
22 [--nr-write-queues=<#> | -W <#>]
23 [--nr-poll-queues=<#> | -P <#>]
24 [--queue-size=<#> | -Q <#>]
25 [--keep-alive-tmo=<#> | -k <#>]
26 [--reconnect-delay=<#> | -c <#>]
27 [--ctrl-loss-tmo=<#> | -l <#>]
28 [--tos=<#> | -T <#>]
29 [--keyring=<#> ]
30 [--tls_key=<#> ]
31 [--duplicate-connect | -D]
32 [--disable-sqflow | -d]
33 [--hdr-digest | -g]
34 [--data-digest | -G]
35 [--tls ]
36 [--dump-config | -O]
37 [--output-format=<fmt> | -o <fmt>]
38
40 Create a transport connection to a remote system (specified by --traddr
41 and --trsvcid) and create a NVMe over Fabrics controller for the NVMe
42 subsystem specified by the --nqn option.
43
45 -t <trtype>, --transport=<trtype>
46 This field specifies the network fabric being used for a
47 NVMe-over-Fabrics network. Current string values include:
48 ┌──────┬────────────────────────────┐
50 │Value │ Definition │
51 ├──────┼────────────────────────────┤
52 │rdma │ The network fabric is an │
53 │ │ rdma network (RoCE, iWARP, │
54 │ │ Infiniband, basic rdma, │
55 │ │ etc) │
56 ├──────┼────────────────────────────┤
57 │fc │ WIP The network fabric is │
58 │ │ a Fibre Channel network. │
59 ├──────┼────────────────────────────┤
60 │tcp │ The network fabric is a │
61 │ │ TCP/IP network. │
62 ├──────┼────────────────────────────┤
63 │loop │ Connect to a NVMe over │
64 │ │ Fabrics target on the │
65 │ │ local host │
66 └──────┴────────────────────────────┘
67 -n <subnqn>, --nqn <subnqn>
69 This field specifies the name for the NVMe subsystem to connect to.
70 -a <traddr>, --traddr=<traddr>
72 This field specifies the network address of the Controller. For
73 transports using IP addressing (e.g. rdma) this should be an
74 IP-based address (ex. IPv4).
75 -s <trsvcid>, --trsvcid=<trsvcid>
77 This field specifies the transport service id. For transports using
78 IP addressing (e.g. rdma) this field is the port number. By
79 default, the IP port number for the RDMA transport is 4420.
80 -w <traddr>, --host-traddr=<traddr>
82 This field specifies the network address used on the host to
83 connect to the Controller. For TCP, this sets the source address on
84 the socket.
85 -f <iface>, --host-iface=<iface>
87 This field specifies the network interface used on the host to
88 connect to the Controller (e.g. IP eth1, enp2s0, enx78e7d1ea46da).
89 This forces the connection to be made on a specific interface
90 instead of letting the system decide.
91 -q <hostnqn>, --hostnqn=<hostnqn>
93 Overrides the default Host NQN that identifies the NVMe Host. If
94 this option is not specified, the default is read from
95 /etc/nvme/hostnqn first. If that does not exist, the autogenerated
96 NQN value from the NVMe Host kernel module is used next. The Host
97 NQN uniquely identifies the NVMe Host.
98 -I <hostid>, --hostid=<hostid>
100 UUID(Universally Unique Identifier) to be discovered which should
101 be formatted.
102 -J <cfg>, --config-file=<cfg>
104 Use the specified JSON configuration file instead of the default
105 /etc/nvme/config.json file or none to not read in an existing
106 configuration file. The JSON configuration file format is
107 documented in
108 https://github.com/linux-nvme/libnvme/doc/config-schema.json
109 -S <secret>, --dhchap-secret=<secret>
111 NVMe In-band authentication secret; needs to be in ASCII format as
112 specified in NVMe 2.0 section 8.13.5.8 Secret representation. If
113 this option is not specified, the default is read from
114 /etc/nvme/hostkey. If that does not exist no in-band authentication
115 is attempted.
116 -C <secret>, --dhchap-ctrl-secret=<secret>
118 NVMe In-band authentication controller secret for bi-directional
119 authentication; needs to be in ASCII format as specified in NVMe
120 2.0 section 8.13.5.8 Secret representation. If not present
121 bi-directional authentication is not attempted.
122 -i <#>, --nr-io-queues=<#>
124 Overrides the default number of I/O queues create by the driver.
125 -W <#>, --nr-write-queues=<#>
127 Adds additional queues that will be used for write I/O.
128 -P <#>, --nr-poll-queues=<#>
130 Adds additional queues that will be used for polling latency
131 sensitive I/O.
132 -Q <#>, --queue-size=<#>
134 Overrides the default number of elements in the I/O queues created
135 by the driver.
136 -k <#>, --keep-alive-tmo=<#>
138 Overrides the default keep alive timeout (in seconds).
139 -c <#>, --reconnect-delay=<#>
141 Overrides the default delay (in seconds) before reconnect is
142 attempted after a connect loss.
143 -l <#>, --ctrl-loss-tmo=<#>
145 Overrides the default controller loss timeout period (in seconds).
146 -T <#>, --tos=<#>
148 Type of service for the connection (TCP)
149 --keyring=<#>
151 Keyring for TLS key lookup.
152 --tls_key=<#>
154 TLS key for the connection (TCP).
155 -D, --duplicate-connect
157 Allows duplicated connections between same transport host and
158 subsystem port.
159 -d, --disable-sqflow
161 Disables SQ flow control to omit head doorbell update for
162 submission queues when sending nvme completions.
163 -g, --hdr-digest
165 Generates/verifies header digest (TCP).
166 -G, --data-digest
168 Generates/verifies data digest (TCP).
169 --tls
171 Enable TLS encryption (TCP).
172 -O, --dump-config
174 Print out resulting JSON configuration file to stdout.
175 -o <format>, --output-format=<format>
177 Set the reporting format to normal or json. Only one output format
178 can be used at a time. When this option is specified, the device
179 associated with the connection will be printed. Nothing is printed
180 otherwise.
181
183 • Connect to a subsystem named
184 nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432 on the IP4
185 address 192.168.1.3. Port 4420 is used by default:
186 # nvme connect --transport=rdma --traddr=192.168.1.3 \
188 --nqn=nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
189
191 nvme-discover(1) nvme-connect-all(1)
192
194 This was co-written by Jay Freyensee[1] and Christoph Hellwig[2]
195
197 Part of the nvme-user suite
198
200 1. Jay Freyensee
201 mailto:james.p.freyensee@intel.com
202 2. Christoph Hellwig
204 mailto:hch@lst.de
205NVMe 10/06/2023 NVME-CONNECT(1)