From 4652e58cefa9b0ee3ba3d40eac076ebc4b6b6953 Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Wed, 20 Dec 2017 16:05:51 -0500 Subject: [PATCH] doc: fixup ipv6.rst Manual cleanup from leftover texi -> rst Signed-off-by: Quentin Young --- doc/user/ipv6.rst | 338 +++++++++++++++++++++------------------------- 1 file changed, 151 insertions(+), 187 deletions(-) diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst index 5c002467b7..0b1088e5d7 100644 --- a/doc/user/ipv6.rst +++ b/doc/user/ipv6.rst @@ -7,7 +7,7 @@ IPv6 Support Frr fully supports IPv6 routing. As described so far, Frr supports RIPng, OSPFv3, and BGP-4+. You can give IPv6 addresses to an interface and configure static IPv6 routing information. Frr IPv6 also provides -automatic address configuration via a feature called `address auto configuration`. To do it, the router must send router advertisement +automatic address configuration via a feature called ``address auto configuration``. To do it, the router must send router advertisement messages to the all nodes that exist on the network. Previous versions of Frr could be built without IPv6 support. This is @@ -16,214 +16,178 @@ no longer possible. Router Advertisement ==================== -.. index:: {Interface Command} {no ipv6 nd suppress-ra} {} +.. index:: no ipv6 nd suppress-ra -{Interface Command} {no ipv6 nd suppress-ra} {} - Send router advertisment messages. +``no ipv6 nd suppress-ra`` + Send router advertisment messages. -.. index:: {Interface Command} {ipv6 nd suppress-ra} {} +.. index:: ipv6 nd suppress-ra -{Interface Command} {ipv6 nd suppress-ra} {} - Don't send router advertisment messages. +``ipv6 nd suppress-ra`` + Don't send router advertisment messages. -.. index:: {Interface Command} {ipv6 nd prefix `ipv6prefix` [`valid-lifetime`] [`preferred-lifetime`] [off-link] [no-autoconfig] [router-address]} {} +.. index:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address] -{Interface Command} {ipv6 nd prefix `ipv6prefix` [`valid-lifetime`] [`preferred-lifetime`] [off-link] [no-autoconfig] [router-address]} {} - Configuring the IPv6 prefix to include in router advertisements. Several prefix - specific optional parameters and flags may follow: +``ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address]`` + Configuring the IPv6 prefix to include in router advertisements. Several prefix + specific optional parameters and flags may follow: + - ``valid-lifetime``: the length of time in seconds during what the prefix is + valid for the purpose of on-link determination. Value ``infinite`` represents + infinity (i.e. a value of all one bits (``0xffffffff``)). + Range: ``<0-4294967295>`` Default: ``2592000`` -`` - `valid-lifetime` - the length of time in seconds during what the prefix is - valid for the purpose of on-link determination. Value `infinite` represents - infinity (i.e. a value of all one bits (`0xffffffff`)). + - ``preferred-lifetime``: the length of time in seconds during what addresses + generated from the prefix remain preferred. Value ``infinite`` represents + infinity. + Range: ``<0-4294967295>`` Default: ``604800`` - Range: `<0-4294967295>` Default: `2592000` + - ``off-link``: indicates that advertisement makes no statement about on-link or + off-link properties of the prefix. + Default: not set, i.e. this prefix can be used for on-link determination. + - ``no-autoconfig``: indicates to hosts on the local link that the specified prefix + cannot be used for IPv6 autoconfiguration. -`` - `preferred-lifetime` - the length of time in seconds during what addresses - generated from the prefix remain preferred. Value `infinite` represents - infinity. + Default: not set, i.e. prefix can be used for autoconfiguration. - Range: `<0-4294967295>` Default: `604800` + - ``router-address``: indicates to hosts on the local link that the specified + prefix contains a complete IP address by setting R flag. + Default: not set, i.e. hosts do not assume a complete IP address is placed. -`` - `off-link` - indicates that advertisement makes no statement about on-link or - off-link properties of the prefix. +.. index:: + single: no ipv6 nd ra-interval [<1-1800>] + single: no ipv6 nd ra-interval [<1-1800>] - Default: not set, i.e. this prefix can be used for on-link determination. +``[no] ipv6 nd ra-interval [<1-1800>]`` + The maximum time allowed between sending unsolicited multicast router + advertisements from the interface, in seconds. + Default: ``600`` +.. index:: ipv6 nd ra-interval msec <70-1800000> -`` - `no-autoconfig` - indicates to hosts on the local link that the specified prefix - cannot be used for IPv6 autoconfiguration. - Default: not set, i.e. prefix can be used for autoconfiguration. +.. index:: + single: no ipv6 nd ra-interval [msec <70-1800000>] + single: ipv6 nd ra-interval msec <70-1800000> +``[no] ipv6 nd ra-interval [msec <70-1800000>]`` + The maximum time allowed between sending unsolicited multicast router + advertisements from the interface, in milliseconds. + Default: ``600000`` -`` - `router-address` - indicates to hosts on the local link that the specified - prefix - contains a complete IP address by setting R flag. +.. index:: + single: ipv6 nd ra-lifetime <0-9000> + single: no ipv6 nd ra-lifetime [<0-9000>] - Default: not set, i.e. hosts do not assume a complete IP address is placed. - -.. index:: {Interface Command} {ipv6 nd ra-interval <1-1800>} {} - -{Interface Command} {ipv6 nd ra-interval <1-1800>} {} -.. index:: {Interface Command} {no ipv6 nd ra-interval [<1-1800>]} {} - -{Interface Command} {no ipv6 nd ra-interval [<1-1800>]} {} - The maximum time allowed between sending unsolicited multicast router - advertisements from the interface, in seconds. - - Default: `600` - -.. index:: {Interface Command} {ipv6 nd ra-interval msec <70-1800000>} {} - -{Interface Command} {ipv6 nd ra-interval msec <70-1800000>} {} -.. index:: {Interface Command} {no ipv6 nd ra-interval [msec <70-1800000>]} {} - -{Interface Command} {no ipv6 nd ra-interval [msec <70-1800000>]} {} - The maximum time allowed between sending unsolicited multicast router - advertisements from the interface, in milliseconds. - - Default: `600000` - -.. index:: {Interface Command} {ipv6 nd ra-lifetime <0-9000>} {} - -{Interface Command} {ipv6 nd ra-lifetime <0-9000>} {} -.. index:: {Interface Command} {no ipv6 nd ra-lifetime [<0-9000>]} {} - -{Interface Command} {no ipv6 nd ra-lifetime [<0-9000>]} {} +``[no] ipv6 nd ra-lifetime [<0-9000>]`` The value to be placed in the Router Lifetime field of router advertisements sent from the interface, in seconds. Indicates the usefulness of the router as a default router on this interface. Setting the value to zero indicates that the router should not be considered a default router on this interface. - Must be either zero or between value specified with `ipv6 nd ra-interval` + Must be either zero or between value specified with ``ipv6 nd ra-interval`` (or default) and 9000 seconds. - - Default: `1800` - -.. index:: {Interface Command} {ipv6 nd reachable-time <1-3600000>} {} - -{Interface Command} {ipv6 nd reachable-time <1-3600000>} {} -.. index:: {Interface Command} {no ipv6 nd reachable-time [<1-3600000>]} {} - -{Interface Command} {no ipv6 nd reachable-time [<1-3600000>]} {} - The value to be placed in the Reachable Time field in the Router Advertisement - messages sent by the router, in milliseconds. The configured time enables the - router to detect unavailable neighbors. The value zero means unspecified (by - this router). - - Default: `0` - -.. index:: {Interface Command} {ipv6 nd managed-config-flag} {} - -{Interface Command} {ipv6 nd managed-config-flag} {} -.. index:: {Interface Command} {no ipv6 nd managed-config-flag} {} - -{Interface Command} {no ipv6 nd managed-config-flag} {} - Set/unset flag in IPv6 router advertisements which indicates to hosts that they - should use managed (stateful) protocol for addresses autoconfiguration in - addition to any addresses autoconfigured using stateless address - autoconfiguration. - - Default: not set - -.. index:: {Interface Command} {ipv6 nd other-config-flag} {} - -{Interface Command} {ipv6 nd other-config-flag} {} -.. index:: {Interface Command} {no ipv6 nd other-config-flag} {} - -{Interface Command} {no ipv6 nd other-config-flag} {} - Set/unset flag in IPv6 router advertisements which indicates to hosts that - they should use administered (stateful) protocol to obtain autoconfiguration - information other than addresses. - - Default: not set - -.. index:: {Interface Command} {ipv6 nd home-agent-config-flag} {} - -{Interface Command} {ipv6 nd home-agent-config-flag} {} -.. index:: {Interface Command} {no ipv6 nd home-agent-config-flag} {} - -{Interface Command} {no ipv6 nd home-agent-config-flag} {} - Set/unset flag in IPv6 router advertisements which indicates to hosts that - the router acts as a Home Agent and includes a Home Agent Option. - - Default: not set - -.. index:: {Interface Command} {ipv6 nd home-agent-preference <0-65535>} {} - -{Interface Command} {ipv6 nd home-agent-preference <0-65535>} {} -.. index:: {Interface Command} {no ipv6 nd home-agent-preference [<0-65535>]} {} - -{Interface Command} {no ipv6 nd home-agent-preference [<0-65535>]} {} - The value to be placed in Home Agent Option, when Home Agent config flag is set, - which indicates to hosts Home Agent preference. The default value of 0 stands - for the lowest preference possible. - - Default: 0 - -.. index:: {Interface Command} {ipv6 nd home-agent-lifetime <0-65520>} {} - -{Interface Command} {ipv6 nd home-agent-lifetime <0-65520>} {} -.. index:: {Interface Command} {no ipv6 nd home-agent-lifetime [<0-65520>]} {} - -{Interface Command} {no ipv6 nd home-agent-lifetime [<0-65520>]} {} - The value to be placed in Home Agent Option, when Home Agent config flag is set, - which indicates to hosts Home Agent Lifetime. The default value of 0 means to - place the current Router Lifetime value. - - Default: 0 - -.. index:: {Interface Command} {ipv6 nd adv-interval-option} {} - -{Interface Command} {ipv6 nd adv-interval-option} {} -.. index:: {Interface Command} {no ipv6 nd adv-interval-option} {} - -{Interface Command} {no ipv6 nd adv-interval-option} {} - Include an Advertisement Interval option which indicates to hosts the maximum time, - in milliseconds, between successive unsolicited Router Advertisements. - - Default: not set - -.. index:: {Interface Command} {ipv6 nd router-preference (high|medium|low)} {} - -{Interface Command} {ipv6 nd router-preference (high|medium|low)} {} -.. index:: {Interface Command} {no ipv6 nd router-preference [(high|medium|low)]} {} - -{Interface Command} {no ipv6 nd router-preference [(high|medium|low)]} {} - Set default router preference in IPv6 router advertisements per RFC4191. - - Default: medium - -.. index:: {Interface Command} {ipv6 nd mtu <1-65535>} {} - -{Interface Command} {ipv6 nd mtu <1-65535>} {} -.. index:: {Interface Command} {no ipv6 nd mtu [<1-65535>]} {} - -{Interface Command} {no ipv6 nd mtu [<1-65535>]} {} - Include an MTU (type 5) option in each RA packet to assist the attached hosts - in proper interface configuration. The announced value is not verified to be - consistent with router interface MTU. - - Default: don't advertise any MTU option - -:: - - @group - interface eth0 - no ipv6 nd suppress-ra - ipv6 nd prefix 2001:0DB8:5009::/64 - @end group - - - For more information see @cite{RFC2462 (IPv6 Stateless Address Autoconfiguration)} - , @cite{RFC4861 (Neighbor Discovery for IP Version 6 (IPv6))} - , @cite{RFC6275 (Mobility Support in IPv6)} - and @cite{RFC4191 (Default Router Preferences and More-Specific Routes)}. - + Default: ``1800`` + +.. index:: + single: no ipv6 nd reachable-time [<1-3600000>] + single: ipv6 nd reachable-time <1-3600000> + +``[no] ipv6 nd reachable-time [<1-3600000>]`` + The value to be placed in the Reachable Time field in the Router Advertisement + messages sent by the router, in milliseconds. The configured time enables the + router to detect unavailable neighbors. The value zero means unspecified (by + this router). + Default: ``0`` + +.. index:: + single: ipv6 nd managed-config-flag + single: no ipv6 nd managed-config-flag + +``[no] ipv6 nd managed-config-flag`` + Set/unset flag in IPv6 router advertisements which indicates to hosts that they + should use managed (stateful) protocol for addresses autoconfiguration in + addition to any addresses autoconfigured using stateless address + autoconfiguration. + Default: not set + +.. index:: + single: ipv6 nd other-config-flag + single: no ipv6 nd other-config-flag + +``[no] ipv6 nd other-config-flag`` + Set/unset flag in IPv6 router advertisements which indicates to hosts that + they should use administered (stateful) protocol to obtain autoconfiguration + information other than addresses. + Default: not set + +.. index:: + single: ipv6 nd home-agent-config-flag + single: no ipv6 nd home-agent-config-flag + +``[no] ipv6 nd home-agent-config-flag`` + Set/unset flag in IPv6 router advertisements which indicates to hosts that + the router acts as a Home Agent and includes a Home Agent Option. + Default: not set + +.. index:: ipv6 nd home-agent-preference <0-65535> + +.. index:: + single: no ipv6 nd home-agent-preference [<0-65535>] + single: ipv6 nd home-agent-preference <0-65535> + +``[no] ipv6 nd home-agent-preference [<0-65535>]`` + The value to be placed in Home Agent Option, when Home Agent config flag is set, + which indicates to hosts Home Agent preference. The default value of 0 stands + for the lowest preference possible. + Default: ``0`` + +.. index:: + single: ipv6 nd home-agent-lifetime <0-65520> + single: no ipv6 nd home-agent-lifetime <0-65520> + +``[no] ipv6 nd home-agent-lifetime [<0-65520>]`` + The value to be placed in Home Agent Option, when Home Agent config flag is set, + which indicates to hosts Home Agent Lifetime. The default value of 0 means to + place the current Router Lifetime value. + + Default: ``0`` + +.. index:: + single: ipv6 nd adv-interval-option + single: no ipv6 nd adv-interval-option + +``[no] ipv6 nd adv-interval-option`` + Include an Advertisement Interval option which indicates to hosts the maximum time, + in milliseconds, between successive unsolicited Router Advertisements. + Default: not set + +.. index:: + single: ipv6 nd router-preference (high|medium|low) + single: no ipv6 nd router-preference (high|medium|low) + +``[no] ipv6 nd router-preference [(high|medium|low)]`` + Set default router preference in IPv6 router advertisements per RFC4191. + Default: medium + +.. index:: + single: ipv6 nd mtu <1-65535> + single: no ipv6 nd mtu [<1-65535>] + +``[no] ipv6 nd mtu [<1-65535>]`` + Include an MTU (type 5) option in each RA packet to assist the attached hosts + in proper interface configuration. The announced value is not verified to be + consistent with router interface MTU. + + Default: don't advertise any MTU option.:: + interface eth0 + no ipv6 nd suppress-ra + ipv6 nd prefix 2001:0DB8:5009::/64 + + +For more information see +:t:`RFC2462 (IPv6 Stateless Address Autoconfiguration)`, +:t:`RFC4861 (Neighbor Discovery for IP Version 6 (IPv6))`, +:t:`RFC6275 (Mobility Support in IPv6)` and +:t:`RFC4191 (Default Router Preferences and More-Specific Routes)`. -- 2.39.5