summaryrefslogtreecommitdiff
path: root/interface-definitions/interfaces-pppoe.xml.in
blob: 3747a2a7e8e1447351369604488938237fae7d72 (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
<?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)</help>
          <priority>321</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>
          <leafNode name="access-concentrator">
            <properties>
              <help>Access concentrator name (only connect to this concentrator)</help>
              <constraint>
                <regex>[a-zA-Z0-9]+$</regex>
              </constraint>
              <constraintErrorMessage>Access concentrator name must be composed of uppper and lower case letters or numbers only</constraintErrorMessage>
            </properties>
          </leafNode>
          <node name="authentication">
            <properties>
              <help>Authentication settings</help>
            </properties>
            <children>
              <leafNode name="user">
                <properties>
                  <help>User name</help>
                </properties>
              </leafNode>
              <leafNode name="password">
                <properties>
                  <help>Password</help>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="connect-on-demand">
            <properties>
              <help>Automatic establishment of PPPOE connection when traffic is sent</help>
              <valueless/>
            </properties>
          </leafNode>
          <leafNode name="default-route">
            <properties>
              <help>Default route insertion behaviour (default: auto)</help>
              <completionHelp>
                <list>auto none force</list>
              </completionHelp>
              <constraint>
                <regex>(auto|none|force)</regex>
              </constraint>
              <constraintErrorMessage>PPPoE default-route option must be 'auto', 'none', or 'force'</constraintErrorMessage>
              <valueHelp>
                <format>auto</format>
                <description>Automatically install a default route</description>
              </valueHelp>
              <valueHelp>
                <format>none</format>
                <description>Do not install a default route</description>
              </valueHelp>
              <valueHelp>
                <format>force</format>
                <description>Replace existing default route</description>
              </valueHelp>
            </properties>
          </leafNode>
          #include <include/dhcpv6-options.xml.i>
          #include <include/interface-description.xml.i>
          #include <include/interface-disable.xml.i>
          #include <include/interface-vrf.xml.i>
          <leafNode name="idle-timeout">
            <properties>
              <help>Delay before disconnecting idle session (in seconds)</help>
              <valueHelp>
                <format>n</format>
                <description>Idle timeout in seconds</description>
              </valueHelp>
            </properties>
          </leafNode>
          <node name="ipv6">
            <children>
              <node name="address">
                <properties>
                  <help>IPv6 address configuration modes</help>
                </properties>
                <children>
                  <leafNode name="autoconf">
                    <properties>
                      <help>Enable Stateless Address Autoconfiguration (SLAAC)</help>
                      <valueless/>
                    </properties>
                  </leafNode>
                </children>
              </node>
              <leafNode name="enable">
                <properties>
                  <help>Activate IPv6 support on this connection</help>
                  <valueless/>
                </properties>
              </leafNode>
            </children>
          </node>
          <leafNode name="source-interface">
            <properties>
              <help>Physical Interface used for this PPPoE session</help>
              <completionHelp>
                <script>${vyos_completion_dir}/list_interfaces.py --broadcast</script>
              </completionHelp>
            </properties>
          </leafNode>
          <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-mtu-68-1500.xml.i>
          <leafNode name="no-peer-dns">
            <properties>
              <help>Do not use DNS servers provided by the peer</help>
              <valueless/>
            </properties>
          </leafNode>
          <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 composed of uppper and lower case letters or numbers only</constraintErrorMessage>
            </properties>
          </leafNode>
        </children>
      </tagNode>
    </children>
  </node>
</interfaceDefinition>