summaryrefslogtreecommitdiff
path: root/interface-definitions/interfaces-ethernet.xml.in
blob: 6bf72defa9276de357d803046b96e7966c2f182b (plain)
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
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="interfaces">
    <children>
      <tagNode name="ethernet" owner="${vyos_conf_scripts_dir}/interfaces-ethernet.py">
        <properties>
          <help>Ethernet interface name</help>
          <priority>318</priority>
          <constraint>
            <regex>((eth|lan)[0-9]+|(eno|ens|enp|enx).+)$</regex>
          </constraint>
          <constraintErrorMessage>Invalid Ethernet interface name</constraintErrorMessage>
          <valueHelp>
            <format>ethN</format>
            <description>Ethernet interface name</description>
          </valueHelp>
          <valueHelp>
            <format>en[ospx]N</format>
            <description>Ethernet interface name</description>
          </valueHelp>
        </properties>
        <children>
          #include <include/address-ipv4-ipv6-dhcp.xml.i>
          <leafNode name="description">
            <properties>
              <help>Interface description</help>
              <constraint>
                <regex>^.{1,256}$</regex>
              </constraint>
              <constraintErrorMessage>Interface description too long (limit 256 characters)</constraintErrorMessage>
            </properties>
          </leafNode>
          <node name="dhcp-options">
            <properties>
              <help>DHCP options</help>
            </properties>
            <children>
              <leafNode name="client-id">
                <properties>
                  <help>DHCP client identifier</help>
                </properties>
              </leafNode>
              <leafNode name="host-name">
                <properties>
                  <help>DHCP client host name (overrides system host name)</help>
                </properties>
              </leafNode>
              <leafNode name="vendor-class-id">
                <properties>
                  <help>DHCP client vendor type</help>
                </properties>
              </leafNode>
            </children>
          </node>
          <node name="dhcpv6-options">
            <properties>
              <help>DHCPv6 options</help>
              <priority>319</priority>
            </properties>
            <children>
              <leafNode name="parameters-only">
                <properties>
                  <help>Acquire only config parameters, no address</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="temporary">
                <properties>
                  <help>IPv6 "temporary" address</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="disable-flow-control">
            <properties>
              <help>Disable Ethernet flow control (pause frames)</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="disable-link-detect">
            <properties>
              <help>Ignore link state changes</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="disable">
            <properties>
              <help>Disable this bridge interface</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="duplex">
            <properties>
              <help>Duplex mode</help>
              <completionHelp>
                <list>auto half full</list>
              </completionHelp>
              <valueHelp>
                <format>auto</format>
                <description>Auto negotiation (default)</description>
              </valueHelp>
              <valueHelp>
                <format>half</format>
                <description>Half duplex</description>
              </valueHelp>
              <valueHelp>
                <format>full</format>
                <description>Full duplex</description>
              </valueHelp>
              <constraint>
                <regex>(auto|half|full)</regex>
              </constraint>
              <constraintErrorMessage>duplex must be auto, half or full</constraintErrorMessage>
            </properties>
          </leafNode>
          <leafNode name="hw-id">
            <properties>
              <help>Media Access Control (MAC) address</help>
              <valueHelp>
                <format>h:h:h:h:h:h</format>
                <description>Hardware (MAC) address</description>
              </valueHelp>
              <constraint>
                <validator name="mac-address"/>
              </constraint>
            </properties>
          </leafNode>
          <node name="ip">
            <children>
              <leafNode name="arp-cache-timeout">
                <properties>
                  <help>ARP cache entry timeout in seconds</help>
                  <valueHelp>
                    <format>1-86400</format>
                    <description>ARP cache entry timout in seconds (default 30)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-86400"/>
                  </constraint>
                  <constraintErrorMessage>ARP cache entry timeout must be between 1 and 86400 seconds</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="enable-proxy-arp">
                <properties>
                  <help>Enable proxy-arp on this interface</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="proxy-arp-pvlan">
                <properties>
                  <help>Enable private VLAN proxy ARP on this interface</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="mac">
            <properties>
              <help>Media Access Control (MAC) address</help>
              <valueHelp>
                <format>h:h:h:h:h:h</format>
                <description>Hardware (MAC) address</description>
              </valueHelp>
              <constraint>
                <validator name="mac-address"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="mtu">
            <properties>
              <help>Maximum Transmission Unit (MTU)</help>
              <valueHelp>
                <format>68-9000</format>
                <description>Maximum Transmission Unit</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 68-9000"/>
              </constraint>
              <constraintErrorMessage>MTU must be between 68 and 9000</constraintErrorMessage>
            </properties>
          </leafNode>
          <node name="offload-options">
            <properties>
              <help>Configurable offload options</help>
            </properties>
            <children>
              <leafNode name="generic-receive">
                <properties>
                  <help>Configure GRO (generic receive offload)</help>
                  <completionHelp>
                    <list>on off</list>
                  </completionHelp>
                  <valueHelp>
                    <format>on</format>
                    <description>Enable GRO (generic receive offload)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>off</format>
                    <description>Disable GRO (generic receive offload)</description>
                  </valueHelp>
                  <constraint>
                    <regex>(on|off)</regex>
                  </constraint>
                  <constraintErrorMessage>Must be either 'on' or 'off'</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="generic-segmentation">
                <properties>
                  <help>Configure GSO (generic segmentation offload)</help>
                  <completionHelp>
                    <list>on off</list>
                  </completionHelp>
                  <valueHelp>
                    <format>on</format>
                    <description>Enable GSO (generic segmentation offload)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>off</format>
                    <description>Disable GSO (generic segmentation offload)</description>
                  </valueHelp>
                  <constraint>
                    <regex>(on|off)</regex>
                  </constraint>
                  <constraintErrorMessage>Must be either 'on' or 'off'</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="scatter-gather">
                <properties>
                  <help>Configure scatter-gather option</help>
                  <completionHelp>
                    <list>on off</list>
                  </completionHelp>
                  <valueHelp>
                    <format>on</format>
                    <description>Enable scatter-gather</description>
                  </valueHelp>
                  <valueHelp>
                    <format>off</format>
                    <description>Disable scatter-gather</description>
                  </valueHelp>
                  <constraint>
                    <regex>(on|off)</regex>
                  </constraint>
                  <constraintErrorMessage>Must be either 'on' or 'off'</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="tcp-segmentation">
                <properties>
                  <help>Configure TSO (TCP segmentation offloading)</help>
                  <completionHelp>
                    <list>on off</list>
                  </completionHelp>
                  <valueHelp>
                    <format>on</format>
                    <description>Enable TSO (TCP segmentation offloading)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>off</format>
                    <description>Disable TSO (TCP segmentation offloading)</description>
                  </valueHelp>
                  <constraint>
                    <regex>(on|off)</regex>
                  </constraint>
                  <constraintErrorMessage>Must be either 'on' or 'off'</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="udp-fragmentation">
                <properties>
                  <help>Configure UDP fragmentation offloading</help>
                  <completionHelp>
                    <list>on off</list>
                  </completionHelp>
                  <valueHelp>
                    <format>on</format>
                    <description>Enable UDP fragmentation offloading</description>
                  </valueHelp>
                  <valueHelp>
                    <format>off</format>
                    <description>Disable UDP fragmentation offloading</description>
                  </valueHelp>
                  <constraint>
                    <regex>(on|off)</regex>
                  </constraint>
                  <constraintErrorMessage>Must be either 'on' or 'off'</constraintErrorMessage>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="smp-affinity">
            <properties>
              <help>CPU interrupt affinity mask</help>
              <completionHelp>
                <list>auto 10 100 1000 2500 5000 10000</list>
              </completionHelp>
              <valueHelp>
                <format>auto</format>
                <description>Auto negotiation (default)</description>
              </valueHelp>
              <valueHelp>
                <format>hex</format>
                <description>Bitmask representing CPUs that this NIC will interrupt</description>
              </valueHelp>
              <valueHelp>
                <format>hex,hex</format>
                <description>Bitmasks representing CPUs for interrupt and receive processing</description>
              </valueHelp>
              <constraint>
                <regex>(auto)</regex>
                <regex>[0-9a-f]+(|,[0-9a-f]+)$</regex>
              </constraint>
              <constraintErrorMessage>IRQ affinity mask must be hex value or auto</constraintErrorMessage>
            </properties>
          </leafNode>
          <leafNode name="speed">
            <properties>
              <help>Link speed</help>
              <completionHelp>
                <list>auto 10 100 1000 2500 5000 10000 25000 40000 50000 100000</list>
              </completionHelp>
              <valueHelp>
                <format>auto</format>
                <description>Auto negotiation (default)</description>
              </valueHelp>
              <valueHelp>
                <format>10</format>
                <description>10 Mbit/sec</description>
              </valueHelp>
              <valueHelp>
                <format>100</format>
                <description>100 Mbit/sec</description>
              </valueHelp>
              <valueHelp>
                <format>1000</format>
                <description>1 Gbit/sec</description>
              </valueHelp>
              <valueHelp>
                <format>2500</format>
                <description>2.5 Gbit/sec</description>
              </valueHelp>
              <valueHelp>
                <format>5000</format>
                <description>5 Gbit/sec</description>
              </valueHelp>
              <valueHelp>
                <format>10000</format>
                <description>10 Gbit/sec</description>
              </valueHelp>
              <valueHelp>
                <format>25000</format>
                <description>25 Gbit/sec</description>
              </valueHelp>
              <valueHelp>
                <format>40000</format>
                <description>40 Gbit/sec</description>
              </valueHelp>
              <valueHelp>
                <format>50000</format>
                <description>50 Gbit/sec</description>
              </valueHelp>
              <valueHelp>
                <format>100000</format>
                <description>100 Gbit/sec</description>
              </valueHelp>
              <constraint>
                <regex>(auto|10|100|1000|2500|5000|10000|25000|40000|50000|100000)</regex>
              </constraint>
              <constraintErrorMessage>Speed must be auto, 10, 100, 1000, 2500, 5000, 10000, 25000, 40000, 50000 or 100000</constraintErrorMessage>
            </properties>
          </leafNode>
          #include <include/vif-s.xml.i>
          #include <include/vif.xml.i>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>