ansible.netcommon.net_vrf – (deprecated, removed after 2022-06-01) Manage VRFs on network devices
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 1.4.1).
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.
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 |
|
State of the VRF configuration. |
Notes
Note
- This module is supported on
ansible_network_os
network platforms. See the Network Platform Options for details.
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)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/ansible/netcommon/net_vrf_module.html