New in version 2.4.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| addr_type |
| Specifies the peer IP address type. |
| create_type |
| BFD session creation mode, the currently created BFD session only supports static or static auto-negotiation mode. |
| dest_addr | Specifies the peer IP address bound to the BFD session. | |
| out_if_name | Specifies the type and number of the interface bound to the BFD session. | |
| session_name required | Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive characters without spaces. | |
| src_addr | Indicates the source IP address carried in BFD packets. | |
| state |
| Determines whether the config should be present or not on the device. |
| use_default_ip bool |
| Indicates the default multicast IP address that is bound to a BFD session. By default, BFD uses the multicast IP address 224.0.0.184. You can set the multicast IP address by running the default-ip-address command. The value is a bool type. |
| vrf_name | Specifies the name of a Virtual Private Network (VPN) instance that is bound to a BFD session. The value is a string of 1 to 31 case-sensitive characters, spaces not supported. When double quotation marks are used around the string, spaces are allowed in the string. The value _public_ is reserved and cannot be used as the VPN instance name. |
- name: bfd session 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: Configuring Single-hop BFD for Detecting Faults on a Layer 2 Link
ce_bfd_session:
session_name: bfd_l2link
use_default_ip: true
out_if_name: 10GE1/0/1
provider: '{{ cli }}'
- name: Configuring Single-Hop BFD on a VLANIF Interface
ce_bfd_session:
session_name: bfd_vlanif
dest_addr: 10.1.1.6
out_if_name: Vlanif100
provider: '{{ cli }}'
- name: Configuring Multi-Hop BFD
ce_bfd_session:
session_name: bfd_multi_hop
dest_addr: 10.1.1.1
provider: '{{ cli }}'
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 dict | always | k/v pairs of configuration after module execution Sample: {'session': {'addrType': 'IPV4', 'vrfName': None, 'outIfName': '10GE1/0/1', 'useDefaultIp': 'true', 'createType': 'SESS_STATIC', 'srcAddr': None, 'destAddr': None, 'sessName': 'bfd_l2link'}} |
| existing dict | always | k/v pairs of existing configuration Sample: {'session': {}} |
| proposed dict | always | k/v pairs of parameters passed into module Sample: {'src_addr': None, 'out_if_name': '10GE1/0/1', 'state': 'present', 'dest_addr': None, 'vrf_name': None, 'create_type': None, 'session_name': 'bfd_l2link', 'use_default_ip': True, 'addr_type': None} |
| updates list | always | commands sent to the device Sample: ['bfd bfd_l2link bind peer-ip default-ip interface 10ge1/0/1'] |
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
This module is flagged as community which means that it is maintained by the Ansible Community. See Module Maintenance & Support for more info.
For a list of other modules that are also maintained by the Ansible Community, see here.
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.7/modules/ce_bfd_session_module.html