From 088f4902025155c00f405e63eb4e7c378084b054 Mon Sep 17 00:00:00 2001 From: Rafael Zalamena Date: Wed, 20 May 2020 10:37:30 -0300 Subject: [PATCH] doc: document the new BFD profile commands Let the user know we have BFD profiles and how they work. Signed-off-by: Rafael Zalamena --- doc/user/bfd.rst | 57 ++++++++++++++++++++++++++++++++++++++++++++++-- 1 file changed, 55 insertions(+), 2 deletions(-) diff --git a/doc/user/bfd.rst b/doc/user/bfd.rst index 32397d1303..40c2247b5b 100644 --- a/doc/user/bfd.rst +++ b/doc/user/bfd.rst @@ -84,6 +84,20 @@ BFDd Commands Stops and removes the selected peer. + +.. index:: profile WORD +.. clicmd:: profile WORD + + Creates a peer profile that can be configured in multiple peers. + + +.. index:: no profile WORD +.. clicmd:: no profile WORD + + Deletes a peer profile. Any peer using the profile will have their + configurations reset to the default values. + + .. index:: show bfd [vrf NAME] peers [json] .. clicmd:: show bfd [vrf NAME] peers [json] @@ -101,8 +115,10 @@ BFDd Commands .. _bfd-peer-config: -Peer Configurations -------------------- +Peer / Profile Configuration +---------------------------- + +BFD peers and profiles share the same BFD session configuration commands. .. index:: detect-multiplier (2-255) .. clicmd:: detect-multiplier (2-255) @@ -154,6 +170,10 @@ Peer Configurations Enables or disables the peer. When the peer is disabled an 'administrative down' message is sent to the remote peer. + +BFD Peer Specific Commands +-------------------------- + .. index:: label WORD .. clicmd:: label WORD @@ -161,6 +181,21 @@ Peer Configurations later on other daemons to refer to a specific peer. +.. index:: profile BFDPROF +.. clicmd:: profile BFDPROF + + Configure peer to use the profile configurations. + + Notes: + + - Profile configurations can be overriden on a peer basis by specifying + new parameters in peer configuration node. + - Non existing profiles can be configured and they will only be applied + once they start to exist. + - If the profile gets updated the new configuration will be applied to all + peers with the profile without interruptions. + + .. _bfd-bgp-peer-config: BGP BFD Configuration @@ -292,6 +327,24 @@ Here are the available peer configurations: :: bfd + ! Configure a fast profile + profile fast + receive-interval 150 + transmit-interval 150 + ! + + ! Configure peer with fast profile + peer 192.168.0.6 + profile fast + no shutdown + ! + + ! Configure peer with fast profile and override receive speed. + peer 192.168.0.7 + profile fast + receive-interval 500 + no shutdown + ! ! configure a peer on an specific interface peer 192.168.0.1 interface eth0 -- 2.39.5