Docs4dev
Docs
ansible / 2.4 / eos_vrf_module.html

eos_vrf - Manage VRFs on Arista EOS network devices

New in version 2.4.

Synopsis

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

Options

parameter required default choices comments
aggregate
 no
List of VRFs definitions
delay
 no 10
Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
interfaces
 no
List of interfaces to check the VRF has been configured correctly.
name
 yes
Name of the VRF.
purge
 no
Purge VRFs not defined in the aggregate parameter.
rd
 no
Route distinguisher of the VRF
state
 no present
  • present
  • absent
State of the VRF configuration.

Examples

- name: Create vrf
  eos_vrf:
    name: test
    rd: 1:200
    interfaces:
      - Ethernet2
    state: present

- name: Delete VRFs
  eos_vrf:
    name: test
    state: absent

- name: Create aggregate of VRFs with purge
  eos_vrf:
    aggregate:
      - { name: test4, rd: "1:204" }
      - { name: test5, rd: "1:205" }
    state: present
    purge: yes

- name: Delete aggregate of VRFs
  eos_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 list ['vrf definition test', 'rd 1:100', 'interface Ethernet1', 'vrf forwarding test']

Notes

Note

  • Tested against EOS 4.15

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/eos_vrf_module.html