summaryrefslogtreecommitdiff
path: root/interface-definitions/interfaces-l2tpv3.xml.in
blob: 3a878ad7633cea1f23eec54294c9f090ca562e75 (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="interfaces">
    <children>
      <tagNode name="l2tpv3" owner="${vyos_conf_scripts_dir}/interfaces-l2tpv3.py">
        <properties>
          <help>Layer 2 Tunnel Protocol Version 3 (L2TPv3) Interface</help>
          <priority>485</priority>
          <constraint>
            <regex>^l2tpeth[0-9]+$</regex>
          </constraint>
          <constraintErrorMessage>L2TPv3 interface must be named l2tpethN</constraintErrorMessage>
          <valueHelp>
            <format>l2tpethN</format>
            <description>L2TPv3 interface name</description>
          </valueHelp>
        </properties>
        <children>
          #include <include/address-ipv4-ipv6.xml.i>
          #include <include/interface-description.xml.i>
          <leafNode name="destination-port">
            <properties>
              <help>UDP destination port for L2TPv3 tunnel (default: 5000)</help>
              <valueHelp>
                <format>1-65535</format>
                <description>Numeric IP port</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
            <defaultValue>5000</defaultValue>
          </leafNode>
          #include <include/interface-disable.xml.i>
          <leafNode name="encapsulation">
            <properties>
              <help>Encapsulation type (default: UDP)</help>
              <completionHelp>
                <list>udp ip</list>
              </completionHelp>
              <valueHelp>
                <format>udp</format>
                <description>UDP encapsulation</description>
              </valueHelp>
              <valueHelp>
                <format>ip</format>
                <description>IP encapsulation</description>
              </valueHelp>
              <constraint>
                <regex>(udp|ip)</regex>
              </constraint>
              <constraintErrorMessage>Encapsulation must be UDP or IP</constraintErrorMessage>
            </properties>
            <defaultValue>udp</defaultValue>
          </leafNode>
          <node name="ipv6">
            <children>
              #include <include/ipv6-address.xml.i>
              #include <include/ipv6-disable-forwarding.xml.i>
              #include <include/ipv6-dup-addr-detect-transmits.xml.i>
            </children>
          </node>
          <leafNode name="local-ip">
            <properties>
              <help>Local IP address for L2TPv3 tunnel</help>
              <valueHelp>
                <format>ipv4</format>
                <description>Local IPv4 address of tunnel</description>
              </valueHelp>
              <valueHelp>
                <format>ipv6</format>
                <description>Local IPv6 address of tunnel</description>
              </valueHelp>
              <constraint>
                <validator name="ip-address"/>
              </constraint>
            </properties>
          </leafNode>
          #include <include/interface-mtu-68-9000.xml.i>
          <leafNode name="peer-session-id">
            <properties>
              <help>Peer session identifier</help>
              <valueHelp>
                <format>1-429496729</format>
                <description>L2TPv3 peer session identifier</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-429496729"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="peer-tunnel-id">
            <properties>
              <help>Peer tunnel identifier</help>
              <valueHelp>
                <format>1-429496729</format>
                <description>L2TPv3 peer tunnel identifier</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-429496729"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="remote-ip">
            <properties>
              <help>Remote IP address for L2TPv3 tunnel</help>
              <valueHelp>
                <format>ipv4</format>
                <description>Remote IPv4 address of tunnel</description>
              </valueHelp>
              <valueHelp>
                <format>ipv6</format>
                <description>Remote IPv6 address of tunnel</description>
              </valueHelp>
              <constraint>
                <validator name="ip-address"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="session-id">
            <properties>
              <help>Session identifier</help>
              <valueHelp>
                <format>1-429496729</format>
                <description>L2TPv3 session identifier</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-429496729"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="source-port">
            <properties>
              <help>UDP source port for L2TPv3 tunnel (default: 5000)</help>
              <valueHelp>
                <format>1-65535</format>
                <description>Numeric IP port</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-65535"/>
              </constraint>
            </properties>
            <defaultValue>5000</defaultValue>
          </leafNode>
          <leafNode name="tunnel-id">
            <properties>
              <help>Local tunnel identifier</help>
              <valueHelp>
                <format>1-429496729</format>
                <description>L2TPv3 local tunnel identifier</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-429496729"/>
              </constraint>
            </properties>
          </leafNode>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>