1STAFD.CONF(5) STAFD.CONF(5)
2
6 stafd.conf - stafd(8) configuration file
7
9 /etc/stas/stafd.conf
10
12 When stafd(8) starts up, it reads its configuration from stafd.conf.
13
15 stafd.conf is a plain text file divided into sections, with
16 configuration entries in the style key=value. A space immediately
17 before or after the = is ignored. Empty lines and lines starting with #
18 are ignored, which may be used for commenting.
19
21 [Global] section
22 The following options are available in the [Global] section:
23 tron=
25 Trace ON. Takes a boolean argument. If true, enables full code
26 tracing. The trace will be displayed in the system log such as
27 systemd's journal. Defaults to false.
28 hdr-digest=
30 Enable Protocol Data Unit (PDU) Header Digest. Takes a boolean
31 argument. NVMe/TCP facilitates an optional PDU Header digest.
32 Digests are calculated using the CRC32C algorithm. If true, Header
33 Digests are inserted in PDUs and checked for errors. Defaults to
34 false.
35 data-digest=
37 Enable Protocol Data Unit (PDU) Data Digest. Takes a boolean
38 argument. NVMe/TCP facilitates an optional PDU Data digest. Digests
39 are calculated using the CRC32C algorithm. If true, Data Digests
40 are inserted in PDUs and checked for errors. Defaults to false.
41 kato=
43 Keep Alive Timeout (KATO) in seconds. Takes an unsigned integer.
44 This field specifies the timeout value for the Keep Alive feature
45 in seconds. Defaults to 30 seconds for Discovery Controller
46 connections and 120 seconds for I/O Controller connections.
47 ip-family=
49 Takes a string argument. With this you can specify whether IPv4,
50 IPv6, or both are supported when connecting to a Controller.
51 Connections will not be attempted to IP addresses (whether
52 discovered or manually configured with the 'controller') if those
53 IP addresses are disabled by this option. If an invalid value is
54 entered, then "ipv4+ipv6" will be used by default.
55 Choices are ipv4, ipv6, or ipv4+ipv6.
57 Defaults to ipv4+ipv6.
59 persistent-connections=
61 Takes a boolean argument. Whether connections to Discovery
62 Controllers (DC) are persistent. When true, connections initiated
63 by stafd will persists even when stafd is stopped. When false,
64 stafd will disconnect from all DCs it is connected to on exit.
65 Defaults to false.
66 ignore-iface=
68 Takes a boolean argument. This option controls how connections with
69 Discovery Controllers (DC) are made.
70 DCs are automatically discovered using DNS-SD/mDNS. mDNS provides
72 the DC's IP address and the interface on which the DC was
73 discovered.
74 There is no guarantee that there will be a route to reach that DC.
76 However, we can use the socket option SO_BINDTODEVICE to force the
77 connection to be made on a specific interface instead of letting
78 the routing tables decide where to make the connection.
79 This option determines whether stafd will use SO_BINDTODEVICE to
81 force connections on an interface or just rely on the routing
82 tables. The default is to use SO_BINDTODEVICE, in other words,
83 stafd does not ignore the interface by default.
84 Defaults to false.
86 [Service Discovery] section
88 The following options are available in the [Service Discovery] section:
89 zeroconf=
91 Enable zeroconf provisioning using DNS-SD/mDNS. Takes a string
92 argument enabled or disabled.
93 When enabled, the default, stafd makes a request with the Avahi
95 daemon to locate Discovery Controllers using DNS-SD/mDNS.
96 Discovery Controllers that support zeroconf advertize themselves
98 over mDNS with the service type _nvme-disc._tcp.
99 [Controllers] section
101 The following options are available in the [Controllers] section:
102 controller=
104 Controllers are specified with the controller option. This option
105 may be specified more than once to specify more than one
106 controller. The format is one line per Controller composed of a
107 series of fields separated by semi-colons as follows:
108 controller=transport=[trtype];traddr=[traddr];trsvcid=[trsvcid];host-traddr=[traddr],host-iface=[iface];nqn=[nqn]
110 Fields
113 transport=
114 This is a mandatory field that specifies the network fabric
115 being used for a NVMe-over-Fabrics network. Current trtype
116 values understood are:
117 Table 1. Transport type
119 ┌───────┬────────────────────────────┐
120 │trtype │ Definition │
121 ├───────┼────────────────────────────┤
122 │rdma │ The network fabric is an │
123 │ │ rdma network (RoCE, iWARP, │
124 │ │ Infiniband, basic rdma, │
125 │ │ etc) │
126 ├───────┼────────────────────────────┤
127 │fc │ The network fabric is a │
128 │ │ Fibre Channel network. │
129 ├───────┼────────────────────────────┤
130 │tcp │ The network fabric is a │
131 │ │ TCP/IP network. │
132 ├───────┼────────────────────────────┤
133 │loop │ Connect to a NVMe over │
134 │ │ Fabrics target on the │
135 │ │ local host │
136 └───────┴────────────────────────────┘
137 traddr=
139 This is a mandatory field that specifies the network
140 address of the Controller. For transports using IP
141 addressing (e.g. rdma) this should be an IP-based address
142 (ex. IPv4, IPv6). It could also be a resolvable host name
143 (e.g. localhost).
144 trsvcid=
146 This is an optional field that specifies the transport
147 service id. For transports using IP addressing (e.g. rdma,
148 tcp) this field is the port number.
149 Depending on the transport type, this field will default to
151 either 8009 or 4420 as follows.
152 UDP port 4420 and TCP port 4420 have been assigned by IANA
154 for use by NVMe over Fabrics. NVMe/RoCEv2 controllers use
155 UDP port 4420 by default. NVMe/iWARP controllers use TCP
156 port 4420 by default.
157 TCP port 4420 has been assigned for use by NVMe over
159 Fabrics and TCP port 8009 has been assigned by IANA for use
160 by NVMe over Fabrics discovery. TCP port 8009 is the
161 default TCP port for NVMe/TCP discovery controllers. There
162 is no default TCP port for NVMe/TCP I/O controllers, the
163 Transport Service Identifier (TRSVCID) field in the
164 Discovery Log Entry indicates the TCP port to use.
165 The TCP ports that may be used for NVMe/TCP I/O controllers
167 include TCP port 4420, and the Dynamic and/or Private TCP
168 ports (i.e., ports in the TCP port number range from 49152
169 to 65535). NVMe/TCP I/O controllers should not use TCP port
170 8009. TCP port 4420 shall not be used for both NVMe/iWARP
171 and NVMe/TCP at the same IP address on the same network.
172 Ref: IANA Service names port numbers[1]
174 nqn=
176 This is an optional field that specifies the Discovery
177 Controller's NVMe Qualified Name. If not specified, this
178 will default to the well-known DC NQN:
179 nqn.2014-08.org.nvmexpress.discovery.
180 host-traddr=
182 This is an optional field that specifies the network
183 address used on the host to connect to the Controller. For
184 TCP, this sets the source address on the socket.
185 host-iface=
187 This is an optional field that specifies the network
188 interface used on the host to connect to the Controller
189 (e.g. IP eth1, enp2s0, enx78e7d1ea46da). This forces the
190 connection to be made on a specific interface instead of
191 letting the system decide.
192 Examples:
193 controller = transport=tcp;traddr=localhost;trsvcid=8009
195 controller = transport=tcp;traddr=[2001:db8:::370:7334];host-iface=enp0s8
196 controller = transport=fc;traddr=nn-0x204600a098cbcac6:pn-0x204700a098cbcac6
197 blacklist=
201 Blacklisted controllers can be specified with the blacklist option.
202 Using mDNS to automatically discover and connect to controllers,
203 can result in unintentional connections being made. This keyword
204 allows configuring the controllers that should not be connected to
205 (whatever the reason may be).
206 The syntax is the same as for "controller", except that the key
208 host-traddr does not apply. Multiple blacklist keywords may appear
209 in the config file to specify more than 1 blacklisted controller.
210 Note 1: A minimal match approach is used to eliminate unwanted
212 controllers. That is, you do not need to specify all the parameters
213 to identify a controller. Just specifying the host-iface, for
214 example, can be used to blacklist all controllers on an interface.
215 Note 2: blacklist takes precedence over controller. A controller
217 specified by the controller keyword, can be eliminated by the
218 blacklist keyword.
219 Examples:
221 blacklist = transport=tcp;traddr=fe80::2c6e:dee7:857:26bb # Eliminate a specific address
223 blacklist = host-iface=enp0s8 # Eliminate everything on this interface
224
228 stafd(8)
229
231 1. IANA Service names port numbers
232 https://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=nvme
233nvme-stas 1.1.5 STAFD.CONF(5)