New in version 2.4.
parameter | required | default | choices | comments |
---|---|---|---|---|
state |
no | present |
|
Manage the state of the resource.
|
vpn_interface |
yes |
An interface that can binding VPN instance, i.e. 40GE1/0/22, Vlanif10. Must be fully qualified interface name. Interface types, such as 10GE, 40GE, 100GE, LoopBack, MEth, Tunnel, Vlanif....
|
||
vrf |
yes |
VPN instance, the length of vrf name is 1 ~ 31, i.e. "test", but can not be
_public_ . |
- name: VRF interface test hosts: cloudengine connection: local gather_facts: no vars: cli: host: "{{ inventory_hostname }}" port: "{{ ansible_ssh_port }}" username: "{{ username }}" password: "{{ password }}" transport: cli tasks: - name: "Configure a VPN instance for the interface" ce_vrf_interface: vpn_interface: 40GE1/0/2 vrf: test state: present provider: "{{ cli }}" - name: "Disable the association between a VPN instance and an interface" ce_vrf_interface: vpn_interface: 40GE1/0/2 vrf: test state: absent provider: "{{ cli }}"
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 end attributes on the interface
|
verbose mode | dict | {'vpn_interface': '40GE2/0/17', 'vrf': 'jss'} |
existing |
k/v pairs of existing attributes on the interface
|
verbose mode | dict | {'vpn_interface': '40GE2/0/17', 'vrf': None} |
proposed |
k/v pairs of parameters passed into module
|
verbose mode | dict | {'state': 'present', 'vpn_interface': '40GE2/0/17', 'vrf': 'jss'} |
updates |
command list sent to the device
|
always | list | ['ip binding vpn-instance jss'] |
Note
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.