W3cubDocs

/Ansible

cisco.nxos.nxos_evpn_global module – Handles the EVPN control plane for VXLAN.

Note

This module is part of the cisco.nxos collection (version 9.4.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 cisco.nxos.

To use it in a playbook, specify: cisco.nxos.nxos_evpn_global.

New in cisco.nxos 1.0.0

Synopsis

  • Handles the EVPN control plane for VXLAN.

Parameters

Parameter

Comments

nv_overlay_evpn

boolean / required

EVPN control plane.

Choices:

  • false
  • true

Notes

Note

  • This module is not supported on Nexus 3000 series of switches.
  • Unsupported for Cisco MDS
  • For information on using CLI and NX-API see the :ref:`NXOS Platform Options guide <nxos_platform_options>`
  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`
  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

- cisco.nxos.nxos_evpn_global:
    nv_overlay_evpn: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

commands

list / elements=string

The set of commands to be sent to the remote device

Returned: always

Sample: ["nv overlay evpn"]

Authors

  • Gabriele Gerbino (@GGabriele)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/cisco/nxos/nxos_evpn_global_module.html