W3cubDocs

/Ansible

ce_vrf - Manages VPN instance on HUAWEI CloudEngine switches.

New in version 2.4.

Synopsis

  • Manages VPN instance of HUAWEI CloudEngine switches.

Options

parameter required default choices comments
description
 no
Description of the vrf, the string length is 1 - 242 .
state
 no present
  • present
  • absent
Manage the state of the resource.
vrf
 yes
VPN instance, the length of vrf name is 1 - 31, i.e. "test", but can not be _public_.

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
    ce_vrf:
      vrf: vpna
      description: test
      state: present
      provider: "{{ cli }}"
  - name: Delete a vpn install named vpna
    ce_vrf:
      vrf: vpna
      state: absent
      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
end_state
k/v pairs of switchport after module execution
 always dict {'vrf': 'vpna', 'present': 'present', 'description': 'test'}
changed
check to see if a change was made on the device
 always boolean True
updates
command list sent to the device
 always list ['ip vpn-instance vpna', 'description test']
proposed
k/v pairs of parameters passed into module
 always dict {'state': 'present', 'vrf': 'vpna', 'description': 'test'}
existing
k/v pairs of existing switchport
 always dict {}

Notes

Note

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

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–2017 Michael DeHaan
© 2017 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/ce_vrf_module.html