Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.ce_bfd_view.
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
| admin_down boolean |
| Enables the BFD session to enter the AdminDown state. By default, a BFD session is enabled. The default value is bool type. | |
| description string | Specifies the description of a BFD session. The value is a string of 1 to 51 case-sensitive characters with spaces. | ||
| detect_multi string | Specifies the local detection multiplier of a BFD session. The value is an integer that ranges from 3 to 50. | ||
| local_discr string | Specifies the local discriminator of a BFD session. The value is an integer that ranges from 1 to 16384. | ||
| min_rx_interval string | Specifies the minimum interval for sending BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds. | ||
| min_tx_interval string | Specifies the minimum interval for receiving BFD packets. The value is an integer that ranges from 50 to 1000, in milliseconds. | ||
| provider string | 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 |
| 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 string | Specifies the remote discriminator of a BFD session. The value is an integer that ranges from 1 to 4294967295. | ||
| session_name string / required | Specifies the name of a BFD session. The value is a string of 1 to 15 case-sensitive characters without spaces. | ||
| state string |
| Determines whether the config should be present or not on the device. | |
| tos_exp string | 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 string | 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. | ||
Note
netconf.local connections for legacy playbooks.- 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
community.network.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
community.network.ce_bfd_view:
session_name: atob
min_rx_interval: 500
state: present
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 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 / elements=string | always | commands sent to the device Sample: ['bfd atob', 'discriminator local 80', 'discriminator remote 800'] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/network/ce_bfd_view_module.html