Docs4dev
Docs
ansible / 2.5 / modules / ce_bfd_view_module.html

ce_bfd_view - Manages BFD session view configuration on HUAWEI CloudEngine devices.

New in version 2.4.

Synopsis

  • Manages BFD session view configuration on HUAWEI CloudEngine devices.

Parameters

Parameter Choices/Defaults Comments
admin_down Default:
no
Enables the BFD session to enter the AdminDown state. By default, a BFD session is enabled. The default value is bool type.
description Default:
None
Specifies the description of a BFD session. The value is a string of 1 to 51 case-sensitive characters with spaces.
detect_multi Default:
None
Specifies the local detection multiplier of a BFD session. The value is an integer that ranges from 3 to 50.
local_discr Default:
None
Specifies the local discriminator of a BFD session. The value is an integer that ranges from 1 to 16384.
min_rx_interval Default:
None
Specifies the minimum interval for sending BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds.
min_tx_interval Default:
None
Specifies the minimum interval for receiving BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds.
remote_discr Default:
None
Specifies the remote discriminator of a BFD session. The value is an integer that ranges from 1 to 4294967295.
session_name
required
Default:
None
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 Default:
None
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 Default:
None
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.

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
dict
always
k/v pairs of configuration after module execution

Sample:
{'session': {'localDiscr': '80', 'detectMulti': '3', 'description': None, 'adminDown': 'false', 'tosExp': None, 'createType': 'SESS_STATIC', 'wtrTimerInt': None, 'remoteDiscr': '800', 'minTxInt': None, 'minRxInt': None, 'sessName': 'atob'}}
existing
dict
always
k/v pairs of existing configuration

Sample:
{'session': {'localDiscr': None, 'detectMulti': '3', 'description': None, 'adminDown': 'false', 'tosExp': None, 'createType': 'SESS_STATIC', 'wtrTimerInt': None, 'remoteDiscr': None, 'minTxInt': None, 'minRxInt': None, 'sessName': 'atob'}}
proposed
dict
always
k/v pairs of parameters passed into module

Sample:
{'local_discr': 80, 'detect_multi': None, 'remote_discr': 800, 'description': None, 'admin_down': False, 'tos_exp': None, 'min_tx_interval': None, 'min_rx_interval': None, 'state': 'present', 'session_name': 'atob', 'wtr_interval': None}
updates
list
always
commands sent to the device

Sample:
['bfd atob', 'discriminator local 80', 'discriminator remote 800']


Status

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

Author

  • QijunPan (@CloudEngine-Ansible)

Hint

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/modules/ce_bfd_view_module.html