summaryrefslogtreecommitdiff
path: root/interface-definitions/pppoe-server.xml
blob: 543ff1663b61a3f2fd1d7fcc79979ff19166645f (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="service">
    <children>
      <node name="pppoe-server" owner="${vyos_conf_scripts_dir}/accel_pppoe.py">
        <properties>
          <help>Point to Point over Ethernet (PPPoE) Server</help>
          <priority>900</priority>
        </properties>
        <children>
          <leafNode name="access-concentrator">
            <properties>
              <help>Access concentrator name</help>
              <constraint>
                <regex>^[a-zA-Z0-9]{1,100}</regex>
              </constraint>
              <constraintErrorMessage>access-concentrator name limited to aplhanumerical characters only (max. 100)</constraintErrorMessage>
            </properties>  
          </leafNode>
          <node name="authentication">
            <properties>
              <help>Authentication for remote access PPPoE Server</help>
            </properties>
            <children>
              <node name="local-users">
                <properties>
                  <help>Local user authentication for PPPoE server</help>
                </properties>
                <children>
                  <tagNode name="username">
                    <properties>
                      <help>User name for authentication</help>
                    </properties>
                    <children>
                      <leafNode name="disable">
                        <properties>
                          <help>Option to disable a PPPoE Server user</help>
                        </properties>
                      </leafNode>
                      <leafNode name="password">
                        <properties>
                          <help>Password for authentication</help>
                        </properties>
                      </leafNode>
                      <leafNode name="static-ip">
                        <properties>
                          <help>Static client IP address</help>
                        </properties>
                      </leafNode>
                    </children>
                  </tagNode>
                </children>
              </node>
              <leafNode name="mode">
                <properties>
                  <help>Authentication mode for PPPoE Server</help>
                  <valueHelp>
                    <format>local</format>
                    <description>Use local username/password configuration</description>
                  </valueHelp>
                  <valueHelp>
                    <format>radius</format>
                    <description>Use Radius server to autenticate users</description>
                  </valueHelp>
                  <constraint>
                    <regex>^(local|radius)</regex>
                  </constraint>
                </properties>
              </leafNode>
              <tagNode name="radius-server">
                <properties>
                  <help>IP address of radius server</help>
                  <valueHelp>
                    <format>ipv4</format>
                      <description>IP address of radius server</description>
                  </valueHelp>
                </properties>
                <children>
                  <leafNode name="key">
                    <properties>
                      <help>Key for accessing the specified server</help>
                    </properties>
                  </leafNode>
                </children>
              </tagNode>
            </children>
          </node>
          <node name="client-ip-pool">
            <properties>
              <help>Pool of client IP address (must be within a /24)</help>
            </properties>
            <children>
              <leafNode name="start">
                <properties>
                  <help>First IP address in the pool</help>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="stop">
                <properties>
                  <help>Last IP address in the pool</help>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
          <node name="dns-servers">
            <properties>
              <help>Domain Name Service (DNS) server</help>
            </properties>
            <children>
            <leafNode name="server-1">
              <properties>
                <help>Primary DNS server</help>
                <constraint>
                  <validator name="ipv4-address"/>
                </constraint>
              </properties>
            </leafNode>
            <leafNode name="server-2">
              <properties>
                <help>Secondary DNS server</help>
                <constraint>
                  <validator name="ipv4-address"/>
                </constraint>
              </properties>
            </leafNode>
            </children>
          </node> 
          <leafNode name="interface">
            <properties>
              <help>interface(s) to listen on</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces.py</script>
              </completionHelp>
              <multi/>
            </properties>
          </leafNode>
          <leafNode name="local-ip">
            <properties>
              <help>local gateway address</help>
              <constraint>
                <validator name="ipv4-address"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="mtu">
            <properties>
              <help>Maximum Transmission Unit (MTU) - default 1440</help>
              <constraint>
              <validator name="numeric" argument="--range 128-16384"/>
              </constraint>
            </properties>
          </leafNode>
          <node name="radius">
            <properties>
              <help>RADIUS settings</help>
            </properties>
            <children>
              <leafNode name="default-interim-interval">
                <properties>
                  <help>Default interim accounting interval</help>
                  <valueHelp>
                    <format>text</format>
                    <description>Use local username/password configuration</description>
                  </valueHelp>
                  <constraint>
                    <validator name="numeric" argument="--range 60-10000000"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="service-name">
            <properties>
              <help>Service name</help>
              <constraint>
                <regex>^[a-zA-Z0-9\-]{1,100}</regex>
              </constraint>
              <constraintErrorMessage>servicename can contain aplhanumerical characters and dash only (max. 100)</constraintErrorMessage>
            </properties>
          </leafNode>
          <node name="wins-servers">
            <properties>
              <help>Windows Internet Name Service (WINS) server settings</help>
            </properties>
            <children>
              <leafNode name="server-1">
                <properties>
                  <help>Primary WINS server</help>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
              </leafNode>
              <leafNode name="server-2">
                <properties>
                  <help>Secondary WINS server</help>
                  <constraint>
                    <validator name="ipv4-address"/>
                  </constraint>
                </properties>
              </leafNode>
            </children>
          </node>
        </children>
      </node>
    </children>
  </node>
</interfaceDefinition>