Docs4dev
Docs
ansible / 2.4 / ce_vrf_af_module.html

ce_vrf_af - Manages VPN instance address family on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis

  • Manages VPN instance address family of HUAWEI CloudEngine switches.

Options

parameter required default choices comments
evpn
 no
  • true
  • false
Is extend vpn or normal vpn.
route_distinguisher
 no
VPN instance route distinguisher,the RD used to distinguish same route prefix from different vpn. The RD must be setted before setting vpn_target_value.
state
 no present
  • present
  • absent
Manage the state of the af.
vpn_target_state
 no
  • present
  • absent
Manage the state of the vpn target.
vpn_target_type
 no
  • export_extcommunity
  • import_extcommunity
VPN instance vpn target type.
vpn_target_value
 no
VPN instance target value. Such as X.X.X.X:number<0-65535> or number<0-65535>:number<0-4294967295> or number<0-65535>.number<0-65535>:number<0-65535> or number<65536-4294967295>:number<0-65535> but not support 0:0 and 0.0:0.
vrf
 yes
VPN instance.
vrf_aftype
 no v4
  • v4
  • v6
VPN instance address family.

Examples

- name: vrf af module 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: Config vpna, set address family is ipv4
    ce_vrf_af:
      vrf: vpna
      vrf_aftype: v4
      state: present
      provider: "{{ cli }}"
  - name: Config vpna, delete address family is ipv4
    ce_vrf_af:
      vrf: vpna
      vrf_aftype: v4
      state: absent
      provider: "{{ cli }}"
  - name: Config vpna, set address family is ipv4,rd=1:1,set vpn_target_type=export_extcommunity,vpn_target_value=2:2
    ce_vrf_af:
      vrf: vpna
      vrf_aftype: v4
      route_distinguisher: 1:1
      vpn_target_type: export_extcommunity
      vpn_target_value: 2:2
      vpn_target_state: present
      state: present
      provider: "{{ cli }}"
  - name: Config vpna, set address family is ipv4,rd=1:1,delete vpn_target_type=export_extcommunity,vpn_target_value=2:2
    ce_vrf_af:
      vrf: vpna
      vrf_aftype: v4
      route_distinguisher: 1:1
      vpn_target_type: export_extcommunity
      vpn_target_value: 2:2
      vpn_target_state: absent
      state: present
      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 switchport after module execution
always dict {'vpn_target_type': ['import_extcommunity', '3:3'], 'vpn_target_value': [], 'route_distinguisher': ['1:1', '2:2'], 'vrf': 'vpna', 'vrf_aftype': ['ipv4uni', 'ipv6uni']}
existing
k/v pairs of existing switchport
always dict {'vpn_target_type': [], 'vpn_target_value': [], 'route_distinguisher': ['1:1', '2:2'], 'vrf': 'vpna', 'vrf_aftype': ['ipv4uni', 'ipv6uni']}
proposed
k/v pairs of parameters passed into module
always dict {'vpn_target_type': 'none', 'vpn_targe_state': 'absent', 'state': 'present', 'vrf': 'vpna', 'vrf_aftype': 'v4', 'evpn': 'none', 'vpn_target_value': 'none'}
updates
command list sent to the device
always list ['ip vpn-instance vpna', 'vpn-target 3:3 import_extcommunity']

Notes

Note

  • If state=absent, the vrf will be removed, regardless of the non-required parameters.

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_vrf_af_module.html