summaryrefslogtreecommitdiffstats
path: root/doc/user
diff options
context:
space:
mode:
authorRuss White <russ@riw.us>2021-07-13 12:39:53 +0200
committerGitHub <noreply@github.com>2021-07-13 12:39:53 +0200
commit000df71ccdc2e81c4d6e7c123ad0db2cbcc4f05d (patch)
tree6fb9713c0171fa1dbaa2d327cba0d087399e42e8 /doc/user
parentMerge pull request #8734 from imzyxwvu/paf-deactivate (diff)
parenttests: add OSPF graceful restart topotest (diff)
downloadfrr-000df71ccdc2e81c4d6e7c123ad0db2cbcc4f05d.tar.xz
frr-000df71ccdc2e81c4d6e7c123ad0db2cbcc4f05d.zip
Merge pull request #8767 from opensourcerouting/ospfd-gr
ospfd: introduce support for Graceful Restart (restarting mode)
Diffstat (limited to 'doc/user')
-rw-r--r--doc/user/ospfd.rst24
1 files changed, 22 insertions, 2 deletions
diff --git a/doc/user/ospfd.rst b/doc/user/ospfd.rst
index 8d67ec865..e8ca39472 100644
--- a/doc/user/ospfd.rst
+++ b/doc/user/ospfd.rst
@@ -710,8 +710,17 @@ Redistribution
-Graceful Restart Helper
-=======================
+Graceful Restart
+================
+
+.. clicmd:: graceful-restart [grace-period (1-1800)]
+
+
+ Configure Graceful Restart (RFC 3623) restarting support.
+ When enabled, the default grace period is 120 seconds.
+
+ To perform a graceful shutdown, the "graceful-restart prepare ip ospf"
+ EXEC-level command needs to be issued before restarting the ospfd daemon.
.. clicmd:: graceful-restart helper-only [A.B.C.D]
@@ -743,6 +752,17 @@ Graceful Restart Helper
restarts. By default, it supports both planned and
unplanned outages.
+
+.. clicmd:: graceful-restart prepare ip ospf
+
+
+ Initiate a graceful restart for all OSPF instances configured with the
+ "graceful-restart" command. The ospfd daemon should be restarted during
+ the instance-specific grace period, otherwise the graceful restart will fail.
+
+ This is an EXEC-level command.
+
+
.. _showing-ospf-information:
Showing Information