summaryrefslogtreecommitdiff
path: root/interface-definitions/interfaces-bridge.xml
blob: 14887ee025a77fcf32674c9a21ae13be59df330c (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="interfaces">
    <children>
      <tagNode name="bridge" owner="${vyos_conf_scripts_dir}/interface-bridge.py">
        <properties>
          <help>Bridge interface name</help>
          <priority>470</priority>
          <constraint>
            <regex>^br[0-9]+$</regex>
          </constraint>
          <constraintErrorMessage>Bridge interface must be named brN</constraintErrorMessage>
          <valueHelp>
            <format>brN</format>
            <description>Bridge interface name</description>
          </valueHelp>
        </properties>
        <children>
          <leafNode name="address">
            <properties>
              <help>IP address</help>
              <completionHelp>
                <list>dhcp dhcpv6</list>
              </completionHelp>
              <valueHelp>
                <format>ipv4net</format>
                <description>IPv4 address and prefix length</description>
              </valueHelp>
              <valueHelp>
                <format>ipv6net</format>
                <description>IPv6 address and prefix length</description>
              </valueHelp>
              <valueHelp>
                <format>dhcp</format>
                <description>Dynamic Host Configuration Protocol</description>
              </valueHelp>
              <valueHelp>
                <format>dhcpv6</format>
                <description>Dynamic Host Configuration Protocol for IPv6</description>
              </valueHelp>
              <constraint>
                <validator name="ip-cidr"/>
                <regex>(dhcp|dhcpv6)</regex>
              </constraint>
              <multi/>
            </properties>
          </leafNode>
          <leafNode name="aging">
            <properties>
              <help>Interval addresses are retained</help>
              <valueHelp>
                <format>0</format>
                <description>Disable retaining address in bridge (always flood)</description>
              </valueHelp>
              <valueHelp>
                <format>10-1000000</format>
                <description>Address aging time for bridge seconds (default 300)</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 0-0"/>
                <validator name="numeric" argument="--range 10-1000000"/>
              </constraint>
            </properties>
          </leafNode>
          <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>
            </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="forwarding-delay">
            <properties>
              <help>Forwarding delay</help>
              <valueHelp>
                <format>0-200</format>
                <description>Spanning Tree Protocol forwarding delay in seconds (default 15)</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 0-200"/>
              </constraint>
              <constraintErrorMessage>Forwarding delay must be between 0 and 200 seconds</constraintErrorMessage>
            </properties>
          </leafNode>
          <leafNode name="hello-time">
            <properties>
              <help>Hello packet advertisment interval</help>
              <valueHelp>
                <format>1-10</format>
                <description>Spanning Tree Protocol hello advertisement interval in seconds (default 2)</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-10"/>
              </constraint>
              <constraintErrorMessage>Bridge Hello interval must be between 1 and 10 seconds</constraintErrorMessage>
            </properties>
          </leafNode>
          <node name="igmp">
            <properties>
              <help>Internet Group Management Protocol (IGMP) settings</help>
            </properties>
            <children>
              <leafNode name="querier">
                <properties>
                  <help>Enable IGMP querier</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </node>
          <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>Bridge max aging value must be between 6 and 86400 seconds</constraintErrorMessage>
                </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="max-age">
            <properties>
              <help>Interval at which neighbor bridges are removed</help>
              <valueHelp>
                <format>1-40</format>
                <description>Bridge maximum aging time in seconds (default 20)</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-40"/>
              </constraint>
              <constraintErrorMessage>Bridge max aging value must be between 1 and 40 seconds</constraintErrorMessage>
            </properties>
          </leafNode>
          <node name="member">
            <properties>
              <help>Bridge member interfaces</help>
            </properties>
            <children>
              <tagNode name="interface">
                <properties>
                  <help>Member interface name</help>
                  <completionHelp>
                    <script>${vyos_completion_dir}/list_interfaces.py --bridgeable</script>
                  </completionHelp>
                </properties>
                <children>
                  <leafNode name="cost">
                    <properties>
                      <help>Bridge port cost</help>
                      <valueHelp>
                        <format>1-65535</format>
                        <description>Path cost value for Spanning Tree Protocol</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-65535"/>
                      </constraint>
                      <constraintErrorMessage>Path cost value must be between 1 and 65535</constraintErrorMessage>
                    </properties>
                  </leafNode>
                  <leafNode name="priority">
                    <properties>
                      <help>Bridge port priority</help>
                      <valueHelp>
                        <format>0-63</format>
                        <description>Bridge port priority</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 1-63"/>
                      </constraint>
                      <constraintErrorMessage>Port priority value must be between 0 and 63</constraintErrorMessage>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
            </children>
          </node>
          <leafNode name="priority">
            <properties>
              <help>Priority for this bridge</help>
              <valueHelp>
                <format>0-65535</format>
                <description>Bridge priority (default 32768)</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 0-65535"/>
              </constraint>
              <constraintErrorMessage>Bridge priority must be between 0 and 65535 (multiples of 4096)</constraintErrorMessage>
            </properties>
          </leafNode>
          <leafNode name="stp">
            <properties>
              <help>Enable spanning tree protocol</help>
              <valueless/>
            </properties>
          </leafNode>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>