From: Tim Bray <tim@kooky.org>
Date: Tue, 12 May 2020 10:41:13 +0000 (+0100)
Subject: doc: Improve Zebra set src documentation.  (IPv6)
X-Git-Tag: base_7.5~382^2
X-Git-Url: https://git.puffer.fish/?a=commitdiff_plain;h=refs%2Fpull%2F6384%2Fhead;p=mirror%2Ffrr.git

doc: Improve Zebra set src documentation.  (IPv6)

Include an IPv6 example for set src

And a note that the IP address has to exist.   This is to try and make
people aware to avoid things like issue #4249
https://github.com/FRRouting/frr/issues/4249

Signed-off-by: Tim Bray <tim@kooky.org>
---

diff --git a/doc/user/zebra.rst b/doc/user/zebra.rst
index 9dfd08f733..f3b4ca7d03 100644
--- a/doc/user/zebra.rst
+++ b/doc/user/zebra.rst
@@ -708,6 +708,24 @@ that sets the preferred source address, and applies the route-map to all
 
    ip protocol rip route-map RM1
 
+IPv6 example for OSPFv3.
+
+.. code-block:: frr
+
+   ipv6 prefix-list ANY seq 10 permit any
+   route-map RM6 permit 10
+       match ipv6 address prefix-list ANY
+       set src 2001:db8:425:1000::3
+
+   ipv6 protocol ospf6 route-map RM6
+
+
+.. note::
+
+   For both IPv4 and IPv6, the IP address has to exist at the point the
+   route-map is created.  Be wary of race conditions if the interface is
+   not created at startup.  On Debian, FRR might start before ifupdown
+   completes. Consider a reboot test.
 
 .. _zebra-fib-push-interface: