net_vrf - Manage VRFs on network devices
New in version 2.4.
Synopsis
- This module provides declarative management of VRFs on network devices.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
aggregate | no | List of VRFs definitions | ||
interfaces | no | List of interfaces the VRF should be configured on. | ||
name | no | Name of the VRF. | ||
purge | no | Purge VRFs not defined in the aggregate parameter. | ||
state | no | present |
| State of the VRF configuration. |
Examples
- name: Create VRF named MANAGEMENT net_vrf: name: MANAGEMENT - name: remove VRF named MANAGEMENT net_vrf: name: MANAGEMENT state: absent - name: Create aggregate of VRFs with purge net_vrf: aggregate: - { name: test4, rd: "1:204" } - { name: test5, rd: "1:205" } state: present purge: yes - name: Delete aggregate of VRFs net_vrf: aggregate: - name: test2 - name: test3 - name: test4 - name: test5 state: absent
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
commands | The list of configuration mode commands to send to the device | always, except for the platforms that use Netconf transport to manage the device. | list | ['vrf definition MANAGEMENT'] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
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/net_vrf_module.html