summaryrefslogtreecommitdiff
path: root/doc/user/ipv6.rst
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@cumulusnetworks.com>2018-01-29 16:38:07 -0500
committerQuentin Young <qlyoung@cumulusnetworks.com>2018-01-29 16:38:07 -0500
commitc1a54c054d434b9e50467db30665cfb688e16a2e (patch)
tree6734f37671fe5f7dfed4b68afb21d0f2d6a66514 /doc/user/ipv6.rst
parentd1a242fdbf983c4902fe41bcd827f4ff9bd4deb7 (diff)
doc: manually finish conversion
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'doc/user/ipv6.rst')
-rw-r--r--doc/user/ipv6.rst192
1 files changed, 96 insertions, 96 deletions
diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst
index d6b7d972ad..3780a6311f 100644
--- a/doc/user/ipv6.rst
+++ b/doc/user/ipv6.rst
@@ -4,11 +4,12 @@
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
-messages to the all nodes that exist on the network.
+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 messages to the all nodes that exist
+on the network.
Previous versions of FRR could be built without IPv6 support. This is
no longer possible.
@@ -17,177 +18,176 @@ Router Advertisement
====================
.. index:: no ipv6 nd suppress-ra
-
.. clicmd:: no ipv6 nd suppress-ra
+
Send router advertisment messages.
.. index:: ipv6 nd suppress-ra
-
.. clicmd:: ipv6 nd suppress-ra
+
Don't send router advertisment messages.
.. index:: ipv6 nd prefix ipv6prefix [valid-lifetime] [preferred-lifetime] [off-link] [no-autoconfig] [router-address]
-
.. clicmd:: 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``
+ Configuring the IPv6 prefix to include in router advertisements. Several prefix
+ specific optional parameters and flags may follow:
- - ``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``
+ - ``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``
- - ``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.
+ - ``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``
- - ``no-autoconfig``: indicates to hosts on the local link that the specified prefix
- cannot be used for IPv6 autoconfiguration.
+ - ``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.
- Default: not set, i.e. prefix can be used for autoconfiguration.
+ - ``no-autoconfig``: indicates to hosts on the local link that the specified prefix
+ cannot be used for IPv6 autoconfiguration.
- - ``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. prefix can be used for autoconfiguration.
- Default: not set, i.e. hosts do not assume a complete IP address is placed.
+ - ``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.
.. index::
single: no ipv6 nd ra-interval [(1-1800)]
single: no ipv6 nd ra-interval [(1-1800)]
-
.. clicmd:: [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)
+ 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)
.. index::
single: no ipv6 nd ra-interval [msec (70-1800000)]
single: ipv6 nd ra-interval msec (70-1800000)
-
.. clicmd:: [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``
+
+ The maximum time allowed between sending unsolicited multicast router
+ advertisements from the interface, in milliseconds.
+ Default: ``600000``
.. index::
single: ipv6 nd ra-lifetime (0-9000)
single: no ipv6 nd ra-lifetime [(0-9000)]
-
.. clicmd:: [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``
- (or default) and 9000 seconds.
- Default: ``1800``
+
+ 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``
+ (or default) and 9000 seconds.
+ Default: ``1800``
.. index::
single: no ipv6 nd reachable-time [(1-3600000)]
single: ipv6 nd reachable-time (1-3600000)
-
.. clicmd:: [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``
+
+ 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
-
.. clicmd:: [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
+
+ 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
-
.. clicmd:: [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
+
+ 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
-
.. clicmd:: [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
+
+ 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)
-
.. clicmd:: [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``
+
+ 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)
-
.. clicmd:: [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``
+ 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
-
.. clicmd:: [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
+
+ 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)
-
.. clicmd:: [no] ipv6 nd router-preference [(high|medium|low)]
- Set default router preference in IPv6 router advertisements per RFC4191.
- Default: medium
+
+ 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)]
-
.. clicmd:: [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
+ 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
+
+.. seealso::
-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)`.
+ - :rfc:`2462` (IPv6 Stateless Address Autoconfiguration)
+ - :rfc:`4861` (Neighbor Discovery for IP Version 6 (IPv6))
+ - :rfc:`6275` (Mobility Support in IPv6)
+ - :rfc:`4191` (Default Router Preferences and More-Specific Routes)