On this page
ce_vxlan_vap - Manages VXLAN virtual access point on HUAWEI CloudEngine Devices.
New in version 2.4.
Synopsis
- Manages VXLAN Virtual access point on HUAWEI CloudEngine Devices.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
bind_vlan_id |
no |
Specifies the VLAN binding to a BD(Bridge Domain). The value is an integer ranging ranging from 1 to 4094.
|
||
bridge_domain_id |
no |
Specifies a bridge domain ID. The value is an integer ranging from 1 to 16777215.
|
||
ce_vid |
no |
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 |
no |
|
Specifies an encapsulation type of packets allowed to pass through a Layer 2 sub-interface.
|
|
l2_sub_interface |
no |
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 |
no |
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 |
no | present |
|
Determines whether the config should be present or not on the device.
|
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 papping 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 }}"
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
changed |
check to see if a change was made on the device
|
always | boolean | True |
end_state |
k/v pairs of configuration after module execution
|
verbose mode | dict | {'bind_intf_list': ['110GE2/0/20.1', '10GE2/0/20.2'], 'bind_vlan_list': ['99'], 'bridge_domain_id': '100'} |
existing |
k/v pairs of existing configuration
|
verbose mode | dict | {'bind_intf_list': ['10GE2/0/20.1', '10GE2/0/20.2'], 'bind_vlan_list': [], 'bridge_domain_id': '100'} |
proposed |
k/v pairs of parameters passed into module
|
verbose mode | dict | {'state="present"': None, 'bind_vlan_id': '99', 'bridge_domain_id': '100'} |
updates |
commands sent to the device
|
always | list | ['bridge-domain 100', 'l2 binding vlan 99'] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/ce_vxlan_vap_module.html