summaryrefslogtreecommitdiff
path: root/doc/user/bfd.rst
AgeCommit message (Collapse)Author
2025-03-03doc: Add "log-session-changes" documentation.Acee Lindem
Signed-off-by: Acee Lindem <acee@lindem.com>
2024-10-08bfdd, doc, yang: change bfd timer and multiplier valuesPhilippe Guibert
The minimum and maximum values for BFD timers and multiplier settings have been updated to align with RFC 5880 requirements. Since the values inputted via VTY are in milliseconds, the maximum permissible value on the VTY interface is 4,294,967 milliseconds. For the multiplier setting, the minimum value is now restricted to be greater than zero, as zero is not allowed. The minimum transmit interval has been set to 10 milliseconds to ensure reliable service performance. Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com> Signed-off-by: Louis Scalbert <louis.scalbert@6wind.com>
2024-08-15*: Fix spelling errors foundDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2024-07-25doc: remove BFD control socket documentationRafael Zalamena
Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2024-06-25doc: improve table-of-contents organizationQuentin Young
The current TOC organization is not really following Sphinx best practices and is resulting in a jumble of articles showing up in the sidebar. This change primarily organizes existing articles into three major sections: * Introduction - Contains system requirements, architecture & design, installation, basic setup * Basics - Covers basic commands, concepts, and some random things that don't fit elsewhere * Protocols - Contains all protocol documentation, and other miscellaneous daemon docs such as those on Zebra, watchfrr, mgmtd, etc. The appendix has been left as is, but the TOC now has a caption which has the effect of adding a section separator in the nav sidebar. In order to make the new structure make sense: * Some content has been lifted up from the "Overview" page into the index page * Most content has been pushed down from the "Overview" page into the "About" page (new) * BFD's page is now titled "BFD" for consistencty; it was the only one that had the full protocol name written out in the title And a couple drivebys: * BFD's intro description paragraph was rewritten to make more sense * Old language stating that we publish platform packages on the Github releases page was removed * References to source building instructions were consolidated into that section Signed-off-by: Quentin Young <qlyoung@qlyoung.net>
2024-01-27build: nuke `BFDD_CONTROL_SOCKET`David Lamparter
This just unnecessarily complicates things by involving autoconf. Signed-off-by: David Lamparter <equinox@opensourcerouting.org>
2024-01-13doc: update config file doc for integrated requirementChristian Hopps
Signed-off-by: Christian Hopps <chopps@labn.net>
2023-07-20doc: remove BFD label command referencesRafael Zalamena
`label` command is already gone and now we are going to remove all label references. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2023-04-19doc: RIP BFD integration documentationRafael Zalamena
Let users know about the RIP BFD integration commands and increment the used RFCs reference. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2023-01-13doc: document new static BFD commandsRafael Zalamena
Let the user know how to use the static route monitoring commands. Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com> Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2022-08-02Doc: Update documentation for BFD Echo.lynnemorrison
Add information about Round Trip Time added to IPV4 BFD Echo. Signed-off-by: Lynne Morrison <lynne.morrison@ibm.com>
2022-04-19*: Fix spelling of overridenDonald Sharp
Signed-off-by: Donald Sharp <sharpd@nvidia.com>
2022-01-24doc: clarify bfd parameters' overriden methodanlan_cs
Here "new" is very puzzling. If new parameters with default values on peer configuration node are set, they will not be used yet. So just clarify it: Only "non-default" values on peer configuration node are set, they can override the conrresponding values from profile. Signed-off-by: anlan_cs <vic.lan@pica8.com>
2021-06-03doc: remove varnames from command descriptionsIgor Ryzhov
Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2021-04-24Merge pull request #8495 from opensourcerouting/ospfv3-bfd-reworkIgor Ryzhov
ospf6d: rework BFD integration and add BFD profiles support
2021-04-23doc: document new PIM BFD command variantRafael Zalamena
Tell user he can configure BFD profile for sessions created by PIM. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2021-04-22doc: OSPFv3 BFD profile documentationRafael Zalamena
Let user know he can use BFD profiles with OSPFv3. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2021-03-23doc: update OSPF BFD documentationRafael Zalamena
Tell users that OSPFv2 now supports BFD profiles. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2021-03-17Merge pull request #8225 from idryzhov/bfd-echo-modeRafael Zalamena
bfdd: fix echo receive timer and disable echo mode
2021-03-16bfdd: separate echo rx/tx timersIgor Ryzhov
Currently there is a single interval for both RX and TX echo functions. This commit introduces separate RX and TX timers for echo packets. The main advantage is to be able to set the receive interval to zero when we don't want to receive echo packets from the remote system. Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2021-03-16bfdd: warn users about echo-mode restrictionsIgor Ryzhov
Echo-mode implementation is currently broken. Instead of sending packets to it's own address, bfdd is sending echo packets to the peer's address. It may seem to work when testing between two FRR instances, because FRR loops back such packets, but no other implementation is supposed to do that. Let's warn users that the current implementation works only between two FRR instances. Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2021-02-22doc: remove 'no' form of commandsQuentin Young
These don't need to be documented, most of the time they are obvious, when they aren't the behavior can just be described in the command description. Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2021-02-22doc: automatically generate index entries for cliQuentin Young
- Generate index entries automatically - Remove manual command index entries - Clean up a few other manual index entries Signed-off-by: Quentin Young <qlyoung@nvidia.com>
2020-11-24bfdd: support connecting to BFD data planeRafael Zalamena
Add option to connect to a data plane server instead of receiving connections. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-11-24doc: add information about distributed BFDRafael Zalamena
Document the new feature to let users that it exists. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-11-17doc: don't index 'no' forms of commandsMark Stapp
Many index entries used '[no] xxx' or 'no xxx', some had both positive and 'no' forms. Clean that up mostly - index positive form of commands only. Signed-off-by: Mark Stapp <mjs@voltanet.io>
2020-08-11doc: add BFD minimum TTL documentationRafael Zalamena
Let the user know what the new command does. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-08-11doc: add BFD passive mode documentationRafael Zalamena
Let the user know what the new command does. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-07-10 *: add BFD profile support for IS-ISGalaxyGorilla
BFD profiles can now be used on the interface level like this: interface eth1 ip router isis 1 isis bfd isis bfd profile default Here the 'default' profile needs to be specified as usual in the bfdd configuration. Signed-off-by: GalaxyGorilla <sascha@netdef.org>
2020-07-08Merge pull request #6385 from GalaxyGorilla/bfd_igp_topotestRenato Westphal
isis: tests: Fast RIB recovery from BFD recognized link failures
2020-07-07doc: remove trailing whitespaceQuentin Young
Signed-off-by: Quentin Young <qlyoung@cumulusnetworks.com>
2020-07-03tests: Introduce BFD IS-IS topotestsGalaxyGorilla
The tests work with the default settings of BFD meaning that bfdd is able to recognize a 'down' link after ~900ms so a route recovery should be visible in the RIB after 1 second. In the current state only IPv4 is used (when using IPv6 autoconfiguration) within BFD, even though the recovery also affects IPv6 routes. This is different to the current state of ospfd/ospf6d in combination with BFD since both IPv4 and IPv6 sessions are used there. The following topology is used: +---------+ | | eth-rt2 (.1) | RT1 | eth-rt3 (.1) +----------+ 1.1.1.1 +----------+ | | | | | +---------+ | | | | 10.0.2.0/24 | | | | eth-rt1 | (.2) | 10.0.1.0/24 +----+----+ | | | | | RT3 | | | 3.3.3.3 | | | | (.2) | eth-rt1 +----+----+ +----+----+ eth-rt4 | (.1) | | | | RT2 | | | 2.2.2.2 | 10.0.4.0/24 | | | | +----+----+ | (.1) | eth-rt5 eth-rt3 | (.2) | +----+----+ | | | | | RT4 | | | 4.4.4.4 | | | | | +----+----+ | 10.0.3.0/24 eth-rt5 | (.1) | | | | | 10.0.5.0/24 | | | | +---------+ | | | | | +----------+ RT5 +----------+ eth-rt2 (.2) | 5.5.5.5 | eth-rt4 (.2) | | +---------+ Route recovery is tested on RT1. The focus here lies on the two different routes to RT5. Link failures are generated by taking down interfaces via the mininet Python interface on RT2 and RT3. Hence routes are supposed to be adjusted to use RT3 when a link failure happens on RT2 or vice versa. Note that only failure recognition and recovery is "fast". BFD does not monitor a link becoming available again. Signed-off-by: GalaxyGorilla <sascha@netdef.org>
2020-05-29doc: document BGP BFD command with profileRafael Zalamena
Let the user know its possible to create BFD sessions with profiles applied to it or apply profile to already created sessions. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-05-20doc: document the new BFD profile commandsRafael Zalamena
Let the user know we have BFD profiles and how they work. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-04-14doc: update BFD debugging sectionRafael Zalamena
Show more information about BFD debug feature. Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2020-01-16doc: Note about BFD debug loggingTim Bray
Because there is nothing in config debug for BFD. Signed-off-by: Tim Bray <tim@kooky.org>
2019-12-06Merge pull request #5288 from SumitAgarwal123/bfd_docsRafael Zalamena
doc: Adding new CLI and updating existing show output
2019-11-05doc: Adding new CLI and updating exsisting show outputSumitAgarwal123
1. Adding 2 two new fields Peer type, configured/dynamic Detect multiplier 2. Added new command "clear bfd counters" 3. Added new command "show bfd peers brief" Signed-off-by: Sayed Mohd Saquib sayed.saquib@broadcom.com
2019-09-24*: fix missing VRF autocompletionsIgor Ryzhov
Current autocompletion works only for simple "vrf NAME" case. This commit expands it also for the following cases: - "nexthop-vrf NAME" in staticd - usage of $varname in many daemons All daemons are updated to use single varname "$vrf_name". Signed-off-by: Igor Ryzhov <iryzhov@nfware.com>
2019-06-04doc: Update the documentation to reflect -N changesDonald Sharp
The -N <namespace> option is now used to control the location of various control files and sockets. Update the documentation to reflect this. Signed-off-by: Donald Sharp <sharpd@cumulusnetworks.com>
2019-05-14doc: add bfd check-control-plane-failure informationPhilippe Guibert
this command is used when user wants to use the cbit value. more information in the documentation. Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2019-05-07doc: change bfd show commands with vrfname keywordPhilippe Guibert
now that bfd show commands have changed, update documentation so as to reflect how to use vrf keyword in the show bfd commands. Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2019-05-07doc: update bfd documentationPhilippe Guibert
add a bfd vrf example. explain that it is possible to use both interface and vrf keyword. Signed-off-by: Philippe Guibert <philippe.guibert@6wind.com>
2018-08-20bfdd: fix documentation warningsRafael Zalamena
* Extend dashes on 'OSPF BFD Configuration' title; * Add JSON output code indentation; Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-08-15bfdd: improve docsRafael Zalamena
Improvements: * Show command line as code, to avoid confusion about single dash (`-`) and double dash; * Tell the user where the BGP BFD commands can be found; * Document OSPF/OSPF6/PIM BFD commands; * Document JSON commands; * Tell about session counters; Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>
2018-08-08bfdd: add documentationRafael Zalamena
Add BFD daemon documentation: * commands; * man page; * manual / description; Signed-off-by: Rafael Zalamena <rzalamena@opensourcerouting.org>