community.general.ce_bfd_global (0.1.1) — module

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

Manages BFD global configuration on HUAWEI CloudEngine devices.

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- name: bfd global module test
  hosts: cloudengine
  connection: local
  gather_facts: no
  vars:
    cli:
      host: "{{ inventory_hostname }}"
      port: "{{ ansible_ssh_port }}"
      username: "{{ username }}"
      password: "{{ password }}"
      transport: cli

  tasks:
  - name: Enable the global BFD function
    ce_bfd_global:
      bfd_enable: enable
      provider: '{{ cli }}'

  - name: Set the default multicast IP address to 224.0.0.150
    ce_bfd_global:
      bfd_enable: enable
      default_ip: 224.0.0.150
      state: present
      provider: '{{ cli }}'

  - name: Set the priority of BFD control packets for dynamic and static BFD sessions
    ce_bfd_global:
      bfd_enable: enable
      tos_exp_dynamic: 5
      tos_exp_static: 6
      state: present
      provider: '{{ cli }}'

  - name: Disable the global BFD function
    ce_bfd_global:
      bfd_enable: disable
      provider: '{{ cli }}'

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines whether the config should be present or not on the device.

bfd_enable:
    choices:
    - enable
    - disable
    description:
    - Enables the global Bidirectional Forwarding Detection (BFD) function.

default_ip:
    description:
    - Specifies the default multicast IP address. The value ranges from 224.0.0.107 to
      224.0.0.250.

delay_up_time:
    description:
    - Specifies the delay before a BFD session becomes Up. The value is an integer ranging
      from 1 to 600, in seconds. The default value is 0, indicating that a BFD session
      immediately becomes Up.

tos_exp_static:
    description:
    - Indicates the priority of BFD control packets for static BFD sessions. The value
      is an integer ranging from 0 to 7. The default priority is 7, which is the highest
      priority of BFD control packets.

tos_exp_dynamic:
    description:
    - Indicates the priority of BFD control packets for dynamic BFD sessions. The value
      is an integer ranging from 0 to 7. The default priority is 7, which is the highest
      priority of BFD control packets.

damp_max_wait_time:
    description:
    - Specifies a maximum flapping suppression time for a BFD session. The value is an
      integer ranging from 1 to 3600000, in milliseconds. The default value is 15000.

damp_init_wait_time:
    description:
    - Specifies an initial flapping suppression time for a BFD session. The value is an
      integer ranging from 1 to 3600000, in milliseconds. The default value is 2000.

damp_second_wait_time:
    description:
    - Specifies a secondary flapping suppression time for a BFD session. The value is
      an integer ranging from 1 to 3600000, in milliseconds. The default value is 5000.

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: bool
end_state:
  description: k/v pairs of configuration after module execution
  returned: verbose mode
  sample:
    global:
      bfdEnable: 'true'
      dampInitWaitTime: '2000'
      dampMaxWaitTime: '12000'
      dampSecondWaitTime: '5000'
      defaultIp: 224.0.0.184
      delayUpTimer: null
      tosExp: '7'
      tosExpStatic: '7'
  type: dict
existing:
  description: k/v pairs of existing configuration
  returned: verbose mode
  sample:
    global:
      bfdEnable: 'false'
      dampInitWaitTime: '2000'
      dampMaxWaitTime: '12000'
      dampSecondWaitTime: '5000'
      defaultIp: 224.0.0.184
      delayUpTimer: null
      tosExp: '7'
      tosExpStatic: '7'
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: verbose mode
  sample:
    bfd_enalbe: enable
    damp_init_wait_time: null
    damp_max_wait_time: null
    damp_second_wait_time: null
    default_ip: null
    delayUpTimer: null
    state: present
    tos_exp_dynamic: null
    tos_exp_static: null
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - bfd
  type: list