New in version 2.4.
parameter | required | default | choices | comments |
---|---|---|---|---|
admin_down |
no |
Enables the BFD session to enter the AdminDown state. By default, a BFD session is enabled. The default value is bool type.
|
||
description |
no |
Specifies the description of a BFD session. The value is a string of 1 to 51 case-sensitive characters with spaces.
|
||
detect_multi |
no |
Specifies the local detection multiplier of a BFD session. The value is an integer that ranges from 3 to 50.
|
||
local_discr |
no |
Specifies the local discriminator of a BFD session. The value is an integer that ranges from 1 to 16384.
|
||
min_rx_interval |
no |
Specifies the minimum interval for sending BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds.
|
||
min_tx_interval |
no |
Specifies the minimum interval for receiving BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds.
|
||
remote_discr |
no |
Specifies the remote discriminator of a BFD session. The value is an integer that ranges from 1 to 4294967295.
|
||
session_name |
yes |
Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive characters without spaces.
|
||
state |
no | present |
|
Determines whether the config should be present or not on the device.
|
tos_exp |
no |
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 |
no |
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.
|
- 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 }}'
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': {'localDiscr': '80', 'detectMulti': '3', 'description': None, 'adminDown': 'false', 'tosExp': None, 'createType': 'SESS_STATIC', 'wtrTimerInt': None, 'remoteDiscr': '800', 'minTxInt': None, 'minRxInt': None, 'sessName': 'atob'}} |
existing |
k/v pairs of existing configuration
|
always | dict | {'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 |
k/v pairs of parameters passed into module
|
always | dict | {'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 |
commands sent to the device
|
always | list | ['bfd atob', 'discriminator local 80', 'discriminator remote 800'] |
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.