Documentation

ce_vxlan_tunnel - Manages VXLAN tunnel configuration on HUAWEI CloudEngine devices.

New in version 2.4.

Synopsis

  • This module offers the ability to set the VNI and mapped to the BD, and configure an ingress replication list on HUAWEI CloudEngine devices.

Options

parameter required default choices comments
bridge_domain_id
no
Specifies a bridge domain ID. The value is an integer ranging from 1 to 16777215.
nve_mode
no
  • mode-l2
  • mode-l3
Specifies the working mode of an NVE interface.
nve_name
no
Specifies the number of an NVE interface. The value ranges from 1 to 2.
peer_list_ip
no
Specifies the IP address of a remote VXLAN tunnel endpoints (VTEP). The value is in dotted decimal notation.
protocol_type
no
  • bgp
  • null
The operation type of routing protocol.
source_ip
no
Specifies an IP address for a source VTEP. The value is in dotted decimal notation.
state
no present
  • present
  • absent
Manage the state of the resource.
vni_id
no
Specifies a VXLAN network identifier (VNI) ID. The value is an integer ranging from 1 to 16000000.

Examples

- name: vxlan tunnel 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: Make sure nve_name is exist, ensure vni_id and protocol_type is configured on Nve1 interface.
    ce_vxlan_tunnel:
      nve_name: Nve1
      vni_id: 100
      protocol_type: bgp
      state: present
      provider: "{{ cli }}"

Return Values

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

name description returned type sample
end_state k/v pairs of configuration after module execution always dict {'nve_mode"': 'mode-l3', 'nve_interface_name"': 'Nve1', 'source_ip': '0.0.0.0'}
changed check to see if a change was made on the device always boolean True
updates command sent to the device always list ['interface Nve1', 'mode l3']
proposed k/v pairs of parameters passed into module always dict {'nve_mode"': 'mode-l2', 'nve_interface_name"': 'Nve1', 'source_ip': '0.0.0.0'}
existing ['k/v pairs of existing rollback'] always dict {'nve_mode"': 'mode-l3', 'nve_interface_name"': 'Nve1', 'source_ip': '0.0.0.0'}


Status

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support

This module is community maintained without core committer oversight.

For more information on what this means please read Module Support

For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.