community.general.onyx_bfd (0.1.1) — module

Configures BFD parameters

Authors: Sara Touqan (@sarato)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

This module provides declarative management of BFD protocol params on Mellanox ONYX network devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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

Inputs

    
vrf:
    description:
    - Specifys the vrf name.
    type: str

shutdown:
    description:
    - Administratively shut down BFD protection.
    type: bool

interval_min_rx:
    description:
    - Minimum desired receive rate, should be between 50 and 6000.
    type: int

iproute_next_hop:
    description:
    - Configures the ip route next hop, e.g 2.2.2.2.
    type: str

interval_multiplier:
    description:
    - Desired detection multiplier, should be between 3 and 50.
    type: int

iproute_mask_length:
    description:
    - Configures the mask length of the ip route network prefix, e.g 24.
    type: int

interval_transmit_rate:
    description:
    - Minimum desired transmit rate, should be between 50 and 60000.
    type: int

iproute_network_prefix:
    description:
    - Configures the ip route network prefix, e.g 1.1.1.1.
    type: str

Outputs

commands:
  description: The list of configuration mode commands to send to the device.
  returned: always
  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
  type: list