summaryrefslogtreecommitdiff
path: root/doc/manpages/bfd-options.rst
diff options
context:
space:
mode:
Diffstat (limited to 'doc/manpages/bfd-options.rst')
-rw-r--r--doc/manpages/bfd-options.rst35
1 files changed, 29 insertions, 6 deletions
diff --git a/doc/manpages/bfd-options.rst b/doc/manpages/bfd-options.rst
index e335ed120b..3f10916207 100644
--- a/doc/manpages/bfd-options.rst
+++ b/doc/manpages/bfd-options.rst
@@ -1,10 +1,33 @@
-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
+.. option:: --dplaneaddr <type>:<address>[<:port>]
- Opens the BFD daemon control socket located at the pointed location.
+ Configure the distributed BFD data plane listening socket bind address.
- (default: |INSTALL_PREFIX_STATE|/bfdd.sock)
+ 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 omitted 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``