ce_bfd_view – Manages BFD session view configuration on HUAWEI CloudEngine devices — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# ce_bfd_view – Manages BFD session view configuration on HUAWEI CloudEngine devices

New in version 2.4.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- Manages BFD session view configuration on HUAWEI CloudEngine devices.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
admin_down boolean | Choices: no ← yes | Enables the BFD session to enter the AdminDown state. By default, a BFD session is enabled. The default value is bool type.
description - |  | Specifies the description of a BFD session. The value is a string of 1 to 51 case-sensitive characters with spaces.
detect_multi - |  | Specifies the local detection multiplier of a BFD session. The value is an integer that ranges from 3 to 50.
local_discr - |  | Specifies the local discriminator of a BFD session. The value is an integer that ranges from 1 to 16384.
min_rx_interval - |  | Specifies the minimum interval for sending BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds.
min_tx_interval - |  | Specifies the minimum interval for receiving BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds.
provider - |  | A dict object containing connection details.
| host string / required |  | Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
| password string |  | Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for cli transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
| port integer | Default: "0 (use common port)" | Specifies the port to use when building the connection to the remote device. This value applies to either cli or netconf. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, netconf=22).
| ssh_keyfile path |  | Specifies the SSH key to use to authenticate the connection to the remote device. This argument is used for the cli transport. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
| transport string / required | Choices: cli ← netconf | Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh).
| username string |  | Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the CLI login. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
remote_discr - |  | Specifies the remote discriminator of a BFD session. The value is an integer that ranges from 1 to 4294967295.
session_name - / required |  | Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive characters without spaces.
state - | Choices: present ← absent | Determines whether the config should be present or not on the device.
tos_exp - |  | Specifies a priority for BFD control packets. The value is an integer ranging from 0 to 7. The default value is 7, which is the highest priority.
wtr_interval - |  | Specifies the WTR time of a BFD session. The value is an integer that ranges from 1 to 60, in minutes. The default value is 0.

## 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 view 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: Set the local discriminator of a BFD session to 80 and the remote discriminator to 800
        ce_bfd_view:
          session_name: atob
          local_discr: 80
          remote_discr: 800
          state: present
          provider: '{{ cli }}'

      - name: Set the minimum interval for receiving BFD packets to 500 ms
        ce_bfd_view:
          session_name: atob
          min_rx_interval: 500
          state: present
          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 | always | k/v pairs of configuration after module execution Sample: {'session': {'adminDown': 'false', 'createType': 'SESS_STATIC', 'description': None, 'detectMulti': '3', 'localDiscr': '80', 'minRxInt': None, 'minTxInt': None, 'remoteDiscr': '800', 'sessName': 'atob', 'tosExp': None, 'wtrTimerInt': None}}
existing dictionary | always | k/v pairs of existing configuration Sample: {'session': {'adminDown': 'false', 'createType': 'SESS_STATIC', 'description': None, 'detectMulti': '3', 'localDiscr': None, 'minRxInt': None, 'minTxInt': None, 'remoteDiscr': None, 'sessName': 'atob', 'tosExp': None, 'wtrTimerInt': None}}
proposed dictionary | always | k/v pairs of parameters passed into module Sample: {'admin_down': False, 'description': None, 'detect_multi': None, 'local_discr': 80, 'min_rx_interval': None, 'min_tx_interval': None, 'remote_discr': 800, 'session_name': 'atob', 'state': 'present', 'tos_exp': None, 'wtr_interval': None}
updates list | always | commands sent to the device Sample: ['bfd atob', 'discriminator local 80', 'discriminator remote 800']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- QijunPan (@QijunPan)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.