community.network.ce_bfd_global – Manages BFD global configuration on HUAWEI CloudEngine devices.
community.network.ce_bfd_global – Manages BFD global configuration on HUAWEI CloudEngine devices.
Note
This plugin is part of the community.network collection (version 2.0.1).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.ce_bfd_global
.
Synopsis
- Manages BFD global configuration on HUAWEI CloudEngine devices.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
bfd_enable string |
|
Enables the global Bidirectional Forwarding Detection (BFD) function. |
damp_init_wait_time string |
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 string |
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 string |
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 string |
Specifies the default multicast IP address. The value ranges from 224.0.0.107 to 224.0.0.250. | |
delay_up_time string |
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 string |
|
Determines whether the config should be present or not on the device. |
tos_exp_dynamic string |
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 string |
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. |
Notes
Note
- This module requires the netconf system service be enabled on the remote device being managed.
- Recommended connection is
netconf
. - This module also works with
local
connections for legacy playbooks.
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
community.network.ce_bfd_global:
bfd_enable: enable
provider: '{{ cli }}'
- name: Set the default multicast IP address to 224.0.0.150
community.network.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
community.network.ce_bfd_global:
bfd_enable: enable
tos_exp_dynamic: 5
tos_exp_static: 6
state: present
provider: '{{ cli }}'
- name: Disable the global BFD function
community.network.ce_bfd_global:
bfd_enable: disable
provider: '{{ cli }}'
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
changed boolean |
always |
check to see if a change was made on the device
Sample: True |
end_state dictionary |
verbose mode |
k/v pairs of configuration after module execution
Sample: {'global': {'bfdEnable': 'true', 'dampInitWaitTime': '2000', 'dampMaxWaitTime': '12000', 'dampSecondWaitTime': '5000', 'defaultIp': '224.0.0.184', 'delayUpTimer': None, 'tosExp': '7', 'tosExpStatic': '7'}} |
existing dictionary |
verbose mode |
k/v pairs of existing configuration
Sample: {'global': {'bfdEnable': 'false', 'dampInitWaitTime': '2000', 'dampMaxWaitTime': '12000', 'dampSecondWaitTime': '5000', 'defaultIp': '224.0.0.184', 'delayUpTimer': None, 'tosExp': '7', 'tosExpStatic': '7'}} |
proposed dictionary |
verbose mode |
k/v pairs of parameters passed into module
Sample: {'bfd_enalbe': 'enable', 'damp_init_wait_time': None, 'damp_max_wait_time': None, 'damp_second_wait_time': None, 'default_ip': None, 'delayUpTimer': None, 'state': 'present', 'tos_exp_dynamic': None, 'tos_exp_static': None} |
updates list / elements=string |
always |
commands sent to the device
Sample: ['bfd'] |
Authors
- QijunPan (@QijunPan)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/ce_bfd_global_module.html