community.network.ce_vrf – Manages VPN instance on HUAWEI CloudEngine switches.

Note

This plugin is part of the community.network collection (version 1.3.2).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.ce_vrf.

Synopsis

• Manages VPN instance of HUAWEI CloudEngine switches.

Parameters

Parameter	Choices/Defaults	Comments
description string		Description of the vrf, the string length is 1 - 242 .
state string	Choices: present ← absent	Manage the state of the resource.
vrf string / required		VPN instance, the length of vrf name is 1 - 31, i.e. "test", but can not be _public_.

Notes

Note

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

• 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 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 a vpn install named vpna, description is test
    community.network.ce_vrf:
      vrf: vpna
      description: test
      state: present
      provider: "{{ cli }}"
  - name: Delete a vpn install named vpna
    community.network.ce_vrf:
      vrf: vpna
      state: absent
      provider: "{{ cli }}"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
changed boolean	always	check to see if a change was made on the device Sample: True
end_state dictionary	always	k/v pairs of switchport after module execution Sample: {'description': 'test', 'present': 'present', 'vrf': 'vpna'}
existing dictionary	always	k/v pairs of existing switchport
proposed dictionary	always	k/v pairs of parameters passed into module Sample: {'description': 'test', 'state': 'present', 'vrf': 'vpna'}
updates list / elements=string	always	command list sent to the device Sample: ['ip vpn-instance vpna', 'description test']

Authors

• Yang yang (@QijunPan)