Merge pull request #13649 from donaldsharp/unlock_the_node_or_else

[mirror_frr.git] / doc / user / ripd.rst

diff --git a/doc/user/ripd.rst b/doc/user/ripd.rst
index 83c8c93b1c93da1d2982411756865706e5ee8677..f9c772430221de0bf212793caaf9fd4503236441 100644 (file)
--- a/doc/user/ripd.rst
+++ b/doc/user/ripd.rst
@@ -40,7 +40,8 @@ sequence for running RIP is like below:
 Please note that *zebra* must be invoked before *ripd*.
 
 To stop *ripd*. Please use::
-   kill `cat /var/run/ripd.pid`
+
+   kill `cat /var/run/frr/ripd.pid`
 
 Certain signals have special meanings to *ripd*.
 
@@ -87,15 +88,12 @@ multipath routing.
 RIP Configuration
 =================
 
-.. clicmd:: router rip
+.. clicmd:: router rip [vrf NAME]
 
    The `router rip` command is necessary to enable RIP. To disable RIP, use the
    `no router rip` command. RIP must be enabled before carrying out any of the
    RIP commands.
 
-
-   Disable RIP.
-
 .. clicmd:: network NETWORK
 
 
@@ -119,14 +117,14 @@ RIP Configuration
 .. clicmd:: neighbor A.B.C.D
 
 
-   Specify RIP neighbor. When a neighbor doesn't understand multicast, this
-   command is used to specify neighbors. In some cases, not all routers will be
-   able to understand multicasting, where packets are sent to a network or a
-   group of addresses. In a situation where a neighbor cannot process multicast
-   packets, it is necessary to establish a direct link between routers. The
-   neighbor command allows the network administrator to specify a router as a
-   RIP neighbor. The `no neighbor a.b.c.d` command will disable the RIP
-   neighbor.
+   Specify a RIP neighbor to send updates to. This is required when a neighbor
+   is connected via a network that does not support multicast, or when it is
+   desired to statically define a neighbor. RIP updates will be sent via unicast
+   to each neighbour. Neighbour updates are in addition to any multicast updates
+   sent when an interface is not in passive mode (see the `passive-interface`
+   command). RIP will continue to process updates received from both the
+   neighbor and any received via multicast. The `no neighbor a.b.c.d` command
+   will disable the RIP neighbor.
 
    Below is very simple RIP configuration. Interface `eth0` and interface which
    address match to `10.0.0.0/8` are RIP enabled.
@@ -151,13 +149,21 @@ RIP Configuration
 
    The default is to be passive on all interfaces.
 
-.. clicmd:: ip split-horizon
+.. clicmd:: ip split-horizon [poisoned-reverse]
 
 
    Control split-horizon on the interface. Default is `ip split-horizon`. If
    you don't perform split-horizon on the interface, please specify `no ip
    split-horizon`.
 
+   If `poisoned-reverse` is also set, the router sends the poisoned routes
+   with highest metric back to the sending router.
+
+.. clicmd:: allow-ecmp [1-MULTIPATH_NUM]
+
+   Control how many ECMP paths RIP can inject for the same prefix. If specified
+   without a number, a maximum is taken (compiled with ``--enable-multipath``).
+
 .. _rip-version-control:
 
 RIP Version Control
@@ -176,8 +182,8 @@ discussion on the security implications of RIPv1 see :ref:`rip-authentication`.
 
 .. clicmd:: version VERSION
 
-   Set RIP version to accept for reads and send. ``VERSION`` can be either 1 or
-   1.
+   Set RIP version to accept for reads and send. VERSION can be either
+   ``1`` or ``2``.
 
    Disabling RIPv1 by specifying version 2 is STRONGLY encouraged,
    :ref:`rip-authentication`. This may become the default in a future release.
@@ -236,11 +242,13 @@ Filtering RIP Routes
 
 RIP routes can be filtered by a distribute-list.
 
-.. clicmd:: distribute-list ACCESS_LIST DIRECT IFNAME
+.. clicmd:: distribute-list [prefix] LIST <in|out> IFNAME
 
    You can apply access lists to the interface with a `distribute-list` command.
-   ACCESS_LIST is the access list name. DIRECT is ``in`` or ``out``. If DIRECT
-   is ``in`` the access list is applied to input packets.
+   If prefix is specified LIST is a prefix-list.  If prefix is not specified
+   then LIST is the access list name.  `in` specifies packets being received,
+   and `out` specifies outgoing packets.  Finally if an interface is specified
+   it will be applied against a specific interface.
 
    The `distribute-list` command can be used to filter the RIP path.
    `distribute-list` can apply access-lists to a chosen interface.  First, one
@@ -261,13 +269,6 @@ RIP routes can be filtered by a distribute-list.
 
    `distribute-list` can be applied to both incoming and outgoing data.
 
-.. clicmd:: distribute-list prefix PREFIX_LIST (in|out) IFNAME
-
-   You can apply prefix lists to the interface with a `distribute-list`
-   command. PREFIX_LIST is the prefix list name. Next is the direction of
-   ``in`` or ``out``. If DIRECT is ``in`` the access list is applied to input
-   packets.
-
 .. _rip-metric-manipulation:
 
 RIP Metric Manipulation
@@ -479,7 +480,7 @@ Show RIP Information
 
 To display RIP routes.
 
-.. clicmd:: show ip rip
+.. clicmd:: show ip rip [vrf NAME]
 
    Show RIP routes.
 
@@ -488,7 +489,7 @@ through RIP, this command will display the time the packet was sent and
 the tag information. This command will also display this information
 for routes redistributed into RIP.
 
-.. clicmd:: show ip rip status
+.. clicmd:: show ip rip [vrf NAME] status
 
    The command displays current RIP status. It includes RIP timer,
    filtering, version, RIP enabled interface and RIP peer information.