summaryrefslogtreecommitdiffstats
path: root/doc/user/bfd.rst
diff options
context:
space:
mode:
authorDaniel Baumann <daniel@debian.org>2024-11-17 07:11:26 +0100
committerDaniel Baumann <daniel@debian.org>2024-11-17 07:11:26 +0100
commitd5587ccda8edb748ca8bfd1f0ed92a801ac5bfc6 (patch)
tree705ea89e798053f9c227b85512bc9f5b437b0093 /doc/user/bfd.rst
parentReleasing debian version 10.1.1-3. (diff)
downloadfrr-d5587ccda8edb748ca8bfd1f0ed92a801ac5bfc6.tar.xz
frr-d5587ccda8edb748ca8bfd1f0ed92a801ac5bfc6.zip
Merging upstream version 10.2.
Signed-off-by: Daniel Baumann <daniel@debian.org>
Diffstat (limited to 'doc/user/bfd.rst')
-rw-r--r--doc/user/bfd.rst34
1 files changed, 14 insertions, 20 deletions
diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst
index 3ca104a3..4c142cfb 100644
--- a/doc/user/bfd.rst
+++ b/doc/user/bfd.rst
@@ -1,12 +1,19 @@
.. _bfd:
-**********************************
-Bidirectional Forwarding Detection
-**********************************
+***
+BFD
+***
-:abbr:`BFD (Bidirectional Forwarding Detection)` stands for
-Bidirectional Forwarding Detection and it is described and extended by
-the following RFCs:
+:abbr:`BFD (Bidirectional Forwarding Detection)` is:
+
+ a protocol intended to detect faults in the bidirectional path between two
+ forwarding engines, including interfaces, data link(s), and to the extent
+ possible the forwarding engines themselves, with potentially very low
+ latency.
+
+ -- :rfc:`5880`
+
+It is described and extended by the following RFCs:
* :rfc:`5880`
* :rfc:`5881`
@@ -38,19 +45,6 @@ may also be specified (:ref:`common-invocation-options`).
.. program:: bfdd
-.. option:: --bfdctl <unix-socket>
-
- Set the BFD daemon control socket location. If using a non-default
- socket location::
-
- /usr/lib/frr/bfdd --bfdctl /tmp/bfdd.sock
-
-
- The default UNIX socket location is |INSTALL_PREFIX_STATE|/bfdd.sock
-
- This option overrides the location addition that the -N option provides
- to the bfdd.sock
-
.. option:: --dplaneaddr <type>:<address>[<:port>]
Configure the distributed BFD data plane listening socket bind address.
@@ -72,7 +66,7 @@ may also be specified (:ref:`common-invocation-options`).
--dplaneaddr ipv6:[::1]:50701
- (if ommited the default port is ``50700``).
+ (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