ansible.netcommon.net_vrf – (deprecated, removed after 2022-06-01) Manage VRFs on network devices

Note

This plugin is part of the ansible.netcommon collection (version 2.5.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 ansible.netcommon.

To use it in a playbook, specify: ansible.netcommon.net_vrf.

New in version 1.0.0: of ansible.netcommon

DEPRECATED

Removed in

major release after 2022-06-01

Why

Updated modules released with more functionality

Alternative

Use platform-specific “[netos]_vrf” module

Synopsis

  • This module provides declarative management of VRFs on network devices.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
aggregate
string
List of VRFs definitions
interfaces
string
List of interfaces the VRF should be configured on.
name
string
Name of the VRF.
purge
string
Default:
"no"
Purge VRFs not defined in the aggregate parameter.
state
string
    Choices:
  • present ←
  • absent
State of the VRF configuration.

Notes

Note

Examples

- name: Create VRF named MANAGEMENT
  ansible.netcommon.net_vrf:
    name: MANAGEMENT

- name: remove VRF named MANAGEMENT
  ansible.netcommon.net_vrf:
    name: MANAGEMENT
    state: absent

- name: Create aggregate of VRFs with purge
  ansible.netcommon.net_vrf:
    aggregate:
    - name: test4
      rd: 1:204
    - name: test5
      rd: 1:205
    state: present
    purge: yes

- name: Delete aggregate of VRFs
  ansible.netcommon.net_vrf:
    aggregate:
    - name: test2
    - name: test3
    - name: test4
    - name: test5
    state: absent

Return Values

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

Key Returned Description
commands
list / elements=string
always, except for the platforms that use Netconf transport to manage the device.
The list of configuration mode commands to send to the device

Sample:
['vrf definition MANAGEMENT']


Status

  • This module will be removed in a major release after 2022-06-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Ricardo Carrillo Cruz (@rcarrillocruz)