dellemc.enterprise_sonic.sonic_bfd module – Manage BFD configuration on SONiC
Note
This module is part of the dellemc.enterprise_sonic collection (version 3.0.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install dellemc.enterprise_sonic.
To use it in a playbook, specify: dellemc.enterprise_sonic.sonic_bfd.
New in dellemc.enterprise_sonic 2.1.0
Synopsis
This module provides configuration management of BFD for devices running SONiC
Parameters
Parameter |
Comments |
|---|---|
Specifies BFD configurations |
|
List of multi-hop sessions |
|
Number of missed packets to bring down a BFD session Default: |
|
Enables BFD session when set to true Choices:
|
|
Source IP address to be used for BFD sessions over the interface |
|
Minimum expected TTL on received packets Default: |
|
Specifies BFD peer as passive when set to true Choices:
|
|
BFD profile name |
|
Specifies peer receive interval Default: |
|
IP address used by the remote system for the BFD session |
|
Specifies peer transmit interval Default: |
|
Name of the configured VRF on the device |
|
List of preconfiguration profiles |
|
Number of missed packets to bring down a BFD session Default: |
|
Specifies echo interval Default: |
|
Echo mode is enabled when set to true Choices:
|
|
Enables BFD session when set to true Choices:
|
|
Minimum expected TTL on received packets Default: |
|
Specifies BFD peer as passive when set to true Choices:
|
|
BFD profile name |
|
Specifies peer receive interval Default: |
|
Specifies peer transmit interval Default: |
|
List of single-hop sessions |
|
Number of missed packets to bring down a BFD session Default: |
|
Specifies echo interval Default: |
|
Echo mode is enabled when set to true Choices:
|
|
Enables BFD session when set to true Choices:
|
|
Interface to use to contact peer |
|
Source IP address to be used for BFD sessions over the interface |
|
Specifies BFD peer as passive when set to true Choices:
|
|
BFD profile name |
|
Specifies peer receive interval Default: |
|
IP address used by the remote system for the BFD session |
|
Specifies peer transmit interval Default: |
|
Name of the configured VRF on the device |
|
The state of the configuration after module completion. Choices:
|
Notes
Note
Tested against Enterprise SONiC Distribution by Dell Technologies.
Supports
check_mode.
Examples
# Using Merged
#
# Before state:
# -------------
#
# sonic# show bfd profile
# (No "bfd profile" configuration present)
# sonic# show bfd peers
# (No "bfd peers" configuration present)
- name: Merge BFD configuration
dellemc.enterprise_sonic.sonic_bfd:
config:
profiles:
- profile_name: 'p1'
enabled: True
transmit_interval: 120
receive_interval: 200
detect_multiplier: 2
passive_mode: True
min_ttl: 140
echo_interval: 150
echo_mode: True
single_hops:
- remote_address: '196.88.6.1'
vrf: 'default'
interface: 'Ethernet20'
local_address: '1.1.1.1'
enabled: True
transmit_interval: 50
receive_interval: 80
detect_multiplier: 4
passive_mode: True
echo_interval: 110
echo_mode: True
profile_name: 'p1'
multi_hops:
- remote_address: '192.40.1.3'
vrf: 'default'
local_address: '3.3.3.3'
enabled: True
transmit_interval: 75
receive_interval: 100
detect_multiplier: 3
passive_mode: True
min_ttl: 125
profile_name: 'p1'
state: merged
# After state:
# ------------
#
# sonic# show bfd profile
# BFD Profile:
# Profile-name: p1
# Enabled: True
# Echo-mode: Enabled
# Passive-mode: Enabled
# Minimum-Ttl: 140
# Detect-multiplier: 2
# Receive interval: 200ms
# Transmission interval: 120ms
# Echo transmission interval: 150ms
# sonic# show bfd peers
# BFD Peers:
#
# peer 192.40.1.3 multihop local-address 3.3.3.3 vrf default
# ID: 989720421
# Remote ID: 0
# Passive mode: Enabled
# Profile: p1
# Minimum TTL: 125
# Status: down
# Downtime: 0 day(s), 0 hour(s), 1 min(s), 46 sec(s)
# Diagnostics: ok
# Remote diagnostics: ok
# Peer Type: configured
# Local timers:
# Detect-multiplier: 2
# Receive interval: 100ms
# Transmission interval: 75ms
# Echo transmission interval: ms
# Remote timers:
# Detect-multiplier: 3
# Receive interval: 1000ms
# Transmission interval: 1000ms
# Echo transmission interval: 0ms
#
# peer 196.88.6.1 local-address 1.1.1.1 vrf default interface Ethernet20
# ID: 1134635660
# Remote ID: 0
# Passive mode: Enabled
# Profile: p1
# Status: down
# Downtime: 0 day(s), 1 hour(s), 50 min(s), 48 sec(s)
# Diagnostics: ok
# Remote diagnostics: ok
# Peer Type: configured
# Local timers:
# Detect-multiplier: 4
# Receive interval: 80ms
# Transmission interval: 50ms
# Echo transmission interval: 110ms
# Remote timers:
# Detect-multiplier: 3
# Receive interval: 1000ms
# Transmission interval: 1000ms
# Echo transmission interval: 0ms
#
#
# Using replaced
#
# Before state:
# -------------
#
# sonic# show bfd profile
# BFD Profile:
# Profile-name: p1
# Enabled: True
# Echo-mode: Enabled
# Passive-mode: Enabled
# Minimum-Ttl: 140
# Detect-multiplier: 2
# Receive interval: 200ms
# Transmission interval: 120ms
# Echo transmission interval: 150ms
# Profile-name: p2
# Enabled: True
# Echo-mode: Disabled
# Passive-mode: Disabled
# Minimum-Ttl: 254
# Detect-multiplier: 3
# Receive interval: 300ms
# Transmission interval: 300ms
# Echo transmission interval: 300ms
- name: Replace BFD configuration
dellemc.enterprise_sonic.sonic_bfd:
config:
profiles:
- profile_name: 'p1'
transmit_interval: 144
- profile_name: 'p2'
enabled: False
transmit_interval: 110
receive_interval: 235
detect_multiplier: 5
passive_mode: True
min_ttl: 155
echo_interval: 163
echo_mode: True
state: replaced
# After state:
# ------------
#
# sonic# show bfd profile
# BFD Profile:
# Profile-name: p1
# Enabled: True
# Echo-mode: Enabled
# Passive-mode: Enabled
# Minimum-Ttl: 140
# Detect-multiplier: 2
# Receive interval: 200ms
# Transmission interval: 144ms
# Echo transmission interval: 150ms
# Profile-name: p2
# Enabled: False
# Echo-mode: Enabled
# Passive-mode: Enabled
# Minimum-Ttl: 155
# Detect-multiplier: 5
# Receive interval: 235ms
# Transmission interval: 110ms
# Echo transmission interval: 163ms
#
#
# Using overridden
#
# Before state:
# -------------
#
# sonic# show bfd peers
# BFD Peers:
#
# peer 192.40.1.3 multihop local-address 3.3.3.3 vrf default
# ID: 989720421
# Remote ID: 0
# Passive mode: Enabled
# Profile: p1
# Minimum TTL: 125
# Status: down
# Downtime: 0 day(s), 0 hour(s), 1 min(s), 46 sec(s)
# Diagnostics: ok
# Remote diagnostics: ok
# Peer Type: configured
# Local timers:
# Detect-multiplier: 2
# Receive interval: 100ms
# Transmission interval: 75ms
# Echo transmission interval: ms
# Remote timers:
# Detect-multiplier: 3
# Receive interval: 1000ms
# Transmission interval: 1000ms
# Echo transmission interval: 0ms
#
# peer 196.88.6.1 local-address 1.1.1.1 vrf default interface Ethernet20
# ID: 1134635660
# Remote ID: 0
# Passive mode: Enabled
# Profile: p1
# Status: down
# Downtime: 0 day(s), 1 hour(s), 50 min(s), 48 sec(s)
# Diagnostics: ok
# Remote diagnostics: ok
# Peer Type: configured
# Local timers:
# Detect-multiplier: 4
# Receive interval: 80ms
# Transmission interval: 50ms
# Echo transmission interval: 110ms
# Remote timers:
# Detect-multiplier: 3
# Receive interval: 1000ms
# Transmission interval: 1000ms
# Echo transmission interval: 0ms
- name: Override BFD configuration
dellemc.enterprise_sonic.sonic_bfd:
config:
single_hops:
- remote_address: '172.68.2.1'
vrf: 'default'
interface: 'Ethernet16'
local_address: '2.2.2.2'
enabled: True
transmit_interval: 60
receive_interval: 88
detect_multiplier: 6
passive_mode: True
echo_interval: 112
echo_mode: True
profile_name: 'p3'
multi_hops:
- remote_address: '186.42.1.2'
vrf: 'default'
local_address: '1.1.1.1'
enabled: False
transmit_interval: 85
receive_interval: 122
detect_multiplier: 4
passive_mode: False
min_ttl: 120
profile_name: 'p3'
state: overridden
# After state:
# ------------
#
# sonic# show bfd peers
# BFD Peers:
#
# peer 186.42.1.2 multihop local-address 1.1.1.1 vrf default
# ID: 989720421
# Remote ID: 0
# Passive mode: Disabled
# Profile: p3
# Minimum TTL: 120
# Status: down
# Downtime: 0 day(s), 0 hour(s), 1 min(s), 46 sec(s)
# Diagnostics: ok
# Remote diagnostics: ok
# Peer Type: configured
# Local timers:
# Detect-multiplier: 4
# Receive interval: 122ms
# Transmission interval: 85ms
# Echo transmission interval: ms
# Remote timers:
# Detect-multiplier: 3
# Receive interval: 1000ms
# Transmission interval: 1000ms
# Echo transmission interval: 0ms
#
# peer 172.68.2.1 local-address 2.2.2.2 vrf default interface Ethernet16
# ID: 1134635660
# Remote ID: 0
# Passive mode: Enabled
# Profile: p3
# Status: down
# Downtime: 0 day(s), 1 hour(s), 50 min(s), 48 sec(s)
# Diagnostics: ok
# Remote diagnostics: ok
# Peer Type: configured
# Local timers:
# Detect-multiplier: 6
# Receive interval: 88ms
# Transmission interval: 60ms
# Echo transmission interval: 112ms
# Remote timers:
# Detect-multiplier: 3
# Receive interval: 1000ms
# Transmission interval: 1000ms
# Echo transmission interval: 0ms
#
#
# Using deleted
#
# Before state:
# -------------
#
# sonic# show bfd profile
# BFD Profile:
# Profile-name: p1
# Enabled: True
# Echo-mode: Enabled
# Passive-mode: Enabled
# Minimum-Ttl: 140
# Detect-multiplier: 2
# Receive interval: 200ms
# Transmission interval: 120ms
# Echo transmission interval: 150ms
# sonic# show bfd peers
# BFD Peers:
#
# peer 192.40.1.3 multihop local-address 3.3.3.3 vrf default
# ID: 989720421
# Remote ID: 0
# Passive mode: Enabled
# Profile: p1
# Minimum TTL: 125
# Status: down
# Downtime: 0 day(s), 0 hour(s), 1 min(s), 46 sec(s)
# Diagnostics: ok
# Remote diagnostics: ok
# Peer Type: configured
# Local timers:
# Detect-multiplier: 2
# Receive interval: 100ms
# Transmission interval: 75ms
# Echo transmission interval: ms
# Remote timers:
# Detect-multiplier: 3
# Receive interval: 1000ms
# Transmission interval: 1000ms
# Echo transmission interval: 0ms
#
# peer 196.88.6.1 local-address 1.1.1.1 vrf default interface Ethernet20
# ID: 1134635660
# Remote ID: 0
# Passive mode: Enabled
# Profile: p1
# Status: down
# Downtime: 0 day(s), 1 hour(s), 50 min(s), 48 sec(s)
# Diagnostics: ok
# Remote diagnostics: ok
# Peer Type: configured
# Local timers:
# Detect-multiplier: 4
# Receive interval: 80ms
# Transmission interval: 50ms
# Echo transmission interval: 110ms
# Remote timers:
# Detect-multiplier: 3
# Receive interval: 1000ms
# Transmission interval: 1000ms
# Echo transmission interval: 0ms
- name: Delete BFD configuration
dellemc.enterprise_sonic.sonic_bfd:
config:
profiles:
- profile_name: 'p1'
enabled: True
transmit_interval: 120
receive_interval: 200
detect_multiplier: 2
passive_mode: True
min_ttl: 140
echo_interval: 150
echo_mode: True
single_hops:
- remote_address: '196.88.6.1'
vrf: 'default'
interface: 'Ethernet20'
local_address: '1.1.1.1'
multi_hops:
- remote_address: '192.40.1.3'
vrf: 'default'
local_address: '3.3.3.3'
state: deleted
# After state
# -----------
#
# sonic# show bfd profile
# BFD Profile:
# Profile-name: p1
# Enabled: True
# Echo-mode: Disabled
# Passive-mode: Disabled
# Minimum-Ttl: 254
# Detect-multiplier: 3
# Receive interval: 300ms
# Transmission interval: 300ms
# Echo transmission interval: 300ms
# sonic# show bfd peers
# (No "bfd peers" configuration present)
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration module invocation. Returned: when changed Sample: |
|
The generated configuration module invocation. Returned: when Sample: |
|
The configuration prior to the module invocation. Returned: always Sample: |
|
The set of commands pushed to the remote device. Returned: always Sample: |