summaryrefslogtreecommitdiffstats
path: root/doc/user/ipv6.rst
diff options
context:
space:
mode:
authorQuentin Young <qlyoung@cumulusnetworks.com>2018-01-26 21:52:30 +0100
committerQuentin Young <qlyoung@cumulusnetworks.com>2018-01-26 22:15:43 +0100
commit29adcd50089793e31e9ed182a0b370763827ed27 (patch)
tree937d76472d11bd6cb40afbc3e7a954062edb829b /doc/user/ipv6.rst
parentdoc: add clicmd role for frr cli (diff)
downloadfrr-29adcd50089793e31e9ed182a0b370763827ed27.tar.xz
frr-29adcd50089793e31e9ed182a0b370763827ed27.zip
doc: fix cli documentation formatting
* Use new 'clicmd' directive / role * Convert old style range syntax to new style Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
Diffstat (limited to 'doc/user/ipv6.rst')
-rw-r--r--doc/user/ipv6.rst66
1 files changed, 33 insertions, 33 deletions
diff --git a/doc/user/ipv6.rst b/doc/user/ipv6.rst
index 9a842ee59..d6b7d972a 100644
--- a/doc/user/ipv6.rst
+++ b/doc/user/ipv6.rst
@@ -18,29 +18,29 @@ Router Advertisement
.. index:: no ipv6 nd suppress-ra
-``no ipv6 nd suppress-ra``
+.. clicmd:: no ipv6 nd suppress-ra
Send router advertisment messages.
.. index:: ipv6 nd suppress-ra
-``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]
-``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``
+ Range: ``(0-4294967295)`` Default: ``2592000``
- ``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: ``604800``
- ``off-link``: indicates that advertisement makes no statement about on-link or
off-link properties of the prefix.
@@ -57,31 +57,31 @@ Router Advertisement
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>]
+ single: no ipv6 nd ra-interval [(1-1800)]
+ single: no ipv6 nd ra-interval [(1-1800)]
-``[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>
+.. 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>
+ 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>]``
+.. 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``
.. index::
- single: ipv6 nd ra-lifetime <0-9000>
- single: no ipv6 nd ra-lifetime [<0-9000>]
+ single: ipv6 nd ra-lifetime (0-9000)
+ single: no ipv6 nd ra-lifetime [(0-9000)]
-``[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
@@ -91,10 +91,10 @@ Router Advertisement
Default: ``1800``
.. index::
- single: no ipv6 nd reachable-time [<1-3600000>]
- single: ipv6 nd reachable-time <1-3600000>
+ single: no ipv6 nd reachable-time [(1-3600000)]
+ single: ipv6 nd reachable-time (1-3600000)
-``[no] 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
@@ -105,7 +105,7 @@ Router Advertisement
single: ipv6 nd managed-config-flag
single: no ipv6 nd managed-config-flag
-``[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
@@ -116,7 +116,7 @@ Router Advertisement
single: ipv6 nd other-config-flag
single: no ipv6 nd other-config-flag
-``[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.
@@ -126,28 +126,28 @@ Router Advertisement
single: ipv6 nd home-agent-config-flag
single: no ipv6 nd home-agent-config-flag
-``[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
-.. index:: ipv6 nd home-agent-preference <0-65535>
+.. 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>
+ 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>]``
+.. 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``
.. index::
- single: ipv6 nd home-agent-lifetime <0-65520>
- single: no ipv6 nd home-agent-lifetime <0-65520>
+ 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>]``
+.. 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.
@@ -158,7 +158,7 @@ Router Advertisement
single: ipv6 nd adv-interval-option
single: no ipv6 nd adv-interval-option
-``[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
@@ -167,15 +167,15 @@ Router Advertisement
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)]``
+.. clicmd:: [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>]
+ single: ipv6 nd mtu (1-65535)
+ single: no ipv6 nd mtu [(1-65535)]
-``[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.