From 5340fcf144b8041cf3a979c91814c9de81bec9d4 Mon Sep 17 00:00:00 2001 From: Rafael Zalamena Date: Wed, 24 Jul 2024 11:19:40 -0300 Subject: [PATCH] doc: missing distributed BFD man page bit Signed-off-by: Rafael Zalamena --- doc/manpages/bfd-options.rst | 35 ++++++++++++++++++++++++++++++++--- 1 file changed, 32 insertions(+), 3 deletions(-) diff --git a/doc/manpages/bfd-options.rst b/doc/manpages/bfd-options.rst index e335ed120b..9cd43aa2fc 100644 --- a/doc/manpages/bfd-options.rst +++ b/doc/manpages/bfd-options.rst @@ -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 :
[<: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`` -- 2.39.5