1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
|
nvme-discover(1)
================
NAME
----
nvme-discover - Send Get Log Page request to Discovery Controller.
SYNOPSIS
--------
[verse]
'nvme discover'
[--transport=<trtype> | -t <trtype>]
[--nqn=<subnqn> | -n <subnqn>]
[--traddr=<traddr> | -a <traddr>]
[--trsvcid=<trsvcid> | -s <trsvcid>]
[--host-traddr=<traddr> | -w <traddr>]
[--host-iface=<iface> | -f <iface>]
[--hostnqn=<hostnqn> | -q <hostnqn>]
[--hostid=<hostid> | -I <hostid>]
[--raw=<filename> | -r <filename>]
[--device=<device> | -d <device>]
[--cfg-file=<cfg> | -C <cfg> ]
[--keep-alive-tmo=<sec> | -k <sec>]
[--reconnect-delay=<#> | -c <#>]
[--ctrl-loss-tmo=<#> | -l <#>]
[--nr-io-queues=<#> | -i <#>]
[--nr-write-queues=<#> | -W <#>]
[--nr-poll-queues=<#> | -P <#>]
[--queue-size=<#> | -Q <#>]
[--keyring=<#> ]
[--tls_key=<#> ]
[--hdr-digest | -g]
[--data-digest | -G]
[--persistent | -p]
[--quiet | -S]
[--tls ]
[--dump-config | -O]
[--output-format=<fmt> | -o <fmt>]
[--force]
[--nbft]
[--no-nbft]
[--nbft-path=<STR>]
[--context=<STR>]
DESCRIPTION
-----------
Send one or more Get Log Page requests to a NVMe-over-Fabrics Discovery
Controller.
If no parameters are given, then 'nvme discover' will attempt to
find a @SYSCONFDIR@/nvme/discovery.conf file to use to supply a list of
Discovery commands to run. If no @SYSCONFDIR@/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 flags. A Discovery
request will then be sent to the specified Discovery Controller.
BACKGROUND
----------
The NVMe-over-Fabrics specification defines the concept of a
Discovery Controller that an NVMe Host can query on a fabric
network to discover NVMe subsystems contained in NVMe Targets
which it can connect to on the network. The Discovery Controller
will return Discovery Log Pages that provide the NVMe Host
with specific information (such as network address and unique
subsystem NQN) the NVMe Host can use to issue an
NVMe connect command to connect itself to a storage resource
contained in that NVMe subsystem on the NVMe Target.
Note that the base NVMe specification defines the NQN (NVMe Qualified
Name) format which an NVMe endpoint (device, subsystem, etc) must
follow to guarantee a unique name under the NVMe standard.
In particular, the Host NQN uniquely identifies the NVMe Host, and
may be used by the Discovery Controller to control what NVMe Target
resources are allocated to the NVMe Host for a connection.
A Discovery Controller has it's own NQN defined in the NVMe-over-Fabrics
specification, *nqn.2014-08.org.nvmexpress.discovery*. All Discovery
Controllers must use this NQN name. This NQN is used by default by
nvme-cli for the 'discover' command.
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.
|tcp |The network fabric is a TCP/IP 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>::
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 Controller. For TCP, this sets the source address on the socket.
-f <iface>::
--host-iface=<iface>::
This field specifies the network interface used on the host to connect
to the Controller (e.g. IP eth1, enp2s0, enx78e7d1ea46da). This forces
the connection to be made on a specific interface instead of letting
the system decide.
-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
@SYSCONFDIR@/nvme/hostnqn first. If that does not exist, the
autogenerated NQN value from the NVMe Host kernel module is used next.
-I <hostid>::
--hostid=<hostid>::
UUID(Universally Unique Identifier) to be discovered which should be
formatted.
-r <filename>::
--raw=<filename>::
This field will take the output of the 'nvme discover' command
and dump it to a raw binary file. By default 'nvme discover' will
dump the output to stdout.
-d <device>::
--device=<device>::
This field takes a device as input. It must be a persistent device
associated with a Discovery Controller previously created by the
command "connect-all" or "discover". <device> follows the format
nvme*, eg. nvme0, nvme1.
-C <cfg>::
--config-file=<cfg>::
Use the specified JSON configuration file instead of the
default @SYSCONFDIR@/nvme/config.json file or 'none' to not read in
an existing configuration file. The JSON configuration file
format is documented in
https://github.com/linux-nvme/libnvme/doc/config-schema.json
-k <#>::
--keep-alive-tmo=<#>::
Overrides the default keep alive timeout (in seconds). This
option will be ignored for discovery, and it is only
implemented for completeness.
-c <#>::
--reconnect-delay=<#>::
Overrides the default delay (in seconds) before reconnect is attempted
after a connect loss.
-l <#>::
--ctrl-loss-tmo=<#>::
Overrides the default controller loss timeout period (in seconds).
-i <#>::
--nr-io-queues=<#>::
Overrides the default number of I/O queues create by the driver.
This option will be ignored for the discovery, and it is only
implemented for completeness.
-W <#>::
--nr-write-queues=<#>::
Adds additional queues that will be used for write I/O.
-P <#>::
--nr-poll-queues=<#>::
Adds additional queues that will be used for polling latency sensitive I/O.
-Q <#>::
--queue-size=<#>::
Overrides the default number of elements in the I/O queues created
by the driver which can be found at drivers/nvme/host/fabrics.h.
This option will be ignored for the discovery, and it is only
implemented for completeness.
--keyring=<#>::
Keyring for TLS key lookup.
--tls_key=<#>::
TLS key for the connection (TCP).
-g::
--hdr-digest::
Generates/verifies header digest (TCP).
-G::
--data-digest::
Generates/verifies data digest (TCP).
-p::
--persistent::
Don't remove the discovery controller after retrieving the discovery
log page.
--tls::
Enable TLS encryption (TCP).
-S::
--quiet::
Suppress already connected errors.
-O::
--dump-config::
Print out resulting JSON configuration file to stdout.
-o <format>::
--output-format=<format>::
Set the reporting format to 'normal', 'json', or
'binary'. Only one output format can be used at a time.
--force::
Disable the built-in persistent discover connection rules.
Combined with --persistent flag, always create new
persistent discovery connection.
--nbft::
Only look at NBFT tables
--no-nbft::
Do not look at NBFT tables
--nbft-path=<STR>::
Use a user-defined path to the NBFT tables
--context <STR>::
Set the execution context to <STR>. This allows to coordinate
the management of the global resources.
EXAMPLES
--------
* Query 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 discover --transport=rdma --traddr=192.168.1.3 \
--hostnqn=host1-rogue-nqn
------------
+
* Issue a 'nvme discover' command using the default system defined NBFT tables:
+
-----------
# nvme discover --nbft
------------
+
* Issue a 'nvme discover' command with a user-defined path for the NBFT table:
+
-----------
# nvme discover --nbft-path=/sys/firmware/acpi/tables/NBFT1
------------
+
* Issue a 'nvme discover' command using a @SYSCONFDIR@/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 discover".
------------
SEE ALSO
--------
nvme-connect(1)
nvme-connect-all(1)
AUTHORS
-------
This was written by mailto:james.p.freyensee@intel.com[Jay Freyensee]
NVME
----
Part of the nvme-user suite
|
