summaryrefslogtreecommitdiff
path: root/interface-definitions/service-pppoe-server.xml.in
blob: b3110929657f6e2d5ace9ccd7b1fe8e6256eb7eb (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="pppoe-server" owner="${vyos_conf_scripts_dir}/service_pppoe-server.py">
        <properties>
          <help>Point to Point over Ethernet (PPPoE) Server</help>
          <priority>900</priority>
        </properties>
        <children>
          #include <include/pppoe-access-concentrator.xml.i>
          <leafNode name="access-concentrator">
            <defaultValue>vyos-ac</defaultValue>
          </leafNode>
          <node name="authentication">
            <properties>
              <help>Authentication for remote access PPPoE Server</help>
            </properties>
            <children>
              #include <include/accel-ppp/auth-local-users.xml.i>
              #include <include/accel-ppp/auth-mode.xml.i>
              #include <include/accel-ppp/auth-protocols.xml.i>
              #include <include/radius-server-ipv4.xml.i>
              #include <include/accel-ppp/radius-additions.xml.i>
              <node name="radius">
                <children>
                  #include <include/accel-ppp/radius-additions-rate-limit.xml.i>
                  <leafNode name="called-sid-format">
                    <properties>
                      <help>Format of Called-Station-Id attribute</help>
                      <completionHelp>
                        <list>ifname ifname:mac</list>
                      </completionHelp>
                      <constraint>
                        <regex>(ifname|ifname:mac)</regex>
                      </constraint>
                      <constraintErrorMessage>Invalid Called-Station-Id format</constraintErrorMessage>
                      <valueHelp>
                        <format>ifname</format>
                        <description>NAS-Port-Id - should contain root interface name (NAS-Port-Id=eth1)</description>
                      </valueHelp>
                      <valueHelp>
                        <format>ifname:mac</format>
                        <description>NAS-Port-Id - should contain root interface name and mac address (NAS-Port-Id=eth1:00:00:00:00:00:00)</description>
                      </valueHelp>
                    </properties>
                  </leafNode>
                </children>
              </node>
            </children>
          </node>
          <node name="client-ip-pool">
            <properties>
              <help>Pool of client IP addresses (must be within a /24)</help>
            </properties>
            <children>
              #include <include/accel-ppp/client-ip-pool-start-stop.xml.i>
              #include <include/accel-ppp/client-ip-pool-subnet.xml.i>
            </children>
          </node>
          #include <include/accel-ppp/client-ipv6-pool.xml.i>
          #include <include/name-server-ipv4-ipv6.xml.i>
          <tagNode name="interface">
            <properties>
              <help>interface(s) to listen on</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces.py</script>
              </completionHelp>
            </properties>
            <children>
              #include <include/accel-ppp/vlan.xml.i>
            </children>
          </tagNode>
          #include <include/accel-ppp/gateway-address.xml.i>
          #include <include/accel-ppp/mtu-128-16384.xml.i>
          <node name="limits">
            <properties>
              <help>Limits the connection rate from a single source</help>
            </properties>
            <children>
              <leafNode name="connection-limit">
                <properties>
                  <help>Acceptable rate of connections (e.g. 1/min, 60/sec)</help>
                  <constraint>
                    <regex>[0-9]+\/(min|sec)</regex>
                  </constraint>
                  <constraintErrorMessage>illegal value</constraintErrorMessage>
                </properties>
              </leafNode>
              <leafNode name="burst">
                <properties>
                  <help>Burst count</help>
                </properties>
              </leafNode>
              <leafNode name="timeout">
                <properties>
                  <help>Timeout in seconds</help>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="service-name">
            <properties>
              <help>Service name</help>
              <constraint>
                <regex>[a-zA-Z0-9\-]{1,100}</regex>
              </constraint>
              <constraintErrorMessage>Service-name can contain aplhanumerical characters and dashes only (max. 100)</constraintErrorMessage>
              <multi/>
            </properties>
          </leafNode>
          #include <include/accel-ppp/wins-server.xml.i>
          <node name="ppp-options">
            <properties>
              <help>Advanced protocol options</help>
            </properties>
            <children>
              <leafNode name="min-mtu">
                <properties>
                  <help>Minimum acceptable MTU (68-65535)</help>
                  <constraint>
                    <validator name="numeric" argument="--range 68-65535"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="mru">
                <properties>
                  <help>Preferred MRU (68-65535)</help>
                  <constraint>
                    <validator name="numeric" argument="--range 68-65535"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="ccp">
                <properties>
                  <help>CCP negotiation (default disabled)</help>
                  <valueless />
                </properties>
              </leafNode>
              #include <include/accel-ppp/ppp-mppe.xml.i>
              #include <include/accel-ppp/lcp-echo-interval-failure.xml.i>
              #include <include/accel-ppp/lcp-echo-timeout.xml.i>
              #include <include/accel-ppp/ppp-interface-cache.xml.i>
              <leafNode name="ipv4">
                <properties>
                  <help>IPv4 (IPCP) negotiation algorithm</help>
                  <constraint>
                    <regex>(deny|allow|prefer|require)</regex>
                  </constraint>
                  <constraintErrorMessage>invalid value</constraintErrorMessage>
                  <valueHelp>
                    <format>deny</format>
                    <description>Do not negotiate IPv4</description>
                  </valueHelp>
                  <valueHelp>
                    <format>allow</format>
                    <description>Negotiate IPv4 only if client requests</description>
                  </valueHelp>
                  <valueHelp>
                    <format>prefer</format>
                    <description>Ask client for IPv4 negotiation, do not fail if it rejects</description>
                  </valueHelp>
                  <valueHelp>
                    <format>require</format>
                    <description>Require IPv4 negotiation</description>
                  </valueHelp>
                  <completionHelp>
                    <list>deny allow prefer require</list>
                  </completionHelp>
                </properties>
              </leafNode>
              #include <include/accel-ppp/ppp-options-ipv6.xml.i>
              <leafNode name="ipv6-intf-id">
                <properties>
                  <help>Fixed or random interface identifier for IPv6</help>
                  <completionHelp>
                    <list>random</list>
                  </completionHelp>
                  <valueHelp>
                    <format>random</format>
                    <description>Random interface identifier for IPv6</description>
                  </valueHelp>
                  <valueHelp>
                    <format>x:x:x:x</format>
                    <description>specify interface identifier for IPv6</description>
                  </valueHelp>
                </properties>
              </leafNode>
              <leafNode name="ipv6-peer-intf-id">
                <properties>
                  <help>Peer interface identifier for IPv6</help>
                  <completionHelp>
                    <list>random calling-sid ipv4</list>
                  </completionHelp>
                  <valueHelp>
                    <format>x:x:x:x</format>
                    <description>Interface identifier for IPv6</description>
                  </valueHelp>
                  <valueHelp>
                    <format>random</format>
                    <description>Use a random interface identifier for IPv6</description>
                  </valueHelp>
                  <valueHelp>
                    <format>ipv4</format>
                    <description>Calculate interface identifier from IPv4 address, for example 192:168:0:1</description>
                  </valueHelp>
                  <valueHelp>
                    <format>calling-sid</format>
                    <description>Calculate interface identifier from calling-station-id</description>
                  </valueHelp>
                </properties>
              </leafNode>
              <leafNode name="ipv6-accept-peer-intf-id">
                <properties>
                  <help>Accept peer interface identifier</help>
                  <valueless />
                </properties>
              </leafNode>
            </children>
          </node>
          <tagNode name="pado-delay">
            <properties>
              <help>PADO delays</help>
              <valueHelp>
                <format>u32:1-999999</format>
                <description>Number in ms</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 1-999999"/>
              </constraint>
              <constraintErrorMessage>Invalid PADO delay</constraintErrorMessage>
            </properties>
            <children>
              <leafNode name="sessions">
                <properties>
                  <help>Number of sessions</help>
                  <valueHelp>
                    <format>u32:1-999999</format>
                    <description>Number of sessions</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 1-999999"/>
                  </constraint>
                  <constraintErrorMessage>Invalid number of delayed sessions</constraintErrorMessage>
                </properties>
              </leafNode>
            </children>
          </tagNode>
          <leafNode name="session-control">
            <properties>
              <help>control sessions count</help>
              <constraint>
                <regex>(deny|disable|replace)</regex>
              </constraint>
              <constraintErrorMessage>Invalid value</constraintErrorMessage>
              <valueHelp>
                <format>disable</format>
                <description>Disables session control</description>
              </valueHelp>
              <valueHelp>
                <format>deny</format>
                <description>Deny second session authorization</description>
              </valueHelp>
              <valueHelp>
                <format>replace</format>
                <description>Terminate first session when second is authorized</description>
              </valueHelp>
              <completionHelp>
                <list>deny disable replace</list>
              </completionHelp>
            </properties>
            <defaultValue>replace</defaultValue>
          </leafNode>
          <node name="snmp">
            <properties>
              <help>Enable SNMP</help>
            </properties>
            <children>
              <leafNode name="master-agent">
                <properties>
                  <help>enable SNMP master agent mode</help>
                  <valueless />
                </properties>
              </leafNode>
            </children>
          </node>
          <node name="extended-scripts">
            <properties>
              <help>Extended script execution</help>
            </properties>
            <children>
              <leafNode name="on-pre-up">
                <properties>
                  <help>Script to run before PPPoE session interface comes up</help>
                    <constraint>
                      <validator name="script"/>
                    </constraint>
                </properties>
              </leafNode>
              <leafNode name="on-up">
                <properties>
                  <help>Script to run when PPPoE session interface is completely configured and started</help>
                    <constraint>
                      <validator name="script"/>
                    </constraint>
                </properties>
              </leafNode>
              <leafNode name="on-down">
                <properties>
                  <help>Script to run when PPPoE session interface going to terminate</help>
                    <constraint>
                      <validator name="script"/>
                    </constraint>
                </properties>
              </leafNode>
              <leafNode name="on-change">
                <properties>
                  <help>Script to run when PPPoE session interface changed by RADIUS CoA handling</help>
                    <constraint>
                      <validator name="script"/>
                    </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>