1NVME-CONNECT-ALL(1) NVMe Manual NVME-CONNECT-ALL(1)
2
3
4
6 nvme-connect-all - Discover and Connect to Fabrics controllers.
7
9 nvme connect-all
10 [--transport=<trtype> | -t <trtype>]
11 [--traddr=<traddr> | -a <traddr>]
12 [--trsvcid=<trsvcid> | -s <trsvcid>]
13 [--host-traddr=<traddr> | -w <traddr>]
14 [--hostnqn=<hostnqn> | -q <hostnqn>]
15 [--keep-alive-tmo=<#> | -k <#>]
16 [--ctrl-loss-tmo=<#> | -l <#>]
17 [--raw=<filename> | -r <filename>]
18
20 Send one or more Discovery requests to a NVMe over Fabrics Discovery
21 Controller, and create controllers for the returned discovery records.
22
23 If no parameters are given, then nvme connect-all will attempt to find
24 a /etc/nvme/discovery.conf file to use to supply a list of connect-all
25 commands to run. If no /etc/nvme/discovery.conf file exists, the
26 command will quit with an error.
27
28 Otherwise a specific Discovery Controller should be specified using the
29 --transport, --traddr and if necessary the --trsvcid and a Diѕcovery
30 request will be sent to the specified Discovery Controller.
31
32 See the documentation for the nvme-discover(1) command for further
33 background.
34
36 -t <trtype>, --transport=<trtype>
37 This field specifies the network fabric being used for a
38 NVMe-over-Fabrics network. Current string values include:
39
40 ┌──────┬────────────────────────────┐
41 │Value │ Definition │
42 ├──────┼────────────────────────────┤
43 │rdma │ The network fabric is an │
44 │ │ rdma network (RoCE, iWARP, │
45 │ │ Infiniband, basic rdma, │
46 │ │ etc) │
47 ├──────┼────────────────────────────┤
48 │fc │ WIP The network fabric is │
49 │ │ a Fibre Channel network. │
50 ├──────┼────────────────────────────┤
51 │loop │ Connect to a NVMe over │
52 │ │ Fabrics target on the │
53 │ │ local host │
54 └──────┴────────────────────────────┘
55
56 -a <traddr>, --traddr=<traddr>
57 This field specifies the network address of the Discovery
58 Controller. For transports using IP addressing (e.g. rdma) this
59 should be an IP-based address (ex. IPv4).
60
61 -s <trsvcid>, --trsvcid=<trsvcid>
62 This field specifies the transport service id. For transports using
63 IP addressing (e.g. rdma) this field is the port number. By
64 default, the IP port number for the RDMA transport is 4420.
65
66 -w <traddr>, --host-traddr=<traddr>
67 This field specifies the network address used on the host to
68 connect to the Discovery Controller.
69
70 -q <hostnqn>, --hostnqn=<hostnqn>
71 Overrides the default Host NQN that identifies the NVMe Host. If
72 this option is not specified, the default is read from
73 /etc/nvme/hostnqn first. If that does not exist, the autogenerated
74 NQN value from the NVMe Host kernel module is used next. The Host
75 NQN uniquely identifies the NVMe Host, and may be used by the the
76 Discovery Controller to control what NVMe Target resources are
77 allocated to the NVMe Host for a connection.
78
79 -r <filename>, --raw=<filename>
80 This field will take the output of the nvme connect-all command and
81 dump it to a raw binary file. By default nvme connect-all will dump
82 the output to stdout.
83
84 -Q <#>, --queue-size=<#>
85 Overrides the default number of elements in the I/O queues created
86 by the driver.
87
88 -k <#>, --keep-alive-tmo=<#>
89 Overrides the default keep alive timeout (in seconds).
90
92 · Connect to all records returned by the Discover Controller with IP4
93 address 192.168.1.3 for all resources allocated for NVMe Host name
94 host1-rogue-nqn on the RDMA network. Port 4420 is used by default:
95
96 # nvme connect-all --transport=rdma --traddr=192.168.1.3 \
97 --hostnqn=host1-rogue-nqn
98
99 · Issue a nvme connect-all command using a /etc/nvme/discovery.conf
100 file:
101
102 # Machine default 'nvme discover' commands. Query the
103 # Discovery Controller's two ports (some resources may only
104 # be accessible on a single port). Note an official
105 # nqn (Host) name defined in the NVMe specification is being used
106 # in this example.
107 -t rdma -a 192.168.69.33 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
108 -t rdma -a 192.168.1.4 -s 4420 -q nqn.2014-08.com.example:nvme:nvm-subsystem-sn-d78432
109
110 At the prompt type "nvme connect-all".
111
113 nvme-discover(1) nvme-connect(1)
114
116 Part of the nvme-user suite
117
118
119
120NVMe 01/08/2019 NVME-CONNECT-ALL(1)