Fixing IPoE and PPPoE documentation

Fixing IPoE and PPPoE documentation
This commit is contained in:
aapostoliuk 2024-02-28 15:59:51 +02:00
parent a8d2dedab2
commit 7f9b031aef
2 changed files with 15 additions and 19 deletions

View File

@ -52,7 +52,7 @@ the configuration.
.. cfgcmd:: set service ipoe-server authentication interface <interface> mac <MAC> .. 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) password=**<MAC>** (mac-address)
.. cfgcmd:: set service ipoe-server authentication mode <local | radius> .. 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> .. 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 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 it must be within a /24 subnet. If notation ``x.x.x.x/x`` is
used there is possibility to set host/netmask. 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`_. it via RADIUS CoA. ``Accel-VRF-Name`` is used from these purposes. It is custom `ACCEL-PPP attribute`_.
Define it in your RADIUS server. 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 IPv6
**** ****
@ -267,16 +258,16 @@ IPv6
.. cfgcmd:: set service ipoe-server client-ipv6-pool <IPv6-POOL-NAME> prefix <address> .. cfgcmd:: set service ipoe-server client-ipv6-pool <IPv6-POOL-NAME> prefix <address>
mask <number-of-bits> 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 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. bit long, the default value is 64.
.. cfgcmd:: set service ipoe-server client-ipv6-pool <IPv6-POOL-NAME> delegate <address> .. cfgcmd:: set service ipoe-server client-ipv6-pool <IPv6-POOL-NAME> delegate <address>
delegation-prefix <number-of-bits> delegation-prefix <number-of-bits>
Use this command to configure DHCPv6 Prefix Delegation (RFC3633) on 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 delegation prefix. From the defined IPv6 pool you will be handing out
networks of the defined length (delegation-prefix). The length of the networks of the defined length (delegation-prefix). The length of the
delegation prefix can be set from 32 to 64 bit long. delegation prefix can be set from 32 to 64 bit long.
@ -398,6 +389,11 @@ Global Advanced options
Monitoring Monitoring
********** **********
.. opcmd:: show ipoe-server sessions
Use this command to locally check the active sessions in the IPoE
server.
.. code-block:: none .. code-block:: none
vyos@vyos:~$ show ipoe-server sessions vyos@vyos:~$ show ipoe-server sessions

View File

@ -352,16 +352,16 @@ IPv6
.. cfgcmd:: set service pppoe-server client-ipv6-pool <IPv6-POOL-NAME> prefix <address> .. cfgcmd:: set service pppoe-server client-ipv6-pool <IPv6-POOL-NAME> prefix <address>
mask <number-of-bits> 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 PPPoE client
will get an IPv6 prefix of your defined length (mask) to terminate the 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 PPPoE endpoint at their side. The mask length can be set from 48 to 128
bit long, the default value is 64. bit long, the default value is 64.
.. cfgcmd:: set service pppoe-server client-ipv6-pool <IPv6-POOL-NAME> delegate <address> .. cfgcmd:: set service pppoe-server client-ipv6-pool <IPv6-POOL-NAME> delegate <address>
delegation-prefix <number-of-bits> delegation-prefix <number-of-bits>
Use this command to configure DHCPv6 Prefix Delegation (RFC3633) on Use this command to configure DHCPv6 Prefix Delegation (RFC3633) on
l2tp. You will have to set your IPv6 pool and the length of the PPPoE. 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 delegation prefix. From the defined IPv6 pool you will be handing out
networks of the defined length (delegation-prefix). The length of the networks of the defined length (delegation-prefix). The length of the
delegation prefix can be set from 32 to 64 bit long. delegation prefix can be set from 32 to 64 bit long.
@ -624,7 +624,7 @@ address from the pool 10.1.1.100-111, terminates at the local endpoint
Dual-Stack IPv4/IPv6 provisioning with Prefix Delegation Dual-Stack IPv4/IPv6 provisioning with Prefix Delegation
======================================================== ========================================================
The example below covers a dual-stack configuration via pppoe-server. The example below covers a dual-stack configuration.
.. code-block:: none .. code-block:: none
@ -642,7 +642,7 @@ The example below covers a dual-stack configuration via pppoe-server.
set service pppoe-server gateway-address '10.100.100.1' set service pppoe-server gateway-address '10.100.100.1'
The client, once successfully authenticated, will receive an IPv4 and an The client, once successfully authenticated, will receive an IPv4 and an
IPv6 /64 address to terminate the pppoe endpoint on the client side and IPv6 /64 address to terminate the PPPoE endpoint on the client side and
a /56 subnet for the clients internal use. a /56 subnet for the clients internal use.
.. code-block:: none .. code-block:: none