W3cubDocs

/Ansible

ce_bfd_global - Manages BFD global configuration on HUAWEI CloudEngine devices.

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis

Manages BFD global configuration on HUAWEI CloudEngine devices.

Options

parameter	required	default	choices	comments
bfd_enable	no		enable disable	Enables the global Bidirectional Forwarding Detection (BFD) function.
damp_init_wait_time	no			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_max_wait_time	no			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_second_wait_time	no			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.
default_ip	no			Specifies the default multicast IP address. The value ranges from 224.0.0.107 to 224.0.0.250.
delay_up_time	no			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.
state	no	present	present absent	Determines whether the config should be present or not on the device.
tos_exp_dynamic	no			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.
tos_exp_static	no			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.

Examples

- 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 }}'

Return Values

Common return values are documented here Return Values, the following are the fields unique to this module:

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

Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.

© 2012–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ce_bfd_global_module.html