community.general.ce_vxlan_vap (0.1.1) — module

Manages VXLAN virtual access point on HUAWEI CloudEngine Devices.

Authors: QijunPan (@QijunPan)

preview | supported by community

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1


Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

Manages VXLAN Virtual access point on HUAWEI CloudEngine Devices.

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
    ce_vxlan_vap:
      bridge_domain_id: 100
      bind_vlan_id: 99
      provider: "{{ cli }}"

  - name: Bind a Layer 2 sub-interface to a BD
    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
    ce_vxlan_vap:
      l2_sub_interface: 10GE2/0/20.1
      encapsulation: dot1q
      provider: "{{ cli }}"

Inputs

    
state:
    choices:
    - present
    - absent
    default: present
    description:
    - Determines whether the config should be present or not on the device.

ce_vid:
    description:
    - When I(encapsulation) is 'dot1q', specifies a VLAN ID in the outer VLAN tag. When
      I(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.

pe_vid:
    description:
    - When I(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.

bind_vlan_id:
    description:
    - Specifies the VLAN binding to a BD(Bridge Domain). The value is an integer ranging
      ranging from 1 to 4094.

encapsulation:
    choices:
    - dot1q
    - default
    - untag
    - qinq
    - none
    description:
    - Specifies an encapsulation type of packets allowed to pass through a Layer 2 sub-interface.

bridge_domain_id:
    description:
    - Specifies a bridge domain ID. The value is an integer ranging from 1 to 16777215.

l2_sub_interface:
    description:
    - 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.

Outputs

changed:
  description: check to see if a change was made on the device
  returned: always
  sample: true
  type: bool
end_state:
  description: k/v pairs of configuration after module execution
  returned: verbose mode
  sample:
    bind_intf_list:
    - 110GE2/0/20.1
    - 10GE2/0/20.2
    bind_vlan_list:
    - '99'
    bridge_domain_id: '100'
  type: dict
existing:
  description: k/v pairs of existing configuration
  returned: verbose mode
  sample:
    bind_intf_list:
    - 10GE2/0/20.1
    - 10GE2/0/20.2
    bind_vlan_list: []
    bridge_domain_id: '100'
  type: dict
proposed:
  description: k/v pairs of parameters passed into module
  returned: verbose mode
  sample:
    bind_vlan_id: '99'
    bridge_domain_id: '100'
    state="present": null
  type: dict
updates:
  description: commands sent to the device
  returned: always
  sample:
  - bridge-domain 100
  - l2 binding vlan 99
  type: list