summaryrefslogtreecommitdiff
path: root/interface-definitions/interfaces-bonding.xml.in
blob: f24577100aae0bb7f9396ee40fb9ec3244345cef (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="interfaces">
    <children>
      <tagNode name="bonding" owner="${vyos_conf_scripts_dir}/interfaces-bonding.py">
        <properties>
          <help>Bonding interface name</help>
          <priority>320</priority>
          <constraint>
            <regex>bond[0-9]+$</regex>
          </constraint>
          <constraintErrorMessage>Bonding interface must be named bondN</constraintErrorMessage>
          <valueHelp>
            <format>bondN</format>
            <description>Bonding interface name</description>
          </valueHelp>
        </properties>
        <children>
          #include <include/address-ipv4-ipv6-dhcp.xml.i>
          <node name="arp-monitor">
            <properties>
              <help>ARP link monitoring parameters</help>
            </properties>
            <children>
              <leafNode name="interval">
                <properties>
                  <help>ARP link monitoring interval</help>
                  <valueHelp>
                    <format>0-4294967295</format>
                    <description>Specifies the ARP link monitoring frequency in milliseconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-4294967295"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="target">
                <properties>
                  <help>IP address used for ARP monitoring</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>Network Time Protocol (NTP) IPv4 address</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
            </children>
          </node>
          <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 the 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-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="hash-policy">
            <properties>
              <help>Bonding transmit hash policy</help>
              <completionHelp>
                <list>layer2 layer2+3 layer3+4</list>
              </completionHelp>
              <valueHelp>
                <format>layer2</format>
                <description>use MAC addresses to generate the hash (802.3ad, default)</description>
              </valueHelp>
              <valueHelp>
                <format>layer2+3</format>
                <description>combine MAC address and IP address to make hash</description>
              </valueHelp>
              <valueHelp>
                <format>layer3+4</format>
                <description>combine IP address and port to make hash</description>
              </valueHelp>
              <constraint>
                <regex>(layer2\+3|layer3\+4|layer2)</regex>
              </constraint>
              <constraintErrorMessage>hash-policy must be layer2 layer2+3 or layer3+4</constraintErrorMessage>
            </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="mode">
            <properties>
              <help>Bonding mode</help>
              <completionHelp>
                <list>802.3ad active-backup broadcast round-robin transmit-load-balance adaptive-load-balance xor-hash</list>
              </completionHelp>
              <valueHelp>
                <format>802.3ad</format>
                <description>IEEE 802.3ad Dynamic link aggregation (Default)</description>
              </valueHelp>
              <valueHelp>
                <format>active-backup</format>
                <description>Fault tolerant: only one slave in the bond is active</description>
              </valueHelp>
              <valueHelp>
                <format>broadcast</format>
                <description>Fault tolerant: transmits everything on all slave interfaces</description>
              </valueHelp>
              <valueHelp>
                <format>round-robin</format>
                <description>Load balance: transmit packets in sequential order</description>
              </valueHelp>
              <valueHelp>
                <format>transmit-load-balance</format>
                <description>Load balance: adapts based on transmit load and speed</description>
              </valueHelp>
              <valueHelp>
                <format>adaptive-load-balance</format>
                <description>Load balance: adapts based on transmit and receive plus ARP</description>
              </valueHelp>
              <valueHelp>
                <format>xor-hash</format>
                <description>Distribute based on MAC address</description>
              </valueHelp>
              <constraint>
                <regex>(802.3ad|active-backup|broadcast|round-robin|transmit-load-balance|adaptive-load-balance|xor-hash)</regex>
              </constraint>
              <constraintErrorMessage>mode must be 802.3ad, active-backup, broadcast, round-robin, transmit-load-balance, adaptive-load-balance, or xor</constraintErrorMessage>
            </properties>
          </leafNode>
          <node name="member">
            <properties>
              <help>Bridge member interfaces</help>
            </properties>
            <children>
              <leafNode name="interface">
                <properties>
                  <help>Member interface name</help>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces.py --bondable</script>
                  </completionHelp>
                  <multi/>
                </properties>
              </leafNode>
            </children>
          </node>
          <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>
          <leafNode name="primary">
            <properties>
              <help>Primary device interface</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces.py --bondable</script>
              </completionHelp>
            </properties>
          </leafNode>
          #include <include/vif-s.xml.i>
          #include <include/vif.xml.i>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>