mellanox.onyx.onyx_vxlan module – Configures Vxlan

Note

This module is part of the mellanox.onyx collection (version 1.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 mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_vxlan.

Synopsis

  • This module provides declarative management of Vxlan configuration on Mellanox ONYX network devices.

Parameters

Parameter

Comments

arp_suppression

boolean

A flag telling if to configure arp suppression.

Choices:

  • no ← (default)

  • yes

bgp

boolean

configure bgp on nve interface.

Choices:

  • no

  • yes ← (default)

loopback_id

string

loopback interface ID.

mlag_tunnel_ip

string

vxlan Mlag tunnel IP

nve_id

string / required

nve interface ID.

vni_vlan_list

string

Each item in the list has two attributes vlan_id, vni_id.

Notes

Note

  • Tested on ONYX evpn_dev.031.

  • nve protocol must be enabled.

Examples

- name: Configure Vxlan
  onyx_vxlan:
    nve_id: 1
    loopback_id: 1
    bgp: yes
    mlag-tunnel-ip: 100.0.0.1
    vni_vlan_list:
      - vlan_id: 10
        vni_id: 10010
      - vlan_id: 6
        vni_id: 10060
    arp_suppression: yes

Return Values

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

Key

Description

commands

list / elements=string

The list of configuration mode commands to send to the device.

Returned: always

Sample: [“interface nve 1”, “interface nve 1 vxlan source interface loopback 1”, “interface nve 1 nve controller bgp”, “interface nve 1 vxlan mlag-tunnel-ip 100.0.0.1”, “interface nve 1 nve vni 10010 vlan 10”, “interface nve 1 nve vni 10060 vlan 6”, “interface nve 1 nve neigh-suppression”, “interface vlan 6”, “interface vlan 10”]

Authors

  • Anas Badaha (@anasb)