pppoe-server: T2314: remove boilerplate code and adjust

1 files changed, 671 insertions, 0 deletions

diff --git a/interface-definitions/service_pppoe-server.xml.in b/interface-definitions/service_pppoe-server.xml.in
new file mode 100644
index 000000000..39f4093a7
--- /dev/null
+++ b/interface-definitions/service_pppoe-server.xml.in
@@ -0,0 +1,671 @@
+<?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>
+          <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>
+          <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 alphanumerical characters only (max. 100)</constraintErrorMessage>
+            </properties>
+          </leafNode>
+          <leafNode name="session-control">
+            <properties>
+              <help>control sessions count</help>
+              <constraint>
+                <regex>(deny|disable)</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>
+              <completionHelp>
+                <list>deny disable</list>
+              </completionHelp>
+            </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>
+                      <node name="rate-limit">
+                        <properties>
+                          <help>Upload/Download speed limits</help>
+                        </properties>
+                        <children>
+                          <leafNode name="upload">
+                            <properties>
+                              <help>Upload bandwidth limit in kbits/sec</help>
+                              <constraint>
+                                <validator name="numeric" argument="--range 1-65535"/>
+                              </constraint>
+                            </properties>
+                          </leafNode>
+                          <leafNode name="download">
+                            <properties>
+                              <help>Download bandwidth limit in kbits/sec</help>
+                              <constraint>
+                                <validator name="numeric" argument="--range 1-65535"/>
+                              </constraint>
+                            </properties>
+                          </leafNode>
+                        </children>
+                      </node>
+                    </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 a RADIUS server to autenticate users</description>
+                  </valueHelp>
+                  <constraint>
+                    <regex>(local|radius)</regex>
+                  </constraint>
+                  <completionHelp>
+                    <list>local radius</list>
+                  </completionHelp>
+                </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="secret">
+                    <properties>
+                      <help>Key for accessing the specified server</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="req-limit">
+                    <properties>
+                      <help>Maximum number of simultaneous requests to server (default: unlimited)</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="fail-time">
+                    <properties>
+                      <help>If server does not responds mark it as unavailable for this amount of time in seconds</help>
+                    </properties>
+                  </leafNode>
+                </children>
+              </tagNode>
+              <node name="radius-settings">
+                <properties>
+                  <help>RADIUS settings</help>
+                </properties>
+                <children>
+                  <leafNode name="timeout">
+                    <properties>
+                      <help>Timeout to wait response from server (seconds)</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="acct-timeout">
+                    <properties>
+                      <help>Timeout to wait reply for Interim-Update packets. (default 3 seconds)</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="max-try">
+                    <properties>
+                      <help>Maximum number of tries to send Access-Request/Accounting-Request queries</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="nas-identifier">
+                    <properties>
+                      <help>Value to send to RADIUS server in NAS-Identifier attribute and to be matched in DM/CoA requests.</help>
+                    </properties>
+                  </leafNode>
+                  <leafNode name="nas-ip-address">
+                    <properties>
+                      <help>Value to send to RADIUS server in NAS-IP-Address attribute and to be matched in DM/CoA requests. Also DM/CoA server will bind to that address.</help>
+                    </properties>
+                  </leafNode>
+                  <node name="dae-server">
+                    <properties>
+                      <help>IPv4 address and port to bind Dynamic Authorization Extension server (DM/CoA)</help>
+                    </properties>
+                    <children>
+                      <leafNode name="ip-address">
+                        <properties>
+                          <help>IP address for Dynamic Authorization Extension server (DM/CoA)</help>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="port">
+                        <properties>
+                          <help>Port for Dynamic Authorization Extension server (DM/CoA)</help>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="secret">
+                        <properties>
+                          <help>Secret for Dynamic Authorization Extension server (DM/CoA)</help>
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </node>
+                  <node name="rate-limit">
+                    <properties>
+                      <help>Upload/Download speed limits</help>
+                    </properties>
+                    <children>
+                      <leafNode name="attribute">
+                        <properties>
+                          <help>Specifies which radius attribute contains rate information. (default is Filter-Id)</help>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="vendor">
+                        <properties>
+                          <help>Specifies the vendor dictionary. (dictionary needs to be in /usr/share/accel-ppp/radius)</help>
+                        </properties>
+                      </leafNode>
+                      <leafNode name="enable">
+                        <properties>
+                          <help>Enables Bandwidth shaping via RADIUS</help>
+                          <valueless />
+                        </properties>
+                      </leafNode>
+                    </children>
+                  </node>
+                </children>
+              </node>
+            </children>
+          </node>
+          <node name="client-ip-pool">
+            <properties>
+              <help>Pool of client IP addresses (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>
+              <leafNode name="subnet">
+                <properties>
+                  <help>Client IP subnet (CIDR notation)</help>
+                  <constraint>
+                    <validator name="ipv4-prefix"/>
+                  </constraint>
+                  <constraintErrorMessage>Not a valid CIDR formatted prefix</constraintErrorMessage>
+                  <multi />
+                </properties>
+              </leafNode>
+            </children>
+          </node>
+          <node name="client-ipv6-pool">
+            <properties>
+              <help>Pool of client IPv6 addresses</help>
+            </properties>
+            <children>
+              <leafNode name="prefix">
+                <properties>
+                  <help>Format: ipv6prefix/mask,prefix_len (e.g.: fc00:0:1::/48,64 - divides prefix into /64 subnets for clients)</help>
+                  <multi />
+                </properties>
+              </leafNode>
+              <leafNode name="delegate-prefix">
+                <properties>
+                  <help>Format: ipv6prefix/mask,prefix_len (delegate to clients through DHCPv6 prefix delegation - rfc3633)</help>
+                  <multi />
+                </properties>
+              </leafNode>
+            </children>
+          </node>
+          <node name="dns-servers">
+            <properties>
+              <help>IPv4 Domain Name Service (DNS) server</help>
+            </properties>
+            <children>
+            <leafNode name="server-1">
+              <properties>
+                <help>Primary DNS server</help>
+                <valueHelp>
+                  <format>ipv4</format>
+                  <description>IPv4 address</description>
+                </valueHelp>
+                <constraint>
+                  <validator name="ipv4-address"/>
+                </constraint>
+              </properties>
+            </leafNode>
+            <leafNode name="server-2">
+              <properties>
+                <help>Secondary DNS server</help>
+                <valueHelp>
+                  <format>ipv4</format>
+                  <description>IPv4 address</description>
+                </valueHelp>
+                <constraint>
+                  <validator name="ipv4-address"/>
+                </constraint>
+              </properties>
+            </leafNode>
+            </children>
+          </node>
+           <node name="dnsv6-servers">
+            <properties>
+              <help>IPv6 Domain Name Service (DNS) server</help>
+            </properties>
+            <children>
+              <leafNode name="server-1">
+                <properties>
+                  <valueHelp>
+                    <format>ipv6</format>
+                    <description>IPv6 address</description>
+                  </valueHelp>
+                  <help>Primary DNS server</help>
+                  <constraint>
+                    <validator name="ipv6-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="server-2">
+                <properties>
+                  <valueHelp>
+                    <format>ipv6</format>
+                    <description>IPv6 address</description>
+                  </valueHelp>
+                  <help>Secondary DNS server</help>
+                  <constraint>
+                    <validator name="ipv6-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="server-3">
+                <properties>
+                  <valueHelp>
+                    <format>ipv6</format>
+                  <description>IPv6 address</description>
+                  </valueHelp>
+                  <help>Tertiary DNS server</help>
+                  <constraint>
+                    <validator name="ipv6-address"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+            </children>
+          </node>
+
+          <tagNode name="interface">
+            <properties>
+              <help>interface(s) to listen on</help>
+              <completionHelp>
+                <script>${vyos_completion_dir}/list_interfaces.py</script>
+              </completionHelp>
+            </properties>
+            <children>
+              <leafNode name="vlan-id">
+                <properties>
+                  <help>VLAN monitor for the automatic creation of vlans (user per vlan)</help>
+                  <constraint>
+                        <validator name="numeric" argument="--range 1-4096"/>
+                      </constraint>
+                      <constraintErrorMessage>VLAN ID needs to be between 1 and 4096</constraintErrorMessage>
+                      <multi />
+                </properties>
+              </leafNode>
+              <leafNode name="vlan-range">
+                <properties>
+                  <help>VLAN monitor for the automatic creation of vlans (user per vlan)</help>
+                  <constraint>
+                    <regex>(409[0-6]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{0,2})-(409[0-6]|40[0-8][0-9]|[1-3][0-9]{3}|[1-9][0-9]{0,2})</regex>
+                  </constraint>
+                  <multi />
+                </properties>
+              </leafNode>
+            </children>
+          </tagNode>
+          <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 1492</help>
+              <constraint>
+              <validator name="numeric" argument="--range 128-16384"/>
+              </constraint>
+            </properties>
+          </leafNode>
+          <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>servicename can contain aplhanumerical characters and dashes only (max. 100)</constraintErrorMessage>
+              <multi/>
+            </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>
+          <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>
+              <node name="mppe">
+                <properties>
+                  <help>Specifies MPPE negotiation preference. (default prefer mppe)</help>
+                </properties>
+                <children>
+                  <leafNode name="require">
+                    <properties>
+                      <help>Ask client for MPPE, if it rejects then drop the connection</help>
+                      <valueless />
+                    </properties>
+                  </leafNode>
+                  <leafNode name="prefer">
+                    <properties>
+                      <help>Ask client for MPPE, if it rejects do not fail</help>
+                      <valueless />
+                    </properties>
+                  </leafNode>
+                  <leafNode name="deny">
+                    <properties>
+                      <help>Deny MPPE</help>
+                      <valueless />
+                    </properties>
+                  </leafNode>
+                </children>
+              </node>
+              <leafNode name="lcp-echo-interval">
+                <properties>
+                  <help>LCP echo-requests/sec</help>
+                  <constraint>
+                    <validator name="numeric" argument="--positive"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="lcp-echo-failure">
+                <properties>
+                  <help>Maximum number of Echo-Requests may be sent without valid reply</help>
+                  <constraint>
+                    <validator name="numeric" argument="--positive"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <leafNode name="lcp-echo-timeout">
+                <properties>
+                  <help>Timeout in seconds to wait for any peer activity. If this option specified it turns on adaptive lcp echo functionality and "lcp-echo-failure" is not used.</help>
+                  <constraint>
+                    <validator name="numeric" argument="--positive"/>
+                  </constraint>
+                </properties>
+              </leafNode>
+              <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>
+              <leafNode name="ipv6">
+                <properties>
+                  <help>IPv6 (IPCP6) negotiation algorithm</help>
+                  <constraint>
+                    <regex>(deny|allow|prefer|require)</regex>
+                  </constraint>
+                  <constraintErrorMessage>invalid value</constraintErrorMessage>
+                  <valueHelp>
+                    <format>deny</format>
+                    <description>Do not negotiate IPv6</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>allow</format>
+                    <description>Negotiate IPv6 only if client requests</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>prefer</format>
+                    <description>Ask client for IPv6 negotiation, do not fail if it rejects</description>
+                  </valueHelp>
+                  <valueHelp>
+                    <format>require</format>
+                    <description>Require IPv6 negotiation</description>
+                  </valueHelp>
+                  <completionHelp>
+                    <list>deny allow prefer require</list>
+                  </completionHelp>
+                </properties>
+              </leafNode>
+              <leafNode name="ipv6-intf-id">
+                <properties>
+                  <help>Fixed or random interface identifier for IPv6</help>
+                  <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>
+                  <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>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>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>
+        </children>
+      </node>
+    </children>
+  </node>
+</interfaceDefinition>