summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorChristian Breunig <christian@breunig.cc>2023-02-10 20:44:51 +0100
committerChristian Breunig <christian@breunig.cc>2023-02-10 20:45:40 +0100
commit5148845f92c81b65def1f5d3131355cdfbe266ae (patch)
tree82f2788dbd94787cfb130a64edf4709033e7f0f3 /docs
parenta51949687e37de3b2f573788f8d20490b40d6c6a (diff)
downloadvyos-documentation-5148845f92c81b65def1f5d3131355cdfbe266ae.tar.gz
vyos-documentation-5148845f92c81b65def1f5d3131355cdfbe266ae.zip
T4995: pppoe, wwan and sstp-client - rename user -> username on authentication
Diffstat (limited to 'docs')
-rw-r--r--docs/configuration/interfaces/pppoe.rst8
-rw-r--r--docs/configuration/interfaces/wwan.rst1
-rw-r--r--docs/configuration/service/ipoe-server.rst45
3 files changed, 49 insertions, 5 deletions
diff --git a/docs/configuration/interfaces/pppoe.rst b/docs/configuration/interfaces/pppoe.rst
index 0953e948..cf406baf 100644
--- a/docs/configuration/interfaces/pppoe.rst
+++ b/docs/configuration/interfaces/pppoe.rst
@@ -91,7 +91,7 @@ PPPoE options
This command allows you to select a specific access concentrator when you
know the access concentrators `<name>`.
-.. cfgcmd:: set interfaces pppoe <interface> authentication user <username>
+.. cfgcmd:: set interfaces pppoe <interface> authentication username <username>
Use this command to set the username for authenticating with a remote PPPoE
endpoint. Authentication is optional from the system's point of view but
@@ -324,7 +324,7 @@ Requirements:
.. code-block:: none
- set interfaces pppoe pppoe0 authentication user 'userid'
+ set interfaces pppoe pppoe0 authentication username 'userid'
set interfaces pppoe pppoe0 authentication password 'secret'
set interfaces pppoe pppoe0 source-interface 'eth0'
@@ -349,7 +349,7 @@ which is the default VLAN for Deutsche Telekom:
.. code-block:: none
- set interfaces pppoe pppoe0 authentication user 'userid'
+ set interfaces pppoe pppoe0 authentication username 'userid'
set interfaces pppoe pppoe0 authentication password 'secret'
set interfaces pppoe pppoe0 source-interface 'eth0.7'
@@ -367,7 +367,7 @@ If you do not know the prefix size delegated to you, start with sla-len 0.
.. code-block:: none
- set interfaces pppoe pppoe0 authentication user vyos
+ set interfaces pppoe pppoe0 authentication username vyos
set interfaces pppoe pppoe0 authentication password vyos
set interfaces pppoe pppoe0 dhcpv6-options pd 0 interface eth0 address '1'
set interfaces pppoe pppoe0 dhcpv6-options pd 0 interface eth0 sla-id '0'
diff --git a/docs/configuration/interfaces/wwan.rst b/docs/configuration/interfaces/wwan.rst
index 45b18387..98890158 100644
--- a/docs/configuration/interfaces/wwan.rst
+++ b/docs/configuration/interfaces/wwan.rst
@@ -22,7 +22,6 @@ Common interface configuration
:var0: wwan
:var1: wwan0
-
.. cmdinclude:: /_include/interface-description.txt
:var0: wwan
:var1: wwan0
diff --git a/docs/configuration/service/ipoe-server.rst b/docs/configuration/service/ipoe-server.rst
index e42ab42e..c219a063 100644
--- a/docs/configuration/service/ipoe-server.rst
+++ b/docs/configuration/service/ipoe-server.rst
@@ -146,4 +146,49 @@ The rate-limit is set in kbit/sec.
-------+------------+-------------------+-------------+-----+--------+------------+--------+----------+------------------
ipoe0 | eth2 | 08:00:27:2f:d8:06 | 192.168.0.2 | | | 500/500 | active | 00:00:05 | dccc870fd31349fb
+Example
+=======
+
+* IPoE server will listen on interfaces eth1.50 and eth1.51
+* There are rate-limited and non rate-limited users (MACs)
+
+Server configuration
+--------------------
+
+.. code-block:: none
+
+ set interfaces dummy dum1000 address 100.64.0.1/32
+ set interfaces dummy dum1000 address 2001:db8::1/128
+
+ set interfaces ethernet eth1 description 'IPoE'
+ set interfaces ethernet eth1 vif 50
+ set interfaces ethernet eth1 vif 51
+
+ set service ipoe-server authentication interface eth1.50 mac 00:0c:29:b7:49:a7
+ set service ipoe-server authentication interface eth1.50 mac 00:0c:29:f0:be:4c rate-limit download '5000'
+ set service ipoe-server authentication interface eth1.50 mac 00:0c:29:f0:be:4c rate-limit upload '5000'
+ set service ipoe-server authentication interface eth1.51 mac 00:0c:29:b7:49:a7 rate-limit download '50000'
+ set service ipoe-server authentication interface eth1.51 mac 00:0c:29:b7:49:a7 rate-limit upload '50000'
+ set service ipoe-server authentication mode 'local'
+
+ set service ipoe-server client-ipv6-pool delegate 2001:db8:ffff::/48 delegation-prefix '56'
+ set service ipoe-server client-ipv6-pool prefix 2001:db8:fffe::/48 mask '64'
+ set service ipoe-server interface eth1.50 client-subnet '100.64.50.0/24'
+ set service ipoe-server interface eth1.50 mode 'l2'
+ set service ipoe-server interface eth1.51 client-subnet '100.64.51.0/24'
+ set service ipoe-server interface eth1.51 mode 'l2'
+ set service ipoe-server name-server '100.64.0.1'
+ set service ipoe-server name-server '2001:db8::1'
+
+Client configuration
+--------------------
+
+.. code-block:: none
+
+ set interfaces ethernet eth0 mac '00:0c:29:b7:49:a7'
+
+ set interfaces ethernet eth0 vif 50 address 'dhcp'
+ set interfaces ethernet eth0 vif 50 address 'dhcpv6'
+ set interfaces ethernet eth0 vif 50 dhcpv6-options pd 0 interface eth1 sla-id '1'
+
.. include:: /_include/common-references.txt