summaryrefslogtreecommitdiff
path: root/interface-definitions/service_router-advert.xml.in
blob: 166a4a0cf811ac9c8cfd80e3d7daadd06c043670 (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
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="router-advert" owner="${vyos_conf_scripts_dir}/service_router-advert.py">
        <properties>
          <help>IPv6 Router Advertisements (RAs) service</help>
          <priority>900</priority>
        </properties>
        <children>
          <tagNode name="interface">
            <properties>
              <help>Interface to send RA on</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces</script>
              </completionHelp>
            </properties>
            <children>
              <leafNode name="hop-limit">
                <properties>
                  <help>Set Hop Count field of the IP header for outgoing packets</help>
                  <valueHelp>
                    <format>u32:0</format>
                    <description>Unspecified (by this router)</description>
                  </valueHelp>
                  <valueHelp>
                    <format>u32:1-255</format>
                    <description>Value should represent current diameter of the Internet</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-255"/>
                  </constraint>
                  <constraintErrorMessage>Hop count must be between 0 and 255</constraintErrorMessage>
                </properties>
                <defaultValue>64</defaultValue>
              </leafNode>
              <leafNode name="default-lifetime">
                <properties>
                  <help>Lifetime associated with the default router in units of seconds</help>
                  <valueHelp>
                    <format>u32:4-9000</format>
                    <description>Router Lifetime in seconds</description>
                  </valueHelp>
                  <valueHelp>
                    <format>0</format>
                    <description>Not a default router</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-0 --range 4-9000"/>
                  </constraint>
                  <constraintErrorMessage>Default router livetime bust be 0 or between 4 and 9000</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="default-preference">
                <properties>
                  <help>Preference associated with the default router,</help>
                  <completionHelp>
                    <list>low medium high</list>
                  </completionHelp>
                  <valueHelp>
                    <format>low</format>
                    <description>Default router has low preference</description>
                  </valueHelp>
                  <valueHelp>
                    <format>medium</format>
                    <description>Default router has medium preference</description>
                  </valueHelp>
                  <valueHelp>
                    <format>high</format>
                    <description>Default router has high preference</description>
                  </valueHelp>
                  <constraint>
                    <regex>(low|medium|high)</regex>
                  </constraint>
                  <constraintErrorMessage>Default preference must be low, medium or high</constraintErrorMessage>
                </properties>
                <defaultValue>medium</defaultValue>
              </leafNode>
              <leafNode name="dnssl">
                <properties>
                  <help>DNS search list</help>
                  <multi/>
                </properties>
              </leafNode>
              <leafNode name="link-mtu">
                <properties>
                  <help>Link MTU value placed in RAs, exluded in RAs if unset</help>
                  <valueHelp>
                    <format>u32:1280-9000</format>
                    <description>Link MTU value in RAs</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1280-9000"/>
                  </constraint>
                  <constraintErrorMessage>Link MTU must be between 1280 and 9000</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="managed-flag">
                <properties>
                  <help>Hosts use the administered (stateful) protocol for address autoconfiguration in addition to any addresses autoconfigured using SLAAC</help>
                  <valueless/>
                </properties>
              </leafNode>
              <node name="interval">
                <properties>
                  <help>Set interval between unsolicited multicast RAs</help>
                </properties>
                <children>
                  <leafNode name="max">
                    <properties>
                      <help>Maximum interval between unsolicited multicast RAs</help>
                      <valueHelp>
                        <format>u32:4-1800</format>
                        <description>Maximum interval in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 4-1800"/>
                      </constraint>
                      <constraintErrorMessage>Maximum interval must be between 4 and 1800 seconds</constraintErrorMessage>
                    </properties>
                    <defaultValue>600</defaultValue>
                  </leafNode>
                  <leafNode name="min">
                    <properties>
                      <help>Minimum interval between unsolicited multicast RAs</help>
                      <valueHelp>
                        <format>u32:3-1350</format>
                        <description>Minimum interval in seconds</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 3-1350"/>
                      </constraint>
                      <constraintErrorMessage>Minimum interval must be between 3 and 1350 seconds</constraintErrorMessage>
                    </properties>
                  </leafNode>
                </children>
              </node>
              #include <include/name-server-ipv6.xml.i>
              <leafNode name="name-server-lifetime">
                <properties>
                  <help>Maximum duration how long the RDNSS entries are used</help>
                  <valueHelp>
                    <format>u32:0</format>
                    <description>Name-servers should no longer be used</description>
                  </valueHelp>
                  <valueHelp>
                    <format>u32:1-7200</format>
                    <description>Maximum interval in seconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-7200"/>
                  </constraint>
                  <constraintErrorMessage>Maximum interval must be between 1 and 7200 seconds</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="other-config-flag">
                <properties>
                  <help>Hosts use the administered (stateful) protocol for autoconfiguration of other (non-address) information</help>
                  <valueless/>
                </properties>
              </leafNode>
              <tagNode name="route">
                <properties>
                  <help>IPv6 route to be advertised in Router Advertisements (RAs)</help>
                  <valueHelp>
                    <format>ipv6net</format>
                    <description>IPv6 route to be advertized</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv6-prefix"/>
                  </constraint>
                </properties>
                <children>
                  <leafNode name="valid-lifetime">
                    <properties>
                      <help>Time in seconds that the route will remain valid</help>
                      <completionHelp>
                        <list>infinity</list>
                      </completionHelp>
                      <valueHelp>
                        <format>u32:1-4294967295</format>
                        <description>Time in seconds that the route will remain valid</description>
                      </valueHelp>
                      <valueHelp>
                        <format>infinity</format>
                        <description>Route will remain preferred forever</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-4294967295"/>
                        <regex>(infinity)</regex>
                      </constraint>
                    </properties>
                    <defaultValue>1800</defaultValue>
                  </leafNode>
                  <leafNode name="route-preference">
                    <properties>
                      <help>Preference associated with the route,</help>
                      <completionHelp>
                        <list>low medium high</list>
                      </completionHelp>
                      <valueHelp>
                        <format>low</format>
                        <description>Route has low preference</description>
                      </valueHelp>
                      <valueHelp>
                        <format>medium</format>
                        <description>Route has medium preference</description>
                      </valueHelp>
                      <valueHelp>
                        <format>high</format>
                        <description>Route has high preference</description>
                      </valueHelp>
                      <constraint>
                        <regex>(low|medium|high)</regex>
                      </constraint>
                      <constraintErrorMessage>Route preference must be low, medium or high</constraintErrorMessage>
                    </properties>
                    <defaultValue>medium</defaultValue>
                  </leafNode>
                  <leafNode name="no-remove-route">
                    <properties>
                      <help>Do not announce this route with a zero second lifetime upon shutdown</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
              <tagNode name="nat64prefix">
                <properties>
                  <help>NAT64 prefix included in the router advertisements</help>
                  <valueHelp>
                    <format>ipv6net</format>
                    <description>IPv6 prefix to be advertized</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv6-prefix"/>
                  </constraint>
                </properties>
                <children>
                  <leafNode name="valid-lifetime">
                    <properties>
                      <help>Time in seconds that the prefix will remain valid</help>
                      <completionHelp>
                        <list>infinity</list>
                      </completionHelp>
                      <valueHelp>
                        <format>u32:4-65528</format>
                        <description>Time in seconds that the prefix will remain valid</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 4-65528"/>
                      </constraint>
                    </properties>
                    <defaultValue>65528</defaultValue>
                  </leafNode>
                </children>
              </tagNode>
              <tagNode name="prefix">
                <properties>
                  <help>IPv6 prefix to be advertised in Router Advertisements (RAs)</help>
                  <valueHelp>
                    <format>ipv6net</format>
                    <description>IPv6 prefix to be advertized</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv6-prefix"/>
                  </constraint>
                </properties>
                <children>
                  <leafNode name="no-autonomous-flag">
                    <properties>
                      <help>Prefix can not be used for stateless address auto-configuration</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="no-on-link-flag">
                    <properties>
                      <help>Prefix can not be used for on-link determination</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="deprecate-prefix">
                    <properties>
                      <help>Upon shutdown, this option will deprecate the prefix by announcing it in the shutdown RA</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="decrement-lifetime">
                    <properties>
                      <help>Lifetime is decremented by the number of seconds since the last RA - use in conjunction with a DHCPv6-PD prefix</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="preferred-lifetime">
                    <properties>
                      <help>Time in seconds that the prefix will remain preferred</help>
                      <completionHelp>
                        <list>infinity</list>
                      </completionHelp>
                      <valueHelp>
                        <format>u32</format>
                        <description>Time in seconds that the prefix will remain preferred</description>
                      </valueHelp>
                      <valueHelp>
                        <format>infinity</format>
                        <description>Prefix will remain preferred forever</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-4294967295"/>
                        <regex>(infinity)</regex>
                      </constraint>
                    </properties>
                    <defaultValue>14400</defaultValue>
                  </leafNode>
                  <leafNode name="valid-lifetime">
                    <properties>
                      <help>Time in seconds that the prefix will remain valid</help>
                      <completionHelp>
                        <list>infinity</list>
                      </completionHelp>
                      <valueHelp>
                        <format>u32:1-4294967295</format>
                        <description>Time in seconds that the prefix will remain valid</description>
                      </valueHelp>
                      <valueHelp>
                        <format>infinity</format>
                        <description>Prefix will remain preferred forever</description>
                      </valueHelp>
                      <constraint>
                        <validator name="numeric" argument="--range 0-4294967295"/>
                        <regex>(infinity)</regex>
                      </constraint>
                    </properties>
                    <defaultValue>2592000</defaultValue>
                  </leafNode>
                </children>
              </tagNode>
              <leafNode name="source-address">
                <properties>
                  <help>Use IPv6 address as source address. Useful with VRRP.</help>
                  <valueHelp>
                    <format>ipv6</format>
                    <description>IPv6 address to be advertized (must be configured on interface)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv6-address"/>
                  </constraint>
                  <multi/>
                </properties>
              </leafNode>
              <leafNode name="reachable-time">
                <properties>
                  <help>Time, in milliseconds, that a node assumes a neighbor is reachable after having received a reachability confirmation</help>
                  <valueHelp>
                    <format>u32:0</format>
                    <description>Reachable Time unspecified by this router</description>
                  </valueHelp>
                  <valueHelp>
                    <format>u32:1-3600000</format>
                    <description>Reachable Time value in RAs (in milliseconds)</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-0 --range 1-3600000"/>
                  </constraint>
                  <constraintErrorMessage>Reachable time must be 0 or between 1 and 3600000 milliseconds</constraintErrorMessage>
                </properties>
                <defaultValue>0</defaultValue>
              </leafNode>
              <leafNode name="retrans-timer">
                <properties>
                  <help>Time in milliseconds between retransmitted Neighbor Solicitation messages</help>
                  <valueHelp>
                    <format>u32:0</format>
                    <description>Time, in milliseconds, between retransmitted Neighbor Solicitation messages</description>
                  </valueHelp>
                  <valueHelp>
                    <format>u32:1-4294967295</format>
                    <description>Minimum interval in milliseconds</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 0-0 --range 1-4294967295"/>
                  </constraint>
                  <constraintErrorMessage>Retransmit interval must be 0 or between 1 and 4294967295 milliseconds</constraintErrorMessage>
                </properties>
                <defaultValue>0</defaultValue>
              </leafNode>
              <leafNode name="no-send-advert">
                <properties>
                  <help>Do not send router adverts</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </tagNode>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>