summaryrefslogtreecommitdiff
path: root/docs/services
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-01-23 07:02:35 +0100
committerChristian Poessinger <christian@poessinger.com>2020-01-23 07:02:35 +0100
commit6bf3368b751a0aad2f6120d92fd427a642687c52 (patch)
tree0b6e31a944764c0c4548f86406f4399c404a3035 /docs/services
parentc00dae8d72f575f83aa7076fe53d02520238ab43 (diff)
downloadvyos-documentation-6bf3368b751a0aad2f6120d92fd427a642687c52.tar.gz
vyos-documentation-6bf3368b751a0aad2f6120d92fd427a642687c52.zip
ipoe: use 80 character line break
Diffstat (limited to 'docs/services')
-rw-r--r--docs/services/ipoe-server.rst57
1 files changed, 38 insertions, 19 deletions
diff --git a/docs/services/ipoe-server.rst b/docs/services/ipoe-server.rst
index 69682217..eda1762a 100644
--- a/docs/services/ipoe-server.rst
+++ b/docs/services/ipoe-server.rst
@@ -4,8 +4,19 @@
IPoE Server
###########
-VyOS utilizes `accel-ppp`_ to provide IPoE server functionality. It can be
-used with local authentication (mac-address) or a connected RADIUS server.
+VyOS utilizes `accel-ppp`_ to provide :abbr:`IPoE (Internet Protocol over
+Ethernet)` server functionality. It can be used with local authentication
+(mac-address) or a connected RADIUS server.
+
+IPoE is a method of delivering an IP payload over an Ethernet-based access
+network or an access network using bridged Ethernet over Asynchronous Transfer
+Mode (ATM) without using PPPoE. It directly encapsulates the IP datagrams in
+Ethernet frames, using the standard :rfc:`894` encapsulation.
+
+The use of IPoE addresses the disadvantage that PPP is unsuited for multicast
+delivery to multiple users. Typically, IPoE uses Dynamic Host Configuration
+Protocol and Extensible Authentication Protocol to provide the same
+functionality as PPPoE, but in a less robust manner.
.. note:: Please be aware, due to an upstream bug, config changes/commits
will restart the ppp daemon and will reset existing IPoE sessions,
@@ -14,11 +25,15 @@ used with local authentication (mac-address) or a connected RADIUS server.
Configuration
=============
-IPoE can be configure on different interfaces, it will depend on each specific situation which interface will provide IPoE to clients.
-The clients mac address and the incoming interface is being used as control parameter, to authenticate a client.
+IPoE can be configure on different interfaces, it will depend on each specific
+situation which interface will provide IPoE to clients. The clients mac address
+and the incoming interface is being used as control parameter, to authenticate
+a client.
-The example configuration below will assign an IP to the client on the incoming interface eth2 with the client mac address 08:00:27:2f:d8:06.
-Other DHCP discovery requests will be ignored, unless the client mac has been enabled in the configuration.
+The example configuration below will assign an IP to the client on the incoming
+interface eth2 with the client mac address 08:00:27:2f:d8:06. Other DHCP
+discovery requests will be ignored, unless the client mac has been enabled in
+the configuration.
.. code-block:: none
@@ -29,8 +44,9 @@ Other DHCP discovery requests will be ignored, unless the client mac has been en
set service ipoe-server interface eth2 client-subnet '192.168.0.0/24'
-The first address of the parameter ``client-subnet``, will be used as the default gateway.
-Connected sessions can be checked via the ``show ipoe-server sessions`` command.
+The first address of the parameter ``client-subnet``, will be used as the
+default gateway. Connected sessions can be checked via the ``show ipoe-server
+sessions`` command.
.. code-block:: none
@@ -44,8 +60,9 @@ Connected sessions can be checked via the ``show ipoe-server sessions`` command.
IPv6 SLAAC and IA-PD
--------------------
-To configure IPv6 assignments for clients, two options need to be configured. A global prefix which is terminated on the clients cpe and a delegated prefix, the client can use
-for devices routed via the clients cpe.
+To configure IPv6 assignments for clients, two options need to be configured.
+A global prefix which is terminated on the clients cpe and a delegated prefix,
+the client can use for devices routed via the clients cpe.
IPv6 DNS addresses are optional.
@@ -68,14 +85,17 @@ IPv6 DNS addresses are optional.
ipoe0 | eth3 | 08:00:27:2f:d8:06 | 192.168.1.2 | 2001:db8::a00:27ff:fe2f:d806/64 | 2001:db8:1::/56 | | active | 01:02:59 | 4626faf71b12cc25
-The clients cpe can now communicate via IPv4 or IPv6. All devices behind ``2001:db8::a00:27ff:fe2f:d806/64`` can use addresses from ``2001:db8:1::/56`` and can
-globally communicate without the need of any NAT rules.
-
+The clients :abbr:`CPE (Customer Premises Equipment)` can now communicate via
+IPv4 or IPv6. All devices behind ``2001:db8::a00:27ff:fe2f:d806/64`` can use
+addresses from ``2001:db8:1::/56`` and can globally communicate without the
+need of any NAT rules.
Automatic VLAN creation
-----------------------
-To create VLANs per user during runtime, the following settings are required on a per interface basis. VLAN ID and VLAN range can be present in the configuration at the same time.
+To create VLANs per user during runtime, the following settings are required on
+a per interface basis. VLAN ID and VLAN range can be present in the
+configuration at the same time.
.. code-block:: none
@@ -85,23 +105,22 @@ To create VLANs per user during runtime, the following settings are required on
set service ipoe-server interface eth2 vlan-range 1000-2000
set service ipoe-server interface eth2 vlan-range 2500-2700
-
RADIUS Setup
------------
-To use a RADIUS server for authentication and bandwidth-shaping, the following example configuration can be used.
+To use a RADIUS server for authentication and bandwidth-shaping, the following
+example configuration can be used.
.. code-block:: none
set service ipoe-server authentication mode 'radius'
set service ipoe-server authentication radius-server 10.100.100.1 secret 'password'
-
Bandwidth Shaping
^^^^^^^^^^^^^^^^^
-Bandwidth rate limits can be set for local users within the configuration or via RADIUS based attributes.
-
+Bandwidth rate limits can be set for local users within the configuration or
+via RADIUS based attributes.
Bandwidth Shaping for local users
=================================