]> git.puffer.fish Git - mirror/frr.git/commitdiff
doc: missing distributed BFD man page bit
authorRafael Zalamena <rzalamena@opensourcerouting.org>
Wed, 24 Jul 2024 14:19:40 +0000 (11:19 -0300)
committerRafael Zalamena <rzalamena@opensourcerouting.org>
Thu, 25 Jul 2024 13:37:11 +0000 (10:37 -0300)
Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
doc/manpages/bfd-options.rst

index e335ed120bde7716d91e2ddf6b8ef94d8ee86a67..9cd43aa2fc76dc3e1bb935a9c35d7bfedc760c28 100644 (file)
@@ -1,10 +1,39 @@
-BFD SOCKET
-----------
+BFD
+---
 
-The following option controls the BFD daemon control socket location.
+The following options controls the BFD daemon auxiliary sockets.
 
 .. option:: --bfdctl bfd-control-socket
 
    Opens the BFD daemon control socket located at the pointed location.
 
    (default: |INSTALL_PREFIX_STATE|/bfdd.sock)
+
+.. option:: --dplaneaddr <type>:<address>[<:port>]
+
+   Configure the distributed BFD data plane listening socket bind address.
+
+   One would expect the data plane to run in the same machine as FRR, so
+   the suggested configuration would be:
+
+      ``--dplaneaddr unix:/var/run/frr/bfdd_dplane.sock``
+
+   Or using IPv4:
+
+      ``--dplaneaddr ipv4:127.0.0.1``
+
+   Or using IPv6:
+
+      ``--dplaneaddr ipv6:[::1]``
+
+   It is also possible to specify a port (for IPv4/IPv6 only):
+
+     ``--dplaneaddr ipv6:[::1]:50701``
+
+   (if ommited the default port is ``50700``).
+
+   It is also possible to operate in client mode (instead of listening for
+   connections). To connect to a data plane server append the letter 'c' to
+   the protocol, example:
+
+     ``--dplaneaddr ipv4c:127.0.0.1``