diff options
| author | aapostoliuk <a.apostoliuk@vyos.io> | 2024-02-28 15:59:51 +0200 |
|---|---|---|
| committer | Mergify <37929162+mergify[bot]@users.noreply.github.com> | 2024-02-28 21:28:26 +0000 |
| commit | e4d66ef8e3099d4c910597812998c44611ad11c9 (patch) | |
| tree | 70c92db41e3bae9d6f2682d109f7c004e34b8bdd /docs/configuration/service/ipoe-server.rst | |
| parent | 73ac88e21572586aefacc1655c920d9c489e6d74 (diff) | |
| download | vyos-documentation-e4d66ef8e3099d4c910597812998c44611ad11c9.tar.gz vyos-documentation-e4d66ef8e3099d4c910597812998c44611ad11c9.zip | |
Fixing IPoE and PPPoE documentation
Fixing IPoE and PPPoE documentation
(cherry picked from commit 7f9b031aeffeeb48201c7d51df71fc58191b4138)
Diffstat (limited to 'docs/configuration/service/ipoe-server.rst')
| -rw-r--r-- | docs/configuration/service/ipoe-server.rst | 24 |
1 files changed, 10 insertions, 14 deletions
diff --git a/docs/configuration/service/ipoe-server.rst b/docs/configuration/service/ipoe-server.rst index 5608c27c..64048552 100644 --- a/docs/configuration/service/ipoe-server.rst +++ b/docs/configuration/service/ipoe-server.rst @@ -52,7 +52,7 @@ the configuration. .. cfgcmd:: set service ipoe-server authentication interface <interface> mac <MAC> - Creates local pppoe user with username=**<interface>** and + Creates local IPoE user with username=**<interface>** and password=**<MAC>** (mac-address) .. cfgcmd:: set service ipoe-server authentication mode <local | radius> @@ -68,7 +68,7 @@ the configuration. .. cfgcmd:: set service ipoe-server client-ip-pool <POOL-NAME> range <x.x.x.x-x.x.x.x | x.x.x.x/x> Use this command to define the first IP address of a pool of - addresses to be given to l2tp clients. If notation ``x.x.x.x-x.x.x.x``, + addresses to be given to IPoE clients. If notation ``x.x.x.x-x.x.x.x``, it must be within a /24 subnet. If notation ``x.x.x.x/x`` is used there is possibility to set host/netmask. @@ -251,15 +251,6 @@ User interface can be put to VRF context via RADIUS Access-Accept packet, or cha it via RADIUS CoA. ``Accel-VRF-Name`` is used from these purposes. It is custom `ACCEL-PPP attribute`_. Define it in your RADIUS server. -Renaming clients interfaces by RADIUS -===================================== - -If the RADIUS server uses the attribute ``NAS-Port-Id``, ppp tunnels will be -renamed. - -.. note:: The value of the attribute ``NAS-Port-Id`` must be less than 16 - characters, otherwise the interface won't be renamed. - **** IPv6 **** @@ -267,16 +258,16 @@ IPv6 .. cfgcmd:: set service ipoe-server client-ipv6-pool <IPv6-POOL-NAME> prefix <address> mask <number-of-bits> - Use this comand to set the IPv6 address pool from which an l2tp client + Use this comand to set the IPv6 address pool from which an IPoE client will get an IPv6 prefix of your defined length (mask) to terminate the - l2tp endpoint at their side. The mask length can be set from 48 to 128 + IPoE endpoint at their side. The mask length can be set from 48 to 128 bit long, the default value is 64. .. cfgcmd:: set service ipoe-server client-ipv6-pool <IPv6-POOL-NAME> delegate <address> delegation-prefix <number-of-bits> Use this command to configure DHCPv6 Prefix Delegation (RFC3633) on - l2tp. You will have to set your IPv6 pool and the length of the + IPoE. You will have to set your IPv6 pool and the length of the delegation prefix. From the defined IPv6 pool you will be handing out networks of the defined length (delegation-prefix). The length of the delegation prefix can be set from 32 to 64 bit long. @@ -398,6 +389,11 @@ Global Advanced options Monitoring ********** +.. opcmd:: show ipoe-server sessions + + Use this command to locally check the active sessions in the IPoE + server. + .. code-block:: none vyos@vyos:~$ show ipoe-server sessions |