You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

ce_bfd_session - Manages BFD session configuration on HUAWEI CloudEngine devices.¶

New in version 2.4.

Synopsis
Options
Examples
Return Values
- Status

Synopsis ¶

Manages BFD session configuration, creates a BFD session or deletes a specified BFD session on HUAWEI CloudEngine devices.

Options ¶

parameter	required	default	choices	comments
addr_type	no		ipv4	Specifies the peer IP address type.
create_type	no		static auto	BFD session creation mode, the currently created BFD session only supports static or static auto-negotiation mode.
dest_addr	no			Specifies the peer IP address bound to the BFD session.
out_if_name	no			Specifies the type and number of the interface bound to the BFD session.
session_name	yes			Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive characters without spaces.
src_addr	no			Indicates the source IP address carried in BFD packets.
state	no	present	present absent	Determines whether the config should be present or not on the device.
use_default_ip	no			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	no			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.

Examples ¶

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

Return Values ¶

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

name	description	returned	type	sample
changed	check to see if a change was made on the device	always	boolean	True
end_state	k/v pairs of configuration after module execution	always	dict	{'session': {'addrType': 'IPV4', 'vrfName': None, 'outIfName': '10GE1/0/1', 'useDefaultIp': 'true', 'createType': 'SESS_STATIC', 'srcAddr': None, 'destAddr': None, 'sessName': 'bfd_l2link'}}
existing	k/v pairs of existing configuration	always	dict	{'session': {}}
proposed	k/v pairs of parameters passed into module	always	dict	{'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	commands sent to the device	always	list	['bfd bfd_l2link bind peer-ip default-ip interface 10ge1/0/1']

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.