summaryrefslogtreecommitdiff
path: root/interface-definitions/interfaces-vxlan.xml
blob: b06c2860c3c743593670f43310f466f6ada28ff9 (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="interfaces">
    <children>
      <tagNode name="vxlan" owner="${vyos_conf_scripts_dir}/interface-vxlan.py">
        <properties>
          <help>Virtual extensible LAN interface (VXLAN)</help>
          <priority>460</priority>
          <constraint>
            <regex>vxlan[0-9]+$</regex>
          </constraint>
          <constraintErrorMessage>VXLAN interface must be named vxlanN</constraintErrorMessage>
          <valueHelp>
            <format>vxlanN</format>
            <description>VXLAN interface name</description>
          </valueHelp>
        </properties>
        <children>
          <leafNode name="address">
            <properties>
              <help>IP address</help>
              <valueHelp>
                <format>ipv4net</format>
                <description>IPv4 address and prefix length</description>
              </valueHelp>
              <valueHelp>
                <format>ipv6net</format>
                <description>IPv6 address and prefix length</description>
              </valueHelp>
              <multi/>
              <constraint>
                <validator name="ip-cidr"/>
              </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>
          <leafNode name="disable">
            <properties>
              <help>Disable interface</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="group">
            <properties>
              <help>Multicast group address for VXLAN interface</help>
              <valueHelp>
                <format>ipv4</format>
                <description>Multicast group address</description>
              </valueHelp>
              <constraint>
                <validator name="ipv4-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>
            </children>
          </node>
          <leafNode name="link">
            <properties>
              <help>Underlay device of VXLAN interface</help>
              <valueHelp>
                <format>interface</format>
                <description>Interface used for VXLAN underlay</description>
              </valueHelp>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces.py</script>
              </completionHelp>
            </properties>
          </leafNode>
          <leafNode name="mtu">
            <properties>
              <help>Maximum Transmission Unit (MTU)</help>
              <valueHelp>
                <format>1450-9000</format>
                <description>Maximum Transmission Unit</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1450-9000"/>
              </constraint>
              <constraintErrorMessage>MTU must be between 1450 and 9000</constraintErrorMessage>
            </properties>
          </leafNode>
          <leafNode name="remote">
            <properties>
              <help>Remote address of VXLAN tunnel</help>
              <valueHelp>
                <format>ipv4</format>
                <description>Remote address of VXLAN tunnel</description>
              </valueHelp>
              <constraint>
                <validator name="ipv4-address"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="port">
            <properties>
              <help>Destination port of VXLAN tunnel (default: 8472)</help>
              <valueHelp>
                <format>1-65535</format>
                <description>Numeric IP port</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="vni">
            <properties>
              <help>Virtual Network Identifier</help>
              <valueHelp>
                <format>0-16777214</format>
                <description>VXLAN virtual network identifier</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 0-16777214"/>
              </constraint>
            </properties>
          </leafNode>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>