summaryrefslogtreecommitdiff
path: root/docs/configuration
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2022-09-17 08:50:06 +0200
committerChristian Poessinger <christian@poessinger.com>2022-09-17 08:50:06 +0200
commit392a14de5740812b0299be536c756e5d4d86da35 (patch)
treeb61f70929bdfd8df7a135eff60a8b5de6c7ed328 /docs/configuration
parent122ecb23fc35806b48836772423581cf66a2ee59 (diff)
downloadvyos-documentation-392a14de5740812b0299be536c756e5d4d86da35.tar.gz
vyos-documentation-392a14de5740812b0299be536c756e5d4d86da35.zip
pppoe-server: T4703: combine vlan-id and vlan-range into single CLI
Diffstat (limited to 'docs/configuration')
-rw-r--r--docs/configuration/service/pppoe-server.rst37
1 files changed, 19 insertions, 18 deletions
diff --git a/docs/configuration/service/pppoe-server.rst b/docs/configuration/service/pppoe-server.rst
index ad99cec0..69e357f3 100644
--- a/docs/configuration/service/pppoe-server.rst
+++ b/docs/configuration/service/pppoe-server.rst
@@ -1,3 +1,5 @@
+:lastproofread: 2022-09-17
+
.. _pppoe-server:
############
@@ -106,10 +108,10 @@ and then configure it.
.. cfgcmd:: set service pppoe-server authentication radius server <address>
key <secret>
-
+
Use this command to configure the IP address and the shared secret
key of your RADIUS server. You can have multiple RADIUS servers
- configured if you wish to achieve redundancy.
+ configured if you wish to achieve redundancy.
.. code-block:: none
@@ -169,25 +171,24 @@ CoA request.
Automatic VLAN Creation
-----------------------
-.. cfgcmd:: set service pppoe-server interface <interface>
- <vlan-id | vlan range> <text>
+.. cfgcmd:: set service pppoe-server interface <interface> vlan <id | range>
- VLAN's can be created by accel-ppp on the fly via the use of a Kernel
- module named `vlan_mon`, which is monitoring incoming vlans and
- creates the necessary VLAN if required and allowed. VyOS supports the
- use of either VLAN ID's or entire ranges, both values can be defined
- at the same time for an interface. When configured, the PPPoE will
- create the necessary VLANs when required. Once the user session has
- been cancelled and the VLAN is not needed anymore, VyOS will remove
- it again.
+ VLAN's can be created by Accel-ppp on the fly via the use of a Kernel module
+ named `vlan_mon`, which is monitoring incoming vlans and creates the
+ necessary VLAN if required and allowed. VyOS supports the use of either
+ VLAN ID's or entire ranges, both values can be defined at the same time for
+ an interface.
-.. code-block:: none
+ When configured, PPPoE will create the necessary VLANs when required. Once
+ the user session has been cancelled and the VLAN is not needed anymore, VyOS
+ will remove it again.
- set service pppoe-server interface eth3 vlan-id 100
- set service pppoe-server interface eth3 vlan-id 200
- set service pppoe-server interface eth3 vlan-range 500-1000
- set service pppoe-server interface eth3 vlan-range 2000-3000
+.. code-block:: none
+ set service pppoe-server interface eth3 vlan 100
+ set service pppoe-server interface eth3 vlan 200
+ set service pppoe-server interface eth3 vlan 500-1000
+ set service pppoe-server interface eth3 vlan 2000-3000
Bandwidth Shaping
@@ -201,7 +202,7 @@ For Local Users
.. cfgcmd:: set service pppoe-server authentication local-users username <name>
rate-limit <download | upload>
-
+
Use this command to configure a data-rate limit to PPPOoE clients for
traffic download or upload. The rate-limit is set in kbit/sec.