ospf6d: introduce support for Graceful Restart (restarting mode)

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

diff --git a/doc/user/ospf6d.rst b/doc/user/ospf6d.rst
index 4fd86ffb139e9f64224e524ee86e4a2699cd22c4..ede2144107e42378c8998af2d9ff90fc507f6116 100644 (file)
--- a/doc/user/ospf6d.rst
+++ b/doc/user/ospf6d.rst
@@ -264,8 +264,17 @@ Redistribute routes to OSPF6
    argument injects the default route regardless of it being present in the
    router. Metric values and route-map can also be specified optionally.
 
-Graceful Restart Helper
-=======================
+Graceful Restart
+================
+
+.. clicmd:: graceful-restart [grace-period (1-1800)]
+
+
+   Configure Graceful Restart (RFC 5187) restarting support.
+   When enabled, the default grace period is 120 seconds.
+
+   To perform a graceful shutdown, the "graceful-restart prepare ipv6 ospf"
+   EXEC-level command needs to be issued before restarting the ospf6d daemon.
 
 .. clicmd:: graceful-restart helper-only [A.B.C.D]
 
@@ -297,6 +306,16 @@ Graceful Restart Helper
    restarts. By default, it supports both planned and
    unplanned outages.
 
+.. clicmd:: graceful-restart prepare ipv6 ospf
+
+
+   Initiate a graceful restart for all OSPFv3 instances configured with the
+   "graceful-restart" command. The ospf6d daemon should be restarted during
+   the instance-specific grace period, otherwise the graceful restart will fail.
+
+   This is an EXEC-level command.
+
+
 .. _showing-ospf6-information:
 
 Showing OSPF6 information