From: David Schweizer Date: Wed, 2 Sep 2020 16:20:10 +0000 (+0200) Subject: doc: user doc for bgpd no-rib option vtysh cmds X-Git-Tag: base_7.6~481^2 X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=refs%2Fpull%2F7039%2Fhead;p=mirror%2Ffrr.git doc: user doc for bgpd no-rib option vtysh cmds * Added an entry in the user documentation for the BGP daemon no-rib option vty shell commands. Signed-off-by: David Schweizer --- diff --git a/doc/user/bgp.rst b/doc/user/bgp.rst index 723cb41f26..10eaaee9fb 100644 --- a/doc/user/bgp.rst +++ b/doc/user/bgp.rst @@ -42,6 +42,13 @@ be specified (:ref:`common-invocation-options`). processes in the same namespace. This option is different than the --no_zebra option in that a ZAPI connection is made. + This option can also be toggled during runtime by using the + ``[no] bgp no-rib`` commands in VTY shell. + + Note that this option will persist after saving the configuration during + runtime, unless unset by the ``no bgp no-rib`` command in VTY shell prior to + a configuration write operation. + .. option:: -S, --skip_runas Skip the normal process of checking capabilities and changing user and group @@ -3072,6 +3079,21 @@ by route reflectors to avoid looping. .. index:: bgp cluster-id A.B.C.D .. clicmd:: bgp cluster-id A.B.C.D +.. index:: [no] bgp no-rib +.. clicmd:: [no] bgp no-rib + +To set and unset the BGP daemon ``-n`` / ``--no_kernel`` options during runtime +to disable BGP route installation to the RIB (Zebra), the ``[no] bgp no-rib`` +commands can be used; + +Please note that setting the option during runtime will withdraw all routes in +the daemons RIB from Zebra and unsetting it will announce all routes in the +daemons RIB to Zebra. If the option is passed as a command line argument when +starting the daemon and the configuration gets saved, the option will persist +unless removed from the configuration with the negating command prior to the +configuration write operation. + + .. _routing-policy: Routing Policy