summaryrefslogtreecommitdiff
path: root/docs/configuration/protocols/bgp.md
diff options
context:
space:
mode:
authorNataliia S. <81954790+natali-rs1985@users.noreply.github.com>2026-05-14 14:01:13 +0300
committerGitHub <noreply@github.com>2026-05-14 12:01:13 +0100
commit65a5a35942c099f337ef4224251bbbaf8e076dbb (patch)
tree23183cb97ad3460a48770b1ce5462d55b3a8de36 /docs/configuration/protocols/bgp.md
parentddee034eedac71a45d7a92d5207be14f5fd7a618 (diff)
downloadvyos-documentation-65a5a35942c099f337ef4224251bbbaf8e076dbb.tar.gz
vyos-documentation-65a5a35942c099f337ef4224251bbbaf8e076dbb.zip
bgp: T8607: Add CLI support for BGP update-delay and establish-wait (#1891)
* bgp: T8607: Add CLI support for BGP update-delay and establish-wait * Potential fix for pull request finding Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com> * T8607: Apply Copilot's suggestions --------- Co-authored-by: Christian Breunig <christian@breunig.cc> Co-authored-by: Copilot Autofix powered by AI <175728472+Copilot@users.noreply.github.com>
Diffstat (limited to 'docs/configuration/protocols/bgp.md')
-rw-r--r--docs/configuration/protocols/bgp.md46
1 files changed, 46 insertions, 0 deletions
diff --git a/docs/configuration/protocols/bgp.md b/docs/configuration/protocols/bgp.md
index cfa79ce4..87628664 100644
--- a/docs/configuration/protocols/bgp.md
+++ b/docs/configuration/protocols/bgp.md
@@ -797,6 +797,52 @@ This command specifies keep-alive time in seconds. The timer
can range from 4 to 65535. The default value is 60 second.
```
+
+##### BGP read-only mode
+
+```{eval-rst}
+.. cfgcmd:: set protocols bgp parameters update-delay max-delay <seconds>
+
+**Enable BGP read-only mode after a BGP process restart or clearing all BGP sessions, and configure the mode’s maximum delay.**
+
+In read-only mode, BGP suspends best-path selection and does not send routing
+updates to peers. The mode ends when the router receives all expected
+End-of-RIB (EOR) messages from BGP peers or when the maximum delay is
+reached, whichever occurs first.
+
+The router expects EOR messages from all configured BGP peers except those
+that are administratively shut down. If the ``establish-wait`` parameter is
+configured, the router waits for EOR messages only from BGP peers that reach
+the Established state within the ``establish-wait`` window.
+
+The allowed range is 0 to 3600 seconds. By default, this feature is disabled.
+
+Example:
+
+.. code-block:: none
+
+ set protocols bgp parameters update-delay max-delay 120
+```
+
+```{eval-rst}
+.. cfgcmd:: set protocols bgp parameters update-delay establish-wait <seconds>
+
+**Configure how long the router waits for BGP peers to reach the Established state after read-only mode begins.**
+
+The router waits for EOR messages only from BGP peers that reach the
+Established state within the ``establish-wait`` window. The ``establish-wait``
+value must not exceed the ``max-delay`` value.
+
+The allowed range is 1 to 3600 seconds. This parameter requires ``max-delay`` to
+be configured.
+
+Example:
+
+.. code-block:: none
+
+ set protocols bgp parameters update-delay establish-wait 90
+```
+
##### Route Dampening
When a route fails, a routing update is sent to withdraw the route from the