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_vxlan_arp.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| arp_collect_host string |
| Enables EVN BGP or BGP EVPN to collect host information. |
| arp_suppress string |
| Enables ARP broadcast suppression in a BD. |
| bridge_domain_id string | Specifies a BD(bridge domain) ID. The value is an integer ranging from 1 to 16777215. | |
| evn_bgp string |
| Enables EVN BGP. |
| evn_peer_ip string | Specifies the IP address of an EVN BGP peer. The value is in dotted decimal notation. | |
| evn_reflect_client string |
| Configures the local device as the route reflector (RR) and its peer as the client. |
| evn_server string |
| Configures the local device as the router reflector (RR) on the EVN network. |
| evn_source_ip string | Specifies the source address of an EVN BGP peer. The value is in dotted decimal notation. | |
| host_collect_protocol string |
| Enables EVN BGP or BGP EVPN to advertise host information. |
| state string |
| Determines whether the config should be present or not on the device. |
| vbdif_name string | Full name of VBDIF interface, i.e. Vbdif100. |
Note
network_cli.local connections for legacy playbooks.- name: Vxlan arp module test
hosts: ce128
connection: local
gather_facts: no
vars:
cli:
host: "{{ inventory_hostname }}"
port: "{{ ansible_ssh_port }}"
username: "{{ username }}"
password: "{{ password }}"
transport: cli
tasks:
- name: Configure EVN BGP on Layer 2 and Layer 3 VXLAN gateways to establish EVN BGP peer relationships.
community.network.ce_vxlan_arp:
evn_bgp: enable
evn_source_ip: 6.6.6.6
evn_peer_ip: 7.7.7.7
provider: "{{ cli }}"
- name: Configure a Layer 3 VXLAN gateway as a BGP RR.
community.network.ce_vxlan_arp:
evn_bgp: enable
evn_server: enable
provider: "{{ cli }}"
- name: Enable EVN BGP on a Layer 3 VXLAN gateway to collect host information.
community.network.ce_vxlan_arp:
vbdif_name: Vbdif100
arp_collect_host: enable
provider: "{{ cli }}"
- name: Enable Layer 2 and Layer 3 VXLAN gateways to use EVN BGP to advertise host information.
community.network.ce_vxlan_arp:
host_collect_protocol: bgp
provider: "{{ cli }}"
- name: Enable ARP broadcast suppression on a Layer 2 VXLAN gateway.
community.network.ce_vxlan_arp:
bridge_domain_id: 100
arp_suppress: enable
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 | verbose mode | k/v pairs of configuration after module execution Sample: {'evn_bgp': 'enable', 'evn_peer_ip': ['7.7.7.7'], 'evn_source_ip': '6.6.6.6'} |
| existing dictionary | verbose mode | k/v pairs of existing configuration Sample: {'evn_bgp': 'disable', 'evn_peer_ip': [], 'evn_source_ip': None} |
| proposed dictionary | verbose mode | k/v pairs of parameters passed into module Sample: {'evn_bgp': 'enable', 'evn_peer_ip': '7.7.7.7', 'evn_source_ip': '6.6.6.6', 'state': 'present'} |
| updates list / elements=string | always | commands sent to the device Sample: ['evn bgp', 'source-address 6.6.6.6', 'peer 7.7.7.7'] |
© 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_vxlan_arp_module.html