BFD

urls summary urls summary url get post patch put delete /rest/v1/running/bfd y n y n y /rest/v1/running/bfd/accelerate profile/{name} y y y n y /rest/v1/running/bfd/multi hop session/{dest addr}/{source addr}/{vrf} y y y n y /rest/v1/running/bfd/profile/{profile name} y y y n y /rest/v1/running/bfd/single hop session/{dest addr}/{vrf}/{interface} y y y n y /rest/v1/rpc/clear bfd counters n y n n n /rest/v1/rpc/show bfd brief n y n n n /rest/v1/rpc/show bfd counters n y n n n /rest/v1/rpc/show bfd peer n y n n n examples examples clear bfd session counters clear bfd session counters post https //{switch ip}/rest/v1/rpc/clear bfd counters show bfd session brief information show bfd session brief information post https //{switch ip}/rest/v1/rpc/show bfd brief {"vrf" "default"} show bfd session counters show bfd session counters post https //{switch ip}/rest/v1/rpc/show bfd counters show bfd peer show bfd peer post https //{switch ip}/rest/v1/rpc/show bfd peer {"dest addr" "10 169 1 1"} get all bfd information get all bfd information get https //{switch ip}/rest/v1/running/bfd create a bfd accelerate profile create a bfd accelerate profile post https //{switch ip}/rest/v1/running/bfd/accelerate profile { "name" "test", "detect multiplier" "15", "required receive interval" "1000", "desired transmit interval" "1000", "shutdown" "false" } create a bfd normal profile create a bfd normal profile post https //{switch ip}/rest/v1/running/bfd/profile { "profile name" "test333", "detect multiplier" 100, "required receive interval" 200, "desired transmit interval" 300, "shutdown" "true", "passive mode" "true", "required echo receive interval" 400, "desired echo transmit interval" 500, "minimum ttl" 123, "echo mode" "false" } create a bfd multi hop session create a bfd multi hop session post https //{switch ip}/rest/v1/running/bfd/multi hop session { "dest addr" "2 2 2 2", "source addr" "1 2 3 4", "vrf" "vrftest", "profile name" "test111", "detect multiplier" 3, "required receive interval" 300, "desired transmit interval" 300, "shutdown" "false", "minimum ttl" 254, "passive mode" "false" } create a bfd single hop session create a bfd single hop session post https //{switch ip}/rest/v1/running/bfd/single hop session { "dest addr" "3 3 3 3", "vrf" "vrftest", "interface" "ethernet15", "profile name" "testcreate", "detect multiplier" 253, "required receive interval" 400, "desired transmit interval" 500, "shutdown" "true", "passive mode" "true", "required echo receive interval" 600, "desired echo transmit interval" 700, "echo mode" "false" } properties descriptions properties descriptions bfd single hop sessions bfd single hop sessions tree diagrams + rw bfd + rw single hop session \[dest addr vrf interface] \| + rw dest addr \| + rw vrf \| + rw interface \| + rw source addr? \| + rw profile name? \| + rw detect multiplier? \| + rw required receive interval? \| + rw desired transmit interval? \| + rw shutdown? \| + rw passive mode? \| + rw required echo receive interval? \| + rw desired echo transmit interval? \| + rw echo mode? table of properties name required type/range description bfd m path only node, has no configurable value single hop session m (sub property of bfd) path only node, has no configurable value dest addr m a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of single hop session) bfd remote ip address vrf m "default" vrf name (sub property of single hop session) name of vrf instance the default vrf is "default" interface m ethernet name portchannel0000 9999 vlan1 4094 ethernet sub interface name portchannel sub interface name (sub property of single hop session) name of interface source addr o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of single hop session) bfd local ip address profile name o string (sub property of single hop session) bfd profile name detect multiplier o 2 255 (sub property of single hop session) peer detection multiplier default value 3 required receive interval o 10 60000 (sub property of single hop session) minimum desired control packet receive interval default value 300 desired transmit interval o 10 60000 (sub property of single hop session) minimum desired control packet transmit interval default value 300 shutdown o "true" "false" (sub property of single hop session) bfd state of profile or session default value "false" passive mode o "true" "false" (sub property of single hop session) don't attempt to start session establishment default value "false" required echo receive interval o 0 10 60000 (sub property of single hop session) minimum required echo packet receive interval default value 50 desired echo transmit interval o 10 60000 (sub property of single hop session) minimum desired echo packet transmission interval, this parameter only takes effect when configuring echo mode default value 50 echo mode o "true" "false" (sub property of single hop session) use echo packets to detect failures default value "false" bfd multiple hop sessions bfd multiple hop sessions tree diagrams + rw bfd + rw multi hop session \[dest addr source addr vrf] \| + rw dest addr \| + rw vrf \| + rw source addr \| + rw profile name? \| + rw detect multiplier? \| + rw required receive interval? \| + rw desired transmit interval? \| + rw shutdown? \| + rw minimum ttl? \| + rw passive mode? table of properties name required type/range description bfd m path only node, has no configurable value multi hop session m (sub property of bfd) path only node, has no configurable value dest addr m a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of multi hop session) bfd remote ip address vrf m "default" vrf name (sub property of multi hop session) name of vrf instance the default vrf is "default" source addr m a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of multi hop session) bfd local ip address profile name o string (sub property of multi hop session) bfd profile name detect multiplier o 2 255 (sub property of multi hop session) peer detection multiplier default value 3 required receive interval o 10 60000 (sub property of multi hop session) minimum desired control packet receive interval default value 300 desired transmit interval o 10 60000 (sub property of multi hop session) minimum desired control packet transmit interval default value 300 shutdown o "true" "false" (sub property of multi hop session) bfd state of profile or session default value "false" minimum ttl o 1 254 (sub property of multi hop session) minimum expected ttl on received packets default value 254 passive mode o "true" "false" (sub property of multi hop session) don't attempt to start session establishment default value "false" bfd normal profiles bfd normal profiles tree diagrams + rw bfd + rw profile \[profile name] \| + rw profile name \| + rw detect multiplier? \| + rw required receive interval? \| + rw desired transmit interval? \| + rw shutdown? \| + rw passive mode? \| + rw required echo receive interval? \| + rw desired echo transmit interval? \| + rw minimum ttl? \| + rw echo mode? table of properties name required type/range description bfd m path only node, has no configurable value profile m (sub property of bfd) path only node, has no configurable value profile name m string (sub property of profile) bfd profile name detect multiplier o 2 255 (sub property of profile) peer detection multiplier default value 3 required receive interval o 10 60000 (sub property of profile) minimum desired control packet receive interval default value 300 desired transmit interval o 10 60000 (sub property of profile) minimum desired control packet transmit interval default value 300 shutdown o "true" "false" (sub property of profile) bfd state of profile or session default value "false" passive mode o "true" "false" (sub property of profile) don't attempt to start session establishment default value "false" required echo receive interval o 0 10 60000 (sub property of profile) minimum required echo packet receive interval default value 50 desired echo transmit interval o 10 60000 (sub property of profile) minimum desired echo packet transmission interval, this parameter only takes effect when configuring echo mode default value 50 minimum ttl o 1 254 (sub property of profile) minimum expected ttl on received packets default value 254 echo mode o "true" "false" (sub property of profile) use echo packets to detect failures default value "false" bfd accelerate profiles bfd accelerate profiles tree diagrams + rw bfd + rw accelerate profile \[name] + rw name + rw detect multiplier? + rw required receive interval? + rw desired transmit interval? + rw shutdown? table of properties name required type/range description bfd m path only node, has no configurable value accelerate profile m (sub property of bfd) path only node, has no configurable value name m string (sub property of accelerate profile) bfd accelerate profile name detect multiplier o 1 15 (sub property of accelerate profile) peer detection multiplier default value 3 required receive interval o 1 1000 (sub property of accelerate profile) minimum desired control packet receive interval default value 300 desired transmit interval o 1 1000 (sub property of accelerate profile) minimum desired control packet transmit interval default value 300 shutdown o "true" "false" (sub property of accelerate profile) bfd state of profile or session default value "false" show bfd counters show bfd counters tree diagrams + x show bfd counters \| + w input \| | + w vrf? \| | + w (peer)? \| | + (single peer) \| | + w dest addr? \| | + w source addr? \| | + w multihop? \| | + w interface? \| + ro output \| + ro data? table of properties name required type/range description show bfd counters m path only node, has no configurable value show bfd counters information vrf o "default" vrf name (sub property of input) name of vrf instance default value "default" dest addr o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of input) bfd remote ip address source addr o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of input) bfd local ip address multihop o "true" "false" (sub property of input) bfd multihop default value "false" interface o ethernet name portchannel0000 9999 vlan1 4094 ethernet sub interface name portchannel sub interface name (sub property of input) name of interface data ro \<anydata> (sub property of output) show bfd brief show bfd brief tree diagrams + x show bfd brief \| + w input \| | + w vrf? \| + ro output \| + ro data? table of properties name required type/range description show bfd brief m path only node, has no configurable value show bfd peers information briefly vrf o "default" vrf name (sub property of input) name of vrf instance default value "default" data ro \<anydata> (sub property of output) show bfd peer show bfd peer tree diagrams + x show bfd peer \| + w input \| | + w vrf? \| | + w (peer)? \| | + (single peer) \| | + w dest addr? \| | + w source addr? \| | + w multihop? \| | + w interface? \| + ro output \| + ro data? table of properties name required type/range description show bfd peer m path only node, has no configurable value show bfd peer information vrf o "default" vrf name (sub property of input) name of vrf instance default value "default" dest addr o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of input) bfd remote ip address source addr o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of input) bfd local ip address multihop o "true" "false" (sub property of input) bfd multihop default value "false" interface o ethernet name portchannel0000 9999 vlan1 4094 ethernet sub interface name portchannel sub interface name (sub property of input) name of interface data ro \<anydata> (sub property of output) clear bfd counters clear bfd counters tree diagrams + x clear bfd counters + w input + w vrf? + w (peer)? + (single peer) + w dest addr? + w source addr? + w multihop? + w interface? table of properties name required type/range description clear bfd counters m path only node, has no configurable value clear bfd peer counters vrf o "default" vrf name (sub property of input) name of vrf instance default value "default" dest addr o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of input) bfd remote ip address source addr o a b c d xx\ xx\ xx\ xx\ xx\ xx\ xx\ xx (sub property of input) bfd local ip address multihop o "true" "false" (sub property of input) bfd multihop default value "false" interface o ethernet name portchannel0000 9999 vlan1 4094 ethernet sub interface name portchannel sub interface name (sub property of input) name of interface