community.network.ce_vrf_interface – Manages interface specific VPN configuration on HUAWEI CloudEngine switches.
Note
This plugin is part of the community.network collection (version 3.0.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.ce_vrf_interface
.
Parameters
Parameter |
Comments |
---|---|
Manage the state of the resource. Choices:
|
|
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…. |
|
VPN instance, the length of vrf name is 1 ~ 31, i.e. “test”, but can not be |
Notes
Note
Ensure that a VPN instance has been created and the IPv4 address family has been enabled for the VPN instance.
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: 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"
community.network.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"
community.network.ce_vrf_interface:
vpn_interface: 40GE1/0/2
vrf: test
state: absent
provider: "{{ cli }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
check to see if a change was made on the device Returned: always Sample: true |
|
k/v pairs of end attributes on the interface Returned: verbose mode Sample: {“vpn_interface”: “40GE2/0/17”, “vrf”: “jss”} |
|
k/v pairs of existing attributes on the interface Returned: verbose mode Sample: {“vpn_interface”: “40GE2/0/17”, “vrf”: null} |
|
k/v pairs of parameters passed into module Returned: verbose mode Sample: {“state”: “present”, “vpn_interface”: “40GE2/0/17”, “vrf”: “jss”} |
|
command list sent to the device Returned: always Sample: [“ip binding vpn-instance jss”] |
Authors
Zhijin Zhou (@QijunPan)