Docs4dev
Docs
ansible / 2.10 / collections / community / network / ce_vxlan_arp_module.html

community.network.ce_vxlan_arp – Manages ARP attributes of VXLAN on HUAWEI CloudEngine devices.

Note

This plugin is part of the community.network collection (version 1.3.0).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.ce_vxlan_arp.

Synopsis

  • Manages ARP attributes of VXLAN on HUAWEI CloudEngine devices.

Parameters

Parameter Choices/Defaults Comments
arp_collect_host
string
    Choices:
  • enable
  • disable
Enables EVN BGP or BGP EVPN to collect host information.
arp_suppress
string
    Choices:
  • enable
  • disable
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
    Choices:
  • enable
  • disable
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
    Choices:
  • enable
  • disable
Configures the local device as the route reflector (RR) and its peer as the client.
evn_server
string
    Choices:
  • enable
  • disable
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
    Choices:
  • bgp
  • none
Enables EVN BGP or BGP EVPN to advertise host information.
state
string
    Choices:
  • present ←
  • absent
Determines whether the config should be present or not on the device.
vbdif_name
string
Full name of VBDIF interface, i.e. Vbdif100.

Notes

Note

  • Recommended connection is network_cli.
  • This module also works with local connections for legacy playbooks.

Examples

- 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 }}"

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
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']


Authors

  • QijunPan (@QijunPan)

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/network/ce_vxlan_arp_module.html