summaryrefslogtreecommitdiff
path: root/interface-definitions/interfaces-pppoe.xml.in
blob: b78f92c856cd98deb77844abf2865caf3222558e (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
<?xml version="1.0"?>
<interfaceDefinition>
  <node name="interfaces">
    <children>
      <tagNode name="pppoe" owner="${vyos_conf_scripts_dir}/interfaces-pppoe.py">
        <properties>
          <help>Point-to-Point Protocol over Ethernet (PPPoE) Interface</help>
          <priority>322</priority>
          <constraint>
            <regex>pppoe[0-9]+</regex>
          </constraint>
          <constraintErrorMessage>PPPoE interface must be named pppoeN</constraintErrorMessage>
          <valueHelp>
            <format>pppoeN</format>
            <description>PPPoE dialer interface name</description>
          </valueHelp>
        </properties>
        <children>
          #include <include/pppoe-access-concentrator.xml.i>
          #include <include/interface/authentication.xml.i>
          #include <include/interface/dial-on-demand.xml.i>
          #include <include/interface/no-default-route.xml.i>
          #include <include/interface/default-route-distance.xml.i>
          #include <include/interface/dhcpv6-options.xml.i>
          #include <include/generic-description.xml.i>
          #include <include/interface/disable.xml.i>
          <leafNode name="idle-timeout">
            <properties>
              <help>Delay before disconnecting idle session (in seconds)</help>
              <valueHelp>
                <format>u32:0-86400</format>
                <description>Idle timeout in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 0-86400"/>
              </constraint>
              <constraintErrorMessage>Timeout must be in range 0 to 86400</constraintErrorMessage>
            </properties>
          </leafNode>
          <leafNode name="host-uniq">
            <properties>
              <help>PPPoE RFC2516 host-uniq tag</help>
              <valueHelp>
                <format>txt</format>
                <description>Host-uniq tag as byte string in HEX</description>
              </valueHelp>
              <constraint>
                <regex>([a-fA-F0-9][a-fA-F0-9]){1,18}</regex>
              </constraint>
              <constraintErrorMessage>Host-uniq must be specified as hex-adecimal byte-string (even number of HEX characters)</constraintErrorMessage>
            </properties>
          </leafNode>
          <leafNode name="holdoff">
            <properties>
              <help>Delay before re-dial to the access concentrator when PPP session terminated by peer (in seconds)</help>
              <valueHelp>
                <format>u32:0-86400</format>
                <description>Holdoff time in seconds</description>
              </valueHelp>
              <constraint>
                <validator name="numeric" argument="--range 0-86400"/>
              </constraint>
              <constraintErrorMessage>Holdoff must be in range 0 to 86400</constraintErrorMessage>
            </properties>
            <defaultValue>30</defaultValue>
          </leafNode>
          <node name="ip">
            <properties>
              <help>IPv4 routing parameters</help>
            </properties>
            <children>
              #include <include/interface/adjust-mss.xml.i>
              #include <include/interface/disable-forwarding.xml.i>
              #include <include/interface/source-validation.xml.i>
            </children>
          </node>
          <node name="ipv6">
            <properties>
              <help>IPv6 routing parameters</help>
            </properties>
            <children>
              <node name="address">
                <properties>
                  <help>IPv6 address configuration modes</help>
                </properties>
                <children>
                  #include <include/interface/ipv6-address-autoconf.xml.i>
                </children>
              </node>
              #include <include/interface/adjust-mss.xml.i>
              #include <include/interface/disable-forwarding.xml.i>
            </children>
          </node>
          #include <include/source-interface.xml.i>
          <leafNode name="local-address">
            <properties>
              <help>IPv4 address of local end of the PPPoE link</help>
              <valueHelp>
                <format>ipv4</format>
                <description>Address of local end of the PPPoE link</description>
              </valueHelp>
              <constraint>
                <validator name="ipv4-address"/>
              </constraint>
            </properties>
          </leafNode>
          #include <include/interface/mirror.xml.i>
          #include <include/interface/mtu-68-1500.xml.i>
          <leafNode name="mtu">
            <defaultValue>1492</defaultValue>
          </leafNode>
          #include <include/interface/no-peer-dns.xml.i>
          <leafNode name="remote-address">
            <properties>
              <help>IPv4 address of remote end of the PPPoE link</help>
              <valueHelp>
                <format>ipv4</format>
                <description>Address of remote end of the PPPoE link</description>
              </valueHelp>
              <constraint>
                <validator name="ipv4-address"/>
              </constraint>
            </properties>
          </leafNode>
          <leafNode name="service-name">
            <properties>
              <help>Service name, only connect to access concentrators advertising this</help>
              <constraint>
                <regex>[a-zA-Z0-9]+</regex>
              </constraint>
              <constraintErrorMessage>Service name must be alphanumeric only</constraintErrorMessage>
            </properties>
          </leafNode>
          #include <include/interface/redirect.xml.i>
          #include <include/interface/vrf.xml.i>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>