BFD Commands
The following topics cover the BFD interface and protocol commands.
interface dataplane <if_name> bfd template <template_name>
Associates a BFD parameter template with a single-hop BFD session, which originates from the specified interface.
If a BFD parameter template is not specified, minimum-tx is taken as 300, minimum-rx is taken as 300, and the multiplier is taken as 3.
- dataplane if_name
- Specifies name of a data plane interface in the format of dp0xy.
- template template_name
- Specifies name of a BFD parameter template.
Configuration mode
interface {
dataplane if_name {
bfd {
template template_name
}
}
}
Use this command to associate a BFD parameter template with a single-hop BFD session, which is specified by the interface name.
Use the set form of the command to associate a BFD parameter template with a single-hop BFD session.
Use the delete form of the command to remove a BFD parameter template that is associated with a single-hop BFD session.
Use the show form of the command to display the BFD parameter template configured for the interface.
The following example shows how to associate a BFD parameter template called test
with a data plane interface called dp0s7
for a single-hop BFD session.
vyatta@vyatta#set interface dataplane dp0s7 bfd template test
interface dataplane <if_name> ip ospf fall-over bfd
Initiates a BFD session for all OSPFv2 neighbors on a physical interface.
BFD for OSPFv2 is disabled by default.
- dataplane if_name
- Specifies name of a data plane interface in the format of dp0xy.
Configuration mode
interface dataplane if_name {
ip {
ospf {
fall-over {
bfd
}
}
}
}
Use this command to initiate a BFD session for all OSPFv2 neighbors on a physical interface.
Use the set version of the command to initiate a BFD session for all OSPFv2 neighbors on a physical interface.
Use the delete version of the command to delete a BFD session for all OSPFv2 neighbors on a physical interface.
Use the show form of the command to display the BFD parameter template configured for the interface.
The following example shows how to initiate a BFD session for all OSPFv2 neighbors on a physical interface called dp0s4
.
vyatta@vyatta#set interface dataplane dp0s4 ip ospf fall-over bfd
interface dataplane <if_name> ipv6 ospfv3 fall-over bfd
Initiates a BFD session for all OSPFv3 neighbors on a physical interface.
BFD for OSPFv3 is disabled by default.
- dataplane if_name
- Specifies name of a data plane interface in the format of dp0xy.
Configuration mode
interface dataplane if_name {
ipv6 {
ospfv3 {
fall-over {
bfd
}
}
}
}
Use this command to initiate a BFD session for all OSPFv3 neighbors on a physical interface.
Use the set version of the command to initiate a BFD session for all OSPFv3 neighbors on a physical interface.
Use the delete version of the command to delete a BFD session for all OSPFv3 neighbors on a physical interface.
Use the show form of the command to display the BFD parameter template configured for the interface.
The following example shows how to initiate a BFD session for all OSPFv3 neighbors on a physical interface called dp0s4
.
vyatta@vyatta#set interface dataplane dp0s4 ipv6 ospf fall-over bfd
interface dataplane <if_name> vif <vif_id> bfd template <template-name>
Associates a BFD parameter template with a BFD session, which is specified by the virtual interface name.
If a BFD parameter template is not specified, minimum-tx is taken as 300, minimum-rx is taken as 300, and the multiplier is taken as 3.
- dataplane if_name
- Specifies name of a data plane interface in the format of dp0xy.
- vif vif_id
- Specifies a VLAN identifier for a virtual interface. The identifier ranges from 0 through 4094.
- template template_name
- Specifies name of a BFD parameter template.
Configuration mode
interface {
dataplane if_name {
vif vif_id {
bfd {
template template_name
}
}
}
}
Use this command to associate a BFD parameter template with a single-hop BFD session that is specified by the virtual interface name.
Use the set form of the command to associate a BFD parameter template with a BFD session.
Use the delete form of the command to remove a BFD parameter template that is associated with a BFD session.
Use the show form of the command to display the BFD parameter template configured for the interface.
The following example shows how to associate a BFD parameter template called test
with a virtual interface vif 10
for a BFD session.
vyatta@vyatta# set interface dataplane dp0s4 vif 10 bfd template test
interfaces dataplane <if_name> vif <vif-id> ip ospf fall-over bfd
Initiates a BFD session for all OSPFv2 neighbors on a virtual interface.
BFD for OSPFv2 is disabled by default.
- dataplane if_name
- Specifies name of a data plane interface.
- vif vif-id
- Specifies a VLAN identifier for a virtual interface. The identifier ranges from 0 through 4094.
Configuration mode
interface dataplane if_name {
vif vif-id {
ip {
ospf {
fall-over {
bfd
}
}
}
}
}
Use this command to initiate a BFD session for all OSPFv2 neighbors on a virtual interface.
Use the set version of the command to initiate a BFD session for all OSPFv2 neighbors on a virtual interface.
Use the delete version of the command to delete a BFD session for all OSPFv2 neighbors on a virtual interface.
Use the show form of the command to display the BFD parameter template configured for the interface.
The following example shows how to initiate a BFD session for all OSPFv2 neighbors on a virtual interface with a VLAN identifier of 51
.
vyatta@vyatta#set interfaces dataplane dp0s4 vif 51 ip ospf fall-over bfd
interfaces dataplane <if_name> vif <vif-id> ipv6 ospfv3 fall-over bfd
Initiates a BFD session for all OSPFv3 neighbors on a virtual interface.
BFD for OSPFv3 is disabled by default.
- dataplane if_name
- Specifies name of a data plane interface in the format of dp0xy.
- vif vif-id
- Specifies a VLAN identifier for a virtual interface. The identifier ranges from 0 through 4094.
Configuration mode
interface dataplane if_name{
vif vif-id {
ipv6 {
ospfv3 {
fall-over {
bfd
}
}
}
}
}
Use this command to initiate a BFD session for all OSPFv3 neighbors on a virtual interface.
Use the set version of the command to initiate a BFD session for all OSPFv3 neighbors on a virtual interface.
Use the delete version of the command to delete a BFD session for all OSPFv3 neighbors on a virtual interface.
Use the show form of the command to display the BFD parameter template configured for the interface.
The following example shows how to initiate a BFD session for all OSPFv3 neighbors on a virtual interface with a VLAN identifier of 51
.
vyatta@vyatta#set interfaces dataplane dp0s4 vif 51 ipv6 ospfv3 fall-over bfd
protocols bfd destination <destination_ip_address> source <source_ip_address> helper-session
Initiates a BFD session with a neighboring system with which the source system shares a static route, however the neighboring system does not share a static route with the source system.
The BFD helper session is disabled by default.
- destination_ip_address
- IPv4 or IPv6 address of the destination system.
- source_ip_address
- IPv4 or IPv6 address of the source system.
Configuration mode
protocols {
bfd {
destination destination_ip_address {
source source_ip_address {
helper-session
}
}
}
}
Use this command to monitor a BFD session initiated by the peer, where only the peer has a static client.
Use the set form of the command to initiate a BFD session with a neighboring system.
Use the delete form of the command to delete a BFD session with a neighboring system.
Use the show form of the command to display the details of a BFD session.
source any
parameter is not supported for the helper session command. The following example shows how to set a BFD session with a neighboring system with which the source system shares a static route, however the neighboring system does not share a static route with the source system. The interface address of the source is 10.37.99.161
and the interface address of the destination system is 10.37.99.162
.
vyatta@vyatta#set protocols bfd destination 10.37.99.162 source 10.37.99.161 helper-session
protocols bfd destination <destination_ip_address> source <source_ip_address> template <template_name>
Associates a BFD parameter template with a BFD session, which is specified by the source and destination address template.
If the BFD parameter template is not specified, minimum-tx is taken as 300, minimum-rx is taken as 300, and the multiplier is taken as 3.
- destination_ip_address
- IPv4 or IPv6 address of a destination system.
- source_ip_address
- IPv4 or IPv6 address of a source system.
- any
- Associates a BFD template with all BFD sessions to the destination system.
- template template_name
- Specifies name of a BFD parameter template.
Configuration Mode
protocols {
bfd {
destination destination_ip_address {
source source_ip_address | any }
{
template template_name
}
}
}
Use this command to associate a BFD parameter template with a BFD session, which is specified by the source and destination IP addresses.
Use the set form of the command to associate a BFD parameter template with a BFD session.
Use the delete form of the command to remove a BFD parameter template associated with a BFD session.
Use the show form of the command to display the details of a BFD session.
The following example shows how to associate a BFD parameter template called test
with a BFD source and destination address template.
vyatta@vyatta#set protocols bfd destination 10.37.99.162 source 10.37.99.161 template test
The following example shows how to associate a BFD parameter template called test
with a BFD session by using the any
parameter. The any
parameter associates the BFD parameter template with all BFD sessions with destination 10.37.99.162
.
vyatta@vyatta#set protocols bfd destination 10.37.99.162 source any template test
protocols bfd template <template_name>
Creates a BFD template that specifies the minimum-rx value, minimum-tx value, multiplier value, and authentication type for the BFD session.
If a BFD parameter template is not specified, minimum-tx is taken as 300, minimum-rx is taken as 300, and the multiplier is taken as 3.
- template template_name
- Specifies name of a BFD parameter template.
- minimum-rx minimum-rx_value
- Specifies the required minimum receiving interval for the BFD session. The interval ranges 20 through 10000 ms.
- minimum-tx minimum-tx_value
- Specifies a minimum transmission interval for the BFD session. The interval ranges 20 through 10000 ms.
- multiplier multiplier_value
- Specifies a multiplier for the BFD session. The mutiplier ranges 1 through 100.
- key key_string
- Specifies an alphanumeric password.
Configuration mode
bfd
{
template template_name {
auth {
simple {
key key_string
}
}
minimum-rx minimum-rx_value
minimum-tx minimum-tx_value
multiplier multiplier_value
}
}
Use the command to create a BFD parameter template that specifies the minimum-rx value, minimum-tx value, multiplier value, and authentication type for the BFD session.
Use the set form of the command to set a BFD template that specifies the minimum-rx value, minimum-tx value, multiplier value, and authentication type for the BFD session.
Use the delete form of the command to delete a BFD template.
Use the show form of the command to display the details of a BFD session.
The following example shows how to set the values for a BFD template called test
.
vyatta@vyatta#set protocols bfd template test multiplier 3
vyatta@vyatta#set protocols bfd template test minimum-rx 300
vyatta@vyatta#set protocols bfd template test minimum-tx 300
vyatta@vyatta#set protocols bfd template test auth simple key lotr
protocols bgp <asn> neighbor <ip_address> fall-over bfd
Initiates a BFD session with a neighboring peer with which the system already shares a BGP session.
BFD for BGP is disabled by default.
- asn
- Number of the AS in which a system resides.
- neighbor ip_address
- Specifies an IPv4 or IPv6 address of a peer system with which BFD is set up.
Configuration mode
bgp {
asn neighbor ip_address {
fall-over {
bfd
}
}
}
Use this command to initiate a BFD session with a neighboring peer with which the system already shares a BGP session.
Use the set form of the command to initiate a BFD session with a neighboring peer with which the system already shares a BGP session.
Use the delete form of the command to delete a BFD session with a neighboring peer with which the system already shares a BGP session.
Use the show form of the command to display the details of a BFD session.
The following example shows how to initiate a BFD session with a neighboring peer whose interface address facing the system is 10.37.99.162
. The two systems share a BGP session.
vyatta@vyatta# set protocols bgp 100 neighbor 10.37.99.162 fall-over bfd
protocols ospf area <area-id> virtual-link <dest_router_id> fall-over bfd
Initiates a BFD session for two OSPFv2 neighbors on a virtual link.
BFD for OSPFv2 is disabled by default.
- area area-id
- Specifies the identifier of an OSPFv2 area configured. The identifier is an IP address or a decimal value.
- dest_router_id
- Destination router identifier of an OSPFv2 process. The identifier is an IPv4 address.
Configuration mode
protocols {
ospf {
area area-id {
virtual-link dest_router_id {
fall-over bfd
}
}
}
}
Use this command to initiate a BFD session for two OSPFv2 neighbors on a virtual link.
Use the set form of the command to initiate a BFD session for two OSPFv2 neighbors on a virtual link.
Use the delete form of the command to delete the BFD session for two OSPFv2 neighbors on a virtual link.
Use the show form of the command to display the details of a BFD session.
The following example shows how to initiate a BFD session for two OSPFv2 neighbors on a virtual link. The destination router identifier is 2.2.2.2
.
vyatta@vyatta# set protocols ospf area 1 virtual-link 2.2.2.2 fall-over bfd
protocols ospfv3 area <area-id> virtual-link <dest_router_id> fall-over bfd
Initiates a BFD session for two OSPFv3 neighbors on a virtual link.
BFD for OSPFv3 is disabled by default.
- area area-id
- Specifies the identifier of an OSPFv3 area configured. The identifier is an IP address or a decimal value.
- dest_router_id
- Destination router identifier of an OSPFv3 process. The identifier is an IPv4 address.
Configuration mode
protocols {
ospfv3 {
area area-id {
virtual-link dest_router_id {
fall-over bfd
}
}
}
}
Use this command to initiate a BFD session for two OSPFv3 neighbors on a virtual link.
Use the set form of the command to initiate a BFD session for two OSPFv3 neighbors on a virtual link.
Use the delete form of the command to delete the BFD session for two OSPFv3 neighbors on a virtual link.
Use the show form of the command to display the details of a BFD session.
The following example shows how to initiate a BFD session for two OSPFv3 neighbors on a virtual link. The destination router identification is 2.2.2.2
.
vyatta@vyatta#set protocols ospfv3 area 1 virtual-link 2.2.2.2 fall-over bfd
protocols static route <destination_ipv4_address> next-hop <nexthop_ipv4_address> fall-over bfd
Initiates a BFD session between two BFD peers on a static route by using IPv4 addressing.
BFD for static routes is disabled by default.
- destination_ipv4_address
- IPv4 address of the destination system.
- nexthop_ipv4_address
- IPv4 address of the next-hop system enroute to the destination system.
Configuration mode
protocols {
static {
route destination_ipv4_address {
next-hop nexthop_ipv4_address {
fall-over {
bfd
}
}
}
}
}
Use this command to set up a BFD session between two systems on a static route by using IPv4 addressing.
Use the set form of this command to initiate a BFD session between two systems on a static route by using IPv4 addressing.
Use the delete form of this command to remove a BFD session between two systems on a static route by using IPv4 addressing.
Use the show form of this command to view the details of a BFD session.
The following example shows how to initiate a BFD session on a system that is connected to another system on a static route by using IPv4 addressing. The loopback address of the destination system is 2.2.2.2/32
and the interface address of the destination system is 10.10.10.2
.
vyatta@vyatta#set protocols static route 2.2.2.2/32 next-hop 10.10.10.2 fall-over bfd
protocols static route6 <destination_ipv6_address> next-hop <nexthop_ipv6_address> fall-over bfd
Initiates a BFD session between two systems on a static route by using IPv6 addressing.
BFD for static routes is disabled by default.
- destination_ipv6_address
- IPv6 address of the destination system.
- nexthop_ipv6_address
- IPv6 address of the next-hop system enroute to the destination system.
Configuration mode
protocols {
static {
route6 destination_ipv6_address {
next-hop nexthop_ipv6_address {
fall-over {
bfd
}
}
}
}
}
Use this command to set up a BFD session between two systems on a static route by using IPv6 addressing.
Use the set form of this command to initiate a BFD session between two systems on a static route by using IPv6 addressing.
Use the delete form of this command to remove a BFD session between two systems on a static route by using IPv6 addressing.
Use the show form of this command to view the details of a BFD session.
The following example shows how to initiate a BFD session on a system that is connected to another system on a static route by using IPv6 addressing. The loopback address of the destination system is 2:2:2::2/128
and the interface address of the destination system is 10:10:10::20
.
vyatta@vyatta#set protocols static route6 2:2:2::2/128 next-hop 10:10:10::20 fall-over bfd
show bfd session interface <if_name>
Displays BFD session information for a system interface.
- interface if_name
- Specifies a data plane interface name.
- detail
- Specifies a detailed report for the BFD session.
- destination_ipv4_address
- IPv4 address of the destination of the BFD session.
- destination_ipv6_address
- IPv6 address of the destination of the BFD session.
Operational mode.
Use the command to display the BFD session on a system interface.
The
show bfd session interface command for the
dp0s6
interface displays the following information:
vyatta@vyatta:~$ show bfd session interface ifname dp0s6
Interface: dp0s6 state: Up
Sess-Idx Remote-Disc Lower-Layer Sess-Type Sess-State UP-Time Remote-Addr
IPv4 Sessions:
1 0 IPv4 Single-Hop Down 00:00:00 20.20.20.20/32
vyatta@vyatta:~$ show bfd session interface ifname dp0s6 detail
======================================================
Session Interface Name : dp0s6 Session Index : 1
Lower Layer : IPv4 Version : 1
Session Type : Single Hop Session State : Down
Local Discriminator : 1 Local Address : 20.20.20.10/32
Remote Discriminator : 0 Remote Address : 20.20.20.20/32
Local Port : 49152 Remote Port : 3784
Diagnostics : None
Configured parameters :
Template name : NULL Template applied at : Default
Min Tx : 300 Min Rx : 300
Multiplier: 3
Bfd authentication : Disabled BFD GTSM : Disabled
Negotiated parameters :
Neg Tx : 300 Neg Rx : 300
Multiplier: 10
Counters values:
Pkt In : 0000000000000000 Pkt Out : 0000000000000572
Echo Out : 0000000000000000
Session down time : 00:00:00 Session up time : 00:00:00
UP Count : 0
Registered Clients:
Static
----------------------------------------------------------
Output field | Description |
---|---|
Session Interface Name | Interface for which you are running the command. |
Session Index | Local discriminator for the session. |
Lower Layer | IPv4 or IPv6. |
Version | Version of the lower layer. |
Session Type | Single hop or multiple hop. |
Session State | State of the BFD session: Admin-Down, Down, Init or Up. |
Local Discriminator | Local discriminator for the session. |
Local Address | Local address for the session. |
Remote Discriminator | Remote discriminator for the session. |
Remote Address | Remote address for the session. |
Local Port | Source UDP port for the session. |
Remote Port | Standard UDP Destination port |
Diagnostics | Diagnostics for the current state of the session. |
Configured Parameters | |
Template name | Name for the parameter template. |
Template applied at | Protocol or interface where the parameter template is applied. |
Min Tx | Required minimum transmission time for the BFD session. |
Min Rx | Required minimum receiver time for the BFD session. |
Multiplier | Detection multiplier for the BFD session. |
Bfd GTSM Disabled | Generalized TTL security mechanism (disabled for now). |
Bfd Authentication Disabled | BFD authentication type supported. |
Negotiated Parameters | |
Neg Tx | Negotiated transmission time. |
Neg Rx | Negotiated receiver time. |
Counters values | |
Pkt In | IPv4 asynchronous packet receiver count. |
Pkt Out | IPv4 asynchronous packet transmission count. |
Echo Out | IPv4 Echo packet transmission count. |
Session down time | Time since the BFD session went DOWN. |
Session up time | Time since the BFD session went UP. |
UP Count | Number of times the BFD session has reached the UP state. |
Registered Clients | Client or clients registered for the BFD service. |