mellanox.onyx.onyx_bfd – Configures BFD parameters
Note
This plugin is part of the mellanox.onyx collection (version 1.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 mellanox.onyx.
To use it in a playbook, specify: mellanox.onyx.onyx_bfd.
New in version 0.2.0: of mellanox.onyx
Synopsis
- This module provides declarative management of BFD protocol params on Mellanox ONYX network devices.
Parameters
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| interval_min_rx
integer
|
Minimum desired receive rate, should be between 50 and 6000.
|
|
| interval_multiplier
integer
|
Desired detection multiplier, should be between 3 and 50.
|
|
| interval_transmit_rate
integer
|
Minimum desired transmit rate, should be between 50 and 60000.
|
|
| iproute_mask_length
integer
|
Configures the mask length of the ip route network prefix, e.g 24.
|
|
| iproute_network_prefix
string
|
Configures the ip route network prefix, e.g 1.1.1.1.
|
|
| iproute_next_hop
string
|
Configures the ip route next hop, e.g 2.2.2.2.
|
|
| shutdown
boolean
|
|
Administratively shut down BFD protection.
|
| vrf
string
|
Specifys the vrf name.
|
Examples
- name: Configures bfd
onyx_bfd:
shutdown: yes
vrf: 5
interval_min_rx: 55
interval_multiplier: 8
interval_transmit_rate: 88
iproute_network_prefix: 1.1.1.0
iproute_mask_length: 24
iproute_next_hop: 3.2.2.2
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| commands
list / elements=string
|
always |
The list of configuration mode commands to send to the device.
Sample:
['ip bfd shutdown', 'no ip bfd shutdown', 'ip bfd shutdown vrf <vrf_name>', 'no ip bfd shutdown vrf <vrf_name>', 'ip bfd vrf <vrf_name> interval min-rx <min_rx> multiplier <multiplier> transmit-rate <transmit_rate> force', 'ip bfd interval min-rx <min_rx> multiplier <multiplier> transmit-rate <transmit_rate> force', 'ip route vrf <vrf_name> <network_prefix>/<mask_length> <next_hop> bfd', 'ip route <network_prefix>/<mask_length> <next_hop> bfd']
|
Authors
- Sara Touqan (@sarato)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/mellanox/onyx/onyx_bfd_module.html