community.network.ce_vxlan_vap – Manages VXLAN virtual access point on HUAWEI CloudEngine Devices.

Note

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

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

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

Synopsis

• Manages VXLAN Virtual access point on HUAWEI CloudEngine Devices.

Parameters

Parameter	Choices/Defaults	Comments
bind_vlan_id string		Specifies the VLAN binding to a BD(Bridge Domain). The value is an integer ranging ranging from 1 to 4094.
bridge_domain_id string		Specifies a bridge domain ID. The value is an integer ranging from 1 to 16777215.
ce_vid string		When encapsulation is 'dot1q', specifies a VLAN ID in the outer VLAN tag. When encapsulation is 'qinq', specifies an outer VLAN ID for double-tagged packets to be received by a Layer 2 sub-interface. The value is an integer ranging from 1 to 4094.
encapsulation string	Choices: dot1q default untag qinq none	Specifies an encapsulation type of packets allowed to pass through a Layer 2 sub-interface.
l2_sub_interface string		Specifies an Sub-Interface full name, i.e. "10GE1/0/41.1". The value is a string of 1 to 63 case-insensitive characters, spaces supported.
pe_vid string		When encapsulation is 'qinq', specifies an inner VLAN ID for double-tagged packets to be received by a Layer 2 sub-interface. The value is an integer ranging from 1 to 4094.
state string	Choices: present ← absent	Determines whether the config should be present or not on the device.

Notes

Note

• This module requires the netconf system service be enabled on the remote device being managed.

• Recommended connection is netconf.

• This module also works with local connections for legacy playbooks.

Examples

- name: Vxlan vap 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: Create a mapping between a VLAN and a BD
    community.network.ce_vxlan_vap:
      bridge_domain_id: 100
      bind_vlan_id: 99
      provider: "{{ cli }}"

  - name: Bind a Layer 2 sub-interface to a BD
    community.network.ce_vxlan_vap:
      bridge_domain_id: 100
      l2_sub_interface: 10GE2/0/20.1
      provider: "{{ cli }}"

  - name: Configure an encapsulation type on a Layer 2 sub-interface
    community.network.ce_vxlan_vap:
      l2_sub_interface: 10GE2/0/20.1
      encapsulation: dot1q
      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: {'bind_intf_list': ['110GE2/0/20.1', '10GE2/0/20.2'], 'bind_vlan_list': ['99'], 'bridge_domain_id': '100'}
existing dictionary	verbose mode	k/v pairs of existing configuration Sample: {'bind_intf_list': ['10GE2/0/20.1', '10GE2/0/20.2'], 'bind_vlan_list': [], 'bridge_domain_id': '100'}
proposed dictionary	verbose mode	k/v pairs of parameters passed into module Sample: {'bind_vlan_id': '99', 'bridge_domain_id': '100', 'state="present"': None}
updates list / elements=string	always	commands sent to the device Sample: ['bridge-domain 100', 'l2 binding vlan 99']

Authors

• QijunPan (@QijunPan)