summaryrefslogtreecommitdiff
path: root/interface-definitions/service_config-sync.xml.in
blob: e9ea9aa4b9a2b22243d69e264e13f322d1ada54f (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
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
<?xml version="1.0" encoding="UTF-8"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="config-sync" owner="${vyos_conf_scripts_dir}/service_config-sync.py">
        <properties>
          <help>Configuration synchronization</help>
        </properties>
        <children>
          <node name="secondary">
            <properties>
              <help>Secondary server parameters</help>
            </properties>
            <children>
              <leafNode name="address">
                <properties>
                  <help>IP address</help>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>IPv4 address to match</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv6</format>
                    <description>IPv6 address to match</description>
                  </valueHelp>
                  <valueHelp>
                    <format>hostname</format>
                    <description>FQDN address to match</description>
                  </valueHelp>
                  <constraint>
                    <validator name="ipv4-address"/>
                    <validator name="ipv6-address"/>
                    <validator name="fqdn"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="timeout">
                <properties>
                  <help>Connection API timeout</help>
                  <valueHelp>
                    <format>u32:1-3600</format>
                    <description>Connection API timeout</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-3600"/>
                  </constraint>
                </properties>
                <defaultValue>60</defaultValue>
              </leafNode>
              <leafNode name="key">
                <properties>
                  <help>HTTP API key</help>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="mode">
            <properties>
              <help>Synchronization mode</help>
              <completionHelp>
                <list>load set</list>
              </completionHelp>
              <valueHelp>
                <format>load</format>
                <description>Load and replace configuration section</description>
              </valueHelp>
              <valueHelp>
                <format>set</format>
                <description>Set configuration section</description>
              </valueHelp>
              <constraint>
                <regex>(load|set)</regex>
              </constraint>
            </properties>
          </leafNode>
          <node name="section">
            <properties>
              <help>Section for synchronization</help>
            </properties>
            <children>
              <leafNode name="firewall">
                <properties>
                  <help>Firewall</help>
                  <valueless/>
                </properties>
              </leafNode>
              <node name="interfaces">
                <properties>
                  <help>Interfaces</help>
                </properties>
                <children>
                  <leafNode name="bonding">
                    <properties>
                      <help>Bonding interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="bridge">
                    <properties>
                      <help>Bridge interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="dummy">
                    <properties>
                      <help>Dummy interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="ethernet">
                    <properties>
                      <help>Ethernet interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="geneve">
                    <properties>
                      <help>GENEVE interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="input">
                    <properties>
                      <help>Input interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="l2tpv3">
                    <properties>
                      <help>L2TPv3 interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="loopback">
                    <properties>
                      <help>Loopback interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="macsec">
                    <properties>
                      <help>MACsec interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="openvpn">
                    <properties>
                      <help>OpenVPN interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="pppoe">
                    <properties>
                      <help>PPPoE interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="pseudo-ethernet">
                    <properties>
                      <help>Pseudo-Ethernet interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="sstpc">
                    <properties>
                      <help>SSTP client interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="tunnel">
                    <properties>
                      <help>Tunnel interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="virtual-ethernet">
                    <properties>
                      <help>Virtual Ethernet interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="vti">
                    <properties>
                      <help>Virtual tunnel interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="vxlan">
                    <properties>
                      <help>VXLAN interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="wireguard">
                    <properties>
                      <help>Wireguard interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="wireless">
                    <properties>
                      <help>Wireless interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="wwan">
                    <properties>
                      <help>WWAN interface</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="nat">
                <properties>
                  <help>NAT</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="nat66">
                <properties>
                  <help>NAT66</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="pki">
                <properties>
                  <help>Public key infrastructure (PKI)</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="policy">
                <properties>
                  <help>Routing policy</help>
                  <valueless/>
                </properties>
              </leafNode>
              <node name="protocols">
                <properties>
                  <help>Routing protocols</help>
                </properties>
                <children>
                  <leafNode name="babel">
                    <properties>
                      <help>Babel Routing Protocol</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="bfd">
                    <properties>
                      <help>Bidirectional Forwarding Detection (BFD)</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="bgp">
                    <properties>
                      <help>Border Gateway Protocol (BGP)</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="failover">
                    <properties>
                      <help>Failover route</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="igmp-proxy">
                    <properties>
                      <help>Internet Group Management Protocol (IGMP) proxy</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="isis">
                    <properties>
                      <help>Intermediate System to Intermediate System (IS-IS)</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="mpls">
                    <properties>
                      <help>Multiprotocol Label Switching (MPLS)</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="nhrp">
                    <properties>
                      <help>Next Hop Resolution Protocol (NHRP) parameters</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="ospf">
                    <properties>
                      <help>Open Shortest Path First (OSPF)</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="ospfv3">
                    <properties>
                      <help>Open Shortest Path First (OSPF) for IPv6</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="pim">
                    <properties>
                      <help>Protocol Independent Multicast (PIM) and IGMP</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="pim6">
                    <properties>
                      <help>Protocol Independent Multicast for IPv6 (PIMv6) and MLD</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="rip">
                    <properties>
                      <help>Routing Information Protocol (RIP) parameters</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="ripng">
                    <properties>
                      <help>Routing Information Protocol (RIPng) parameters</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="rpki">
                    <properties>
                      <help>Resource Public Key Infrastructure (RPKI)</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="segment-routing">
                    <properties>
                      <help>Segment Routing</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="static">
                    <properties>
                      <help>Static Routing</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="qos">
                <properties>
                  <help>Quality of Service (QoS)</help>
                </properties>
                <children>
                  <leafNode name="interface">
                    <properties>
                      <help>Interface to apply QoS policy</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="policy">
                    <properties>
                      <help>Service Policy definitions</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="service">
                <properties>
                  <help>System services</help>
                </properties>
                <children>
                  <leafNode name="console-server">
                    <properties>
                      <help>Serial Console Server</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="dhcp-relay">
                    <properties>
                      <help>Host Configuration Protocol (DHCP) relay agent</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="dhcp-server">
                    <properties>
                      <help>Dynamic Host Configuration Protocol (DHCP) for DHCP server</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="dhcpv6-relay">
                    <properties>
                      <help>DHCPv6 Relay Agent parameters</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="dhcpv6-server">
                    <properties>
                      <help>DHCP for IPv6 (DHCPv6) server</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="dns">
                    <properties>
                      <help>Domain Name System (DNS) related services</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="lldp">
                    <properties>
                      <help>LLDP settings</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="mdns">
                    <properties>
                      <help>Multicast DNS (mDNS) parameters</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="monitoring">
                    <properties>
                      <help>Monitoring services</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="ndp-proxy">
                    <properties>
                      <help>Neighbor Discovery Protocol (NDP) Proxy</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="ntp">
                    <properties>
                      <help>Network Time Protocol (NTP) configuration</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="snmp">
                    <properties>
                      <help>Simple Network Management Protocol (SNMP)</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="tftp-server">
                    <properties>
                      <help>Trivial File Transfer Protocol (TFTP) server</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="webproxy">
                    <properties>
                      <help>Webproxy service settings</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <node name="system">
                <properties>
                  <help>System parameters</help>
                </properties>
                <children>
                  <leafNode name="conntrack">
                    <properties>
                      <help>Connection Tracking</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="flow-accounting">
                    <properties>
                      <help>Flow accounting</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="option">
                    <properties>
                      <help>System Options</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="sflow">
                    <properties>
                      <help>sFlow</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="static-host-mapping">
                    <properties>
                      <help>Map host names to addresses</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="sysctl">
                    <properties>
                      <help>Configure kernel parameters at runtime</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                  <leafNode name="time-zone">
                    <properties>
                      <help>Local time zone</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="vpn">
                <properties>
                  <help>Virtual Private Network (VPN)</help>
                  <valueless/>
                </properties>
              </leafNode>
              <leafNode name="vrf">
                <properties>
                  <help>Virtual Routing and Forwarding</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>