From 1e31580f8a8ebcbeb6a6f207b114f8eabe1317bf Mon Sep 17 00:00:00 2001 From: Quentin Young Date: Thu, 18 Feb 2021 17:52:33 -0500 Subject: [PATCH] doc: clean up duplicate/wrong commands Signed-off-by: Quentin Young --- doc/user/bgp.rst | 31 ++--------------- doc/user/eigrpd.rst | 66 ++++++----------------------------- doc/user/ospf6d.rst | 17 +++------ doc/user/ospfd.rst | 38 ++------------------ doc/user/pim.rst | 22 ++++++------ doc/user/ripd.rst | 85 ++++----------------------------------------- doc/user/ripngd.rst | 5 --- doc/user/zebra.rst | 1 + 8 files changed, 41 insertions(+), 224 deletions(-) diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index cb97ee22df..2da37447cc 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -1264,35 +1264,10 @@ Route Aggregation-IPv6 Address Family Redistribution -------------- -.. index:: redistribute kernel -.. clicmd:: redistribute kernel +.. index:: redistribute [(1-65535)] [metric (0-4294967295)] [route-map WORD] +.. index:: redistribute [(1-65535)] [metric (0-4294967295)] [route-map WORD] - Redistribute kernel route to BGP process. - -.. index:: redistribute static -.. clicmd:: redistribute static - - Redistribute static route to BGP process. - -.. index:: redistribute connected -.. clicmd:: redistribute connected - - Redistribute connected route to BGP process. - -.. index:: redistribute rip -.. clicmd:: redistribute rip - - Redistribute RIP route to BGP process. - -.. index:: redistribute ospf -.. clicmd:: redistribute ospf - - Redistribute OSPF route to BGP process. - -.. index:: redistribute vnc -.. clicmd:: redistribute vnc - - Redistribute VNC routes to BGP process. + Redistribute routes from other protocols into BGP. .. index:: redistribute vnc-direct .. clicmd:: redistribute vnc-direct diff --git a/doc/user/eigrpd.rst b/doc/user/eigrpd.rst index 4ce2e280c7..de42f6deeb 100644 --- a/doc/user/eigrpd.rst +++ b/doc/user/eigrpd.rst @@ -123,67 +123,21 @@ EIGRP Configuration How to Announce EIGRP route =========================== -.. index:: redistribute kernel -.. clicmd:: redistribute kernel +Redistribute routes into EIGRP: -.. index:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. clicmd:: redistribute kernel metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) +.. index:: redistribute [metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)] +.. clicmd:: redistribute [metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535)] -.. index:: redistribute kernel -.. clicmd:: no redistribute kernel + The ``redistribute`` family of commands imports routing information from + other sources into EIGRP's tables. Redistribution may be disabled with the + ``no`` form of the commands. - `redistribute kernel` redistributes routing information from kernel route - entries into the EIGRP tables. `no redistribute kernel` disables the routes. + Note that connected routes on interfaces EIGRP is enabled on are announced + by default. -.. index:: redistribute static -.. clicmd:: redistribute static + Optionally, various EIGRP metrics may be specified. These metrics will be + applied to the imported routes. -.. index:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. clicmd:: redistribute static metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) - -.. index:: redistribute static -.. clicmd:: no redistribute static - - `redistribute static` redistributes routing information from static route - entries into the EIGRP tables. `no redistribute static` disables the routes. - -.. index:: redistribute connected -.. clicmd:: redistribute connected - -.. index:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. clicmd:: redistribute connected metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) - -.. index:: redistribute connected -.. clicmd:: no redistribute connected - - Redistribute connected routes into the EIGRP tables. `no redistribute - connected` disables the connected routes in the EIGRP tables. This command - redistribute connected of the interface which EIGRP disabled. The connected - route on EIGRP enabled interface is announced by default. - -.. index:: redistribute ospf -.. clicmd:: redistribute ospf - -.. index:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. clicmd:: redistribute ospf metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) - -.. index:: redistribute ospf -.. clicmd:: no redistribute ospf - - `redistribute ospf` redistributes routing information from ospf route - entries into the EIGRP tables. `no redistribute ospf` disables the routes. - -.. index:: redistribute bgp -.. clicmd:: redistribute bgp - -.. index:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) -.. clicmd:: redistribute bgp metric (1-4294967295) (0-4294967295) (0-255) (1-255) (1-65535) - -.. index:: redistribute bgp -.. clicmd:: no redistribute bgp - - `redistribute bgp` redistributes routing information from bgp route entries - into the EIGRP tables. `no redistribute bgp` disables the routes. .. _show-eigrp-information: diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst index 99119bb7e5..fb8878b9bb 100644 --- a/doc/user/ospf6d.rst +++ b/doc/user/ospf6d.rst @@ -29,11 +29,8 @@ OSPF6 router Bind interface to specified area, and start sending OSPF packets. `area` can be specified as 0. -.. index:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME -.. clicmd:: timers throttle spf DELAY INITIAL-HOLDTIME MAX-HOLDTIME - -.. index:: timers throttle spf -.. clicmd:: no timers throttle spf +.. index:: timers throttle spf (0-600000) (0-600000) (0-600000) +.. clicmd:: timers throttle spf (0-600000) (0-600000) (0-600000) This command sets the initial `delay`, the `initial-holdtime` and the `maximum-holdtime` between when SPF is calculated and the @@ -154,14 +151,10 @@ Usage of *ospfd6*'s route-map support. Redistribute routes to OSPF6 ============================ -.. index:: redistribute static -.. clicmd:: redistribute static - -.. index:: redistribute connected -.. clicmd:: redistribute connected +.. index:: redistribute [route-map WORD] +.. clicmd:: redistribute [route-map WORD] -.. index:: redistribute ripng -.. clicmd:: redistribute ripng + Redistribute routes from other protocols into OSPFv3. .. _showing-ospf6-information: diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst index ee02a9dae5..77d3c7ddb8 100644 --- a/doc/user/ospfd.rst +++ b/doc/user/ospfd.rst @@ -180,9 +180,6 @@ To start OSPF process you have to specify the OSPF router. .. index:: timers throttle spf (0-600000) (0-600000) (0-600000) .. clicmd:: timers throttle spf (0-600000) (0-600000) (0-600000) -.. index:: timers throttle spf -.. clicmd:: no timers throttle spf - This command sets the initial `delay`, the `initial-holdtime` and the `maximum-holdtime` between when SPF is calculated and the event which triggered the calculation. The times are specified in @@ -755,35 +752,11 @@ Usage of *ospfd*'s route-map support. Redistribution -------------- -.. index:: redistribute (kernel|connected|static|rip|bgp) -.. clicmd:: redistribute (kernel|connected|static|rip|bgp) - -.. index:: redistribute (kernel|connected|static|rip|bgp) ROUTE-MAP -.. clicmd:: redistribute (kernel|connected|static|rip|bgp) ROUTE-MAP - -.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) -.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) - -.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map WORD -.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) route-map WORD - -.. index:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) -.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) - -.. index:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map WORD -.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric (0-16777214) route-map WORD - -.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) -.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) - -.. index:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map WORD -.. clicmd:: redistribute (kernel|connected|static|rip|bgp) metric-type (1|2) metric (0-16777214) route-map WORD - -.. index:: redistribute (kernel|connected|static|rip|bgp) -.. clicmd:: no redistribute (kernel|connected|static|rip|bgp) - .. _ospf-redistribute: +.. index:: redistribute [metric-type (1-2)] [metric (0-16777214)] [route-map WORD] +.. clicmd:: redistribute [metric-type (1-2)] [metric (0-16777214)] [route-map WORD] + Redistribute routes of the specified protocol or kind into OSPF, with the metric type and metric set if specified, filtering the routes using the given route-map if specified. Redistributed routes may also be filtered @@ -864,11 +837,6 @@ Redistribution .. index:: distance ospf .. clicmd:: no distance ospf -.. index:: router zebra -.. clicmd:: router zebra - -.. index:: router zebra -.. clicmd:: no router zebra Graceful Restart Helper ======================= diff --git a/doc/user/pim.rst b/doc/user/pim.rst index 201fe2f9ed..3a08cf3353 100644 --- a/doc/user/pim.rst +++ b/doc/user/pim.rst @@ -214,11 +214,6 @@ is in a vrf, enter the interface command with the vrf keyword at the end. command will not do anything if you do not have the underlying ability of a mlag implementation. -.. index:: ip pim bfd -.. clicmd:: ip pim bfd - - Turns on BFD support for PIM for this interface. - .. index:: ip pim bsm .. clicmd:: ip pim bsm @@ -313,6 +308,12 @@ is in a vrf, enter the interface command with the vrf keyword at the end. be forwarded on the given interface if the traffic matches the group address and optionally the source address. + +.. seealso:: + + :ref:`bfd-pim-peer-config` + + .. _pim-multicast-rib-insertion: PIM Multicast RIB insertion: @@ -608,11 +609,6 @@ cause great confusion. Display all fragments ofstored bootstrap message in user readable format. -.. index:: show ip rpf -.. clicmd:: show ip rpf - - Display the multicast RIB created in zebra. - .. index:: mtrace A.B.C.D [A.B.C.D] .. clicmd:: mtrace A.B.C.D [A.B.C.D] @@ -628,6 +624,12 @@ cause great confusion. Display multicast data packets count per interface for all vrf. + +.. seealso:: + + :ref:`multicast-rib-commands` + + PIM Debug Commands ================== diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst index e83b505a19..f00f25449b 100644 --- a/doc/user/ripd.rst +++ b/doc/user/ripd.rst @@ -232,89 +232,18 @@ discussion on the security implications of RIPv1 see :ref:`rip-authentication`. Default: Accept packets according to the global setting (both 1 and 2). + .. _how-to-announce-rip-route: How to Announce RIP route ========================= -.. index:: redistribute kernel -.. clicmd:: redistribute kernel - -.. index:: redistribute kernel metric (0-16) -.. clicmd:: redistribute kernel metric (0-16) - -.. index:: redistribute kernel route-map ROUTE-MAP -.. clicmd:: redistribute kernel route-map ROUTE-MAP - -.. index:: redistribute kernel -.. clicmd:: no redistribute kernel - - `redistribute kernel` redistributes routing information from kernel route - entries into the RIP tables. `no redistribute kernel` disables the routes. - -.. index:: redistribute static -.. clicmd:: redistribute static - -.. index:: redistribute static metric (0-16) -.. clicmd:: redistribute static metric (0-16) - -.. index:: redistribute static route-map ROUTE-MAP -.. clicmd:: redistribute static route-map ROUTE-MAP - -.. index:: redistribute static -.. clicmd:: no redistribute static - - `redistribute static` redistributes routing information from static route - entries into the RIP tables. `no redistribute static` disables the routes. - -.. index:: redistribute connected -.. clicmd:: redistribute connected - -.. index:: redistribute connected metric (0-16) -.. clicmd:: redistribute connected metric (0-16) - -.. index:: redistribute connected route-map ROUTE-MAP -.. clicmd:: redistribute connected route-map ROUTE-MAP - -.. index:: redistribute connected -.. clicmd:: no redistribute connected - - Redistribute connected routes into the RIP tables. `no redistribute - connected` disables the connected routes in the RIP tables. This command - redistribute connected of the interface which RIP disabled. The connected - route on RIP enabled interface is announced by default. - -.. index:: redistribute ospf -.. clicmd:: redistribute ospf - -.. index:: redistribute ospf metric (0-16) -.. clicmd:: redistribute ospf metric (0-16) - -.. index:: redistribute ospf route-map ROUTE-MAP -.. clicmd:: redistribute ospf route-map ROUTE-MAP - -.. index:: redistribute ospf -.. clicmd:: no redistribute ospf - - `redistribute ospf` redistributes routing information from ospf route - entries into the RIP tables. `no redistribute ospf` disables the routes. - -.. index:: redistribute bgp -.. clicmd:: redistribute bgp - -.. index:: redistribute bgp metric (0-16) -.. clicmd:: redistribute bgp metric (0-16) - -.. index:: redistribute bgp route-map ROUTE-MAP -.. clicmd:: redistribute bgp route-map ROUTE-MAP - -.. index:: redistribute bgp -.. clicmd:: no redistribute bgp +.. index:: redistribute [metric (0-16)] [route-map WORD] +.. clicmd:: redistribute [metric (0-16)] [route-map WORD] - `redistribute bgp` redistributes routing information from bgp route entries - into the RIP tables. `no redistribute bgp` disables the routes. + Redistribute routes from other sources into RIP. - If you want to specify RIP only static routes: +If you want to specify RIP only static routes: .. index:: default-information originate .. clicmd:: default-information originate @@ -407,10 +336,10 @@ RIP distance Distance value is used in zebra daemon. Default RIP distance is 120. -.. index:: distance (1-255) +.. index:: RIP - distance (1-255) .. clicmd:: distance (1-255) -.. index:: distance (1-255) +.. index:: RIP - distance (1-255) .. clicmd:: no distance (1-255) Set default RIP distance to specified value. diff --git a/doc/user/ripngd.rst b/doc/user/ripngd.rst index ae2400f0bb..fb4161c37d 100644 --- a/doc/user/ripngd.rst +++ b/doc/user/ripngd.rst @@ -47,11 +47,6 @@ Currently ripngd supports the following commands: Set RIPng static routing announcement of NETWORK. -.. index:: router zebra -.. clicmd:: router zebra - - This command is the default and does not appear in the configuration. With - this statement, RIPng routes go to the *zebra* daemon. .. _ripngd-terminal-mode-commands: diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst index a9979558c3..4be10d2287 100644 --- a/doc/user/zebra.rst +++ b/doc/user/zebra.rst @@ -650,6 +650,7 @@ unicast topology! what the default behavior is. .. warning:: + Unreachable routes do not receive special treatment and do not cause fallback to a second lookup. -- 2.39.5