<?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>
          <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>
            <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/accel-ppp/name-server.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>
              <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>
          #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>servicename 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>
              <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>
                  <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>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>
          <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>