diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/_include/interface-common-with-dhcp.txt | 10 | ||||
| -rw-r--r-- | docs/_include/interface-dhcpv6-options.txt | 92 | ||||
| -rw-r--r-- | docs/interfaces/ethernet.rst | 37 | 
3 files changed, 101 insertions, 38 deletions
| diff --git a/docs/_include/interface-common-with-dhcp.txt b/docs/_include/interface-common-with-dhcp.txt index 585951b3..1fe38a92 100644 --- a/docs/_include/interface-common-with-dhcp.txt +++ b/docs/_include/interface-common-with-dhcp.txt @@ -2,10 +2,18 @@     :var0: {{ var0 }}     :var1: {{ var1 }} +.. cmdinclude:: ../_include/interface-common.txt +   :var0: {{ var0 }} +   :var1: {{ var1 }} + +**DHCP** +  .. cmdinclude:: ../_include/interface-dhcp-options.txt     :var0: {{ var0 }}     :var1: {{ var1 }} -.. cmdinclude:: ../_include/interface-common.txt +**DHCPv6** + +.. cmdinclude:: ../_include/interface-dhcpv6-options.txt     :var0: {{ var0 }}     :var1: {{ var1 }} diff --git a/docs/_include/interface-dhcpv6-options.txt b/docs/_include/interface-dhcpv6-options.txt new file mode 100644 index 00000000..7213079a --- /dev/null +++ b/docs/_include/interface-dhcpv6-options.txt @@ -0,0 +1,92 @@ +.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcpv6-options parameters-only + +  This statement specifies dhcp6c to only exchange informational configuration +  parameters with servers. A list of DNS server addresses is an example of such +  parameters. This statement is useful when the client does not need stateful +  configuration parameters such as IPv6 addresses or prefixes. + +  Example: + +  .. code-block:: none + +    set interfaces {{ var0 }} {{ var1 }} dhcpv6-options parameters-only + +.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcpv6-options rapid-commit + +  When rapid-commit is specified, dhcp6c will include a rapid-commit option in +  solicit messages and wait for an immediate reply instead of advertisements. + +  Example: + +  .. code-block:: none + +    set interfaces {{ var0 }} {{ var1 }} dhcpv6-options rapid-commit + +.. cfgcmd:: set interfaces {{ var0 }} <interface> dhcpv6-options temporary + +  Request only a temporary address and not form an IA_NA (Identity Association +  for Non-temporary Addresses) partnership. + +  Example + +  .. code-block:: none + +    set interfaces {{ var0 }} {{ var1 }} dhcpv6-options temporary + + + + +**DHCPv6-PD** + +VyOS 1.3 (equuleus) supports DHCPv6-PD (:rfc:`3633`). DHCPv6 Prefix Delegation +is supported by most ISPs who provide native IPv6 for consumers on fixed networks. + +.. cfgcmd:: set interfaces {{ var0 }} <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 a +   /32 prefix (if your ISP allows this) down to a /64 delegation. + +   The default value corresponds to 64. + +  Example: + +  To request a /56 prefix from your ISP use: + +  .. code-block:: none + +    set interfaces {{ var0 }} {{ var1 }} dhcpv6-options pd 0 length 56 + +.. cfgcmd:: set interfaces {{ var0 }} <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: Delegate a /64 prefix to interface eth0.10 which will use a local +   address on this router of ``<prefix>::ffff``, as the address 65534 will +   correspond to ``ffff`` in hexadecimal notation. + +  .. code-block:: none + +    set interfaces {{ var0 }} {{ var1 }} dhcpv6-option pd 0 interface eth0.10 address 65534 + +.. cfgcmd:: set interfaces {{ var0 }} <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). + +   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. + +  .. code-block:: none + +    set interfaces {{ var0 }} {{ var1 }} dhcpv6-option pd 0 interface eth0.10 sla-id 1 + diff --git a/docs/interfaces/ethernet.rst b/docs/interfaces/ethernet.rst index 09c72ec8..cdf3622c 100644 --- a/docs/interfaces/ethernet.rst +++ b/docs/interfaces/ethernet.rst @@ -73,43 +73,6 @@ 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  ========= | 
