summaryrefslogtreecommitdiff
path: root/docs/interfaces
diff options
context:
space:
mode:
authorChristian Poessinger <christian@poessinger.com>2020-11-05 13:12:49 +0100
committerChristian Poessinger <christian@poessinger.com>2020-11-05 13:12:49 +0100
commit7e35e645268e95e592d47e0450aa07eb8395eb84 (patch)
tree837eab6d1f903956419d09a4562156c5758a8102 /docs/interfaces
parent3c236e5ed4376494a2f372afe1e6f546bccb60b9 (diff)
downloadvyos-documentation-7e35e645268e95e592d47e0450aa07eb8395eb84.tar.gz
vyos-documentation-7e35e645268e95e592d47e0450aa07eb8395eb84.zip
interfaces: add IPv6 DHCPv6-PD documentation for PPPoE and Ethernet
Diffstat (limited to 'docs/interfaces')
-rw-r--r--docs/interfaces/ethernet.rst38
-rw-r--r--docs/interfaces/pppoe.rst28
2 files changed, 52 insertions, 14 deletions
diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst
index 0633ad2c..95aef851 100644
--- a/docs/interfaces/ethernet.rst
+++ b/docs/interfaces/ethernet.rst
@@ -95,6 +95,44 @@ Link Administration
Configure :abbr:`MTU (Maximum Transmission Unit)` on given `<interface>`. It
is the size (in bytes) of the largest ethernet frame sent on this link.
+Prefix Delegation (DHCPv6-PD)
+-----------------------------
+
+VyOS 1.3 (equuleus) supports DHCPv6-PD. DHCPv6 Prefix Delegation is supported
+by most ISPs who provide native IPv6 for consumers on fixed networks.
+
+.. cfgcmd:: set interfaces ethernet <interface> dhcpv6-option pd <id> length <length>
+
+ Some ISPs by default only delegate a /64 prefix. To request for a specific
+ prefix size use this option to request for a bigger delegation for this pd
+ `<id>`. This value
+ is in the range from 32 - 64 so you could request up to /32 down to a /64
+ delegation.
+
+ Default value is 64.
+
+.. cfgcmd:: set interfaces ethernet <interface> dhcpv6-option pd <id> interface <delegatee> address <address>
+
+ Specify the interface address used locally on the interfcae where the prefix
+ has been delegated to. ID must be a decimal integer.
+
+ It will be combined with the delegated prefix and the sla-id to form a complete
+ interface address. The default is to use the EUI-64 address of the interface.
+
+ Example:
+
+ Using ``<id>`` value 65535 will assign IPv6 address ``<prefix>::ffff`` to the
+ interface.
+
+.. cfgcmd:: set interfaces ethernet <interface> dhcpv6-option pd <id> interface <delegatee> sla-id <id>
+
+ Specify the identifier value of the site-level aggregator (SLA) on the
+ interface. ID must be a decimal number greater then 0 which fits in the length
+ of SLA IDs (see below). For example, if ID is 1 and the client is delegated
+ an IPv6 prefix 2001:db8:ffff::/48, dhcp6c will combine the two values into a
+ single IPv6 prefix, 2001:db8:ffff:1::/64, and will configure the prefix on
+ the specified interface.
+
Operation
=========
diff --git a/docs/interfaces/pppoe.rst b/docs/interfaces/pppoe.rst
index 75fe0a40..8fa35492 100644
--- a/docs/interfaces/pppoe.rst
+++ b/docs/interfaces/pppoe.rst
@@ -183,27 +183,27 @@ by most ISPs who provide native IPv6 for consumers on fixed networks.
Default value is 64.
-.. cfgcmd:: set interfaces pppoe <interface> dhcpv6-option pd <id> interface <prefix-interface> address <local-addr>
+.. cfgcmd:: set interfaces pppoe <interface> dhcpv6-option pd <id> interface <delegatee> address <address>
- This statement specifies the interface address used locally on the interfcae
- where the prefix has been delegated to. ID must be a decimal integer.
- It will be combined with the delegated prefix and the sla-id to form a
- complete interface address. The default is to use the EUI-64 address of the
- interface.
+ Specify the interface address used locally on the interfcae where the prefix
+ has been delegated to. ID must be a decimal integer.
+
+ It will be combined with the delegated prefix and the sla-id to form a complete
+ interface address. The default is to use the EUI-64 address of the interface.
Example:
- Using `<id>` value 65535 will assign IPv6 address <prefix>::ffff to the
+ Using ``<id>`` value 65535 will assign IPv6 address ``<prefix>::ffff`` to the
interface.
-.. cfgcmd:: set interfaces pppoe <interface> dhcpv6-option pd <id> interface <prefix-interface> sla-id <id>
+.. cfgcmd:: set interfaces pppoe <interface> dhcpv6-option pd <id> interface <delegatee> sla-id <id>
- This statement specifies the identifier value of the site-level aggregator
- (SLA) on the interface. ID must be a decimal number greater then 0 which
- fits in the length of SLA IDs (see below). For example, if ID is 1 and the
- client is delegated an IPv6 prefix 2001:db8:ffff::/48, dhcp6c will combine
- the two values into a single IPv6 prefix, 2001:db8:ffff:1::/64, and will
- configure the prefix on the specified interface.
+ Specify the identifier value of the site-level aggregator (SLA) on the
+ interface. ID must be a decimal number greater then 0 which fits in the length
+ of SLA IDs (see below). For example, if ID is 1 and the client is delegated
+ an IPv6 prefix 2001:db8:ffff::/48, dhcp6c will combine the two values into a
+ single IPv6 prefix, 2001:db8:ffff:1::/64, and will configure the prefix on
+ the specified interface.
Operation
=========