Docs4dev
Docs
ansible / latest / collections / community / network / ce_evpn_global_module.html

community.network.ce_evpn_global – Manages global configuration of EVPN on HUAWEI CloudEngine switches.

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_evpn_global.

Synopsis

  • Manages global configuration of EVPN on HUAWEI CloudEngine switches.

Parameters

Parameter Choices/Defaults Comments
evpn_overlay_enable
string / required
    Choices:
  • enable
  • disable
Configure EVPN as the VXLAN control plane.

Notes

Note

  • Before configuring evpn_overlay_enable=disable, delete other EVPN configurations.
  • Recommended connection is network_cli.
  • This module also works with local connections for legacy playbooks.

Examples

- name: Evpn global 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: Configure EVPN as the VXLAN control plan
    community.network.ce_evpn_global:
      evpn_overlay_enable: enable
      provider: "{{ cli }}"

  - name: Undo EVPN as the VXLAN control plan
    community.network.ce_evpn_global:
      evpn_overlay_enable: disable
      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
always
k/v pairs of end attributes on the interface

Sample:
{'evpn_overlay_enable': 'enable'}
existing
dictionary
always
k/v pairs of existing attributes on the device

Sample:
{'evpn_overlay_enable': 'disable'}
proposed
dictionary
always
k/v pairs of parameters passed into module

Sample:
{'evpn_overlay_enable': 'enable'}
updates
list / elements=string
always
command list sent to the device

Sample:
['evpn-overlay enable']


Authors

  • Zhijin Zhou (@QijunPan)

© 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_evpn_global_module.html