summaryrefslogtreecommitdiff
path: root/docs/configuration/interfaces/pppoe.rst
diff options
context:
space:
mode:
Diffstat (limited to 'docs/configuration/interfaces/pppoe.rst')
-rw-r--r--docs/configuration/interfaces/pppoe.rst32
1 files changed, 14 insertions, 18 deletions
diff --git a/docs/configuration/interfaces/pppoe.rst b/docs/configuration/interfaces/pppoe.rst
index e1bb3056..0953e948 100644
--- a/docs/configuration/interfaces/pppoe.rst
+++ b/docs/configuration/interfaces/pppoe.rst
@@ -1,4 +1,4 @@
-:lastproofread: 2021-07-09
+:lastproofread: 2022-07-27
.. _pppoe-interface:
@@ -69,6 +69,10 @@ Common interface configuration
:var0: pppoe
:var1: pppoe0
+.. cmdinclude:: /_include/interface-mtu.txt
+ :var0: pppoe
+ :var1: pppoe0
+
.. cmdinclude:: /_include/interface-vrf.txt
:var0: pppoe
:var1: pppoe0
@@ -126,6 +130,9 @@ PPPoE options
set interfaces pppoe pppoe0 no-default-route
+ .. note:: This command got added in VyOS 1.4 and inverts the logic from the old
+ ``default-route`` CLI option.
+
.. cfgcmd:: set interfaces pppoe <interface> default-route-distance <distance>
Set the distance for the default gateway sent by the PPPoE server.
@@ -152,11 +159,6 @@ PPPoE options
Use this command to set the IP address of the local endpoint of a PPPoE
session. If it is not set it will be negotiated.
-.. cfgcmd:: set interfaces pppoe <interface> mtu <mtu>
-
- Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It
- is the size (in bytes) of the largest ethernet frame sent on this link.
-
.. cfgcmd:: set interfaces pppoe <interface> no-peer-dns
Use this command to not install advertised DNS nameservers into the local
@@ -310,11 +312,6 @@ Requirements:
If you are switching from a DHCP based ISP like cable then be aware that
things like VPN links may need to have their MTU sizes adjusted to work
within this limit.
-* With the ``default-route`` option set to ``auto``, VyOS will only add the
- default gateway you receive from your DSL ISP to the routing table if you
- have no other WAN connections. If you wish to use a dual WAN connection,
- change the ``default-route`` option to ``force``. You could also install
- a static route and set the ``default-route`` option to ``none``.
* With the ``name-server`` option set to ``none``, VyOS will ignore the
nameservers your ISP sends you and thus you can fully rely on the ones you
have configured statically.
@@ -322,10 +319,11 @@ Requirements:
.. note:: Syntax has changed from VyOS 1.2 (crux) and it will be automatically
migrated during an upgrade.
+.. note:: A default route is automatically installed once the interface is up.
+ To change this behavior use the ``no-default-route`` CLI option.
+
.. code-block:: none
- set interfaces pppoe pppoe0 default-route 'auto'
- set interfaces pppoe pppoe0 mtu 1492
set interfaces pppoe pppoe0 authentication user 'userid'
set interfaces pppoe pppoe0 authentication password 'secret'
set interfaces pppoe pppoe0 source-interface 'eth0'
@@ -336,9 +334,9 @@ assigning it to the pppoe0 itself as shown here:
.. code-block:: none
- set interfaces pppoe pppoe0 firewall in name NET-IN
- set interfaces pppoe pppoe0 firewall local name NET-LOCAL
- set interfaces pppoe pppoe0 firewall out name NET-OUT
+ set firewall interface pppoe0 in name NET-IN
+ set firewall interface pppoe0 local name NET-LOCAL
+ set firewall interface pppoe0 out name NET-OUT
VLAN Example
============
@@ -351,8 +349,6 @@ which is the default VLAN for Deutsche Telekom:
.. code-block:: none
- set interfaces pppoe pppoe0 default-route 'auto'
- set interfaces pppoe pppoe0 mtu 1492
set interfaces pppoe pppoe0 authentication user 'userid'
set interfaces pppoe pppoe0 authentication password 'secret'
set interfaces pppoe pppoe0 source-interface 'eth0.7'