Skip to content

eos_vrf

Collection Note

This module is part of the arista.eos collection. To install the collection, use:

ansible-galaxy collection install arista.eos
Added in version 1.0.0.

Synopsis

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

Parameters

Parameter Defaults / Choices Comments
aggregate
list / elements=dict		 List of VRFs instances
aggregate.associated_interfaces This is a intent option and checks the operational state of the for given vrf C(name) for associated interfaces. If the value in the C(associated_interfaces) does not match with the operational state of vrf interfaces on device it will result in failure.
aggregate.delay Default: 10
 Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
aggregate.interfaces Identifies the set of interfaces that should be configured in the VRF. Interfaces must be routed interfaces in order to be placed into a VRF. The name of interface should be in expanded format and not abbreviated.
aggregate.name Name of the VRF.
aggregate.rd Route distinguisher of the VRF
aggregate.state Default: present
Choices: present, absent 		State of the VRF configuration.
associated_interfaces
list / elements=str		 This is a intent option and checks the operational state of the for given vrf C(name) for associated interfaces. If the value in the C(associated_interfaces) does not match with the operational state of vrf interfaces on device it will result in failure.
delay
int		 Default: 10
 Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments.
interfaces
list / elements=str		 Identifies the set of interfaces that should be configured in the VRF. Interfaces must be routed interfaces in order to be placed into a VRF. The name of interface should be in expanded format and not abbreviated.
name
str		 Name of the VRF.
purge
bool		 Purge VRFs not defined in the I(aggregate) parameter.
rd
str		 Route distinguisher of the VRF
state
str		 Default: present
Choices: present, absent		 State of the VRF configuration.

Notes

Note

  • Tested against Arista EOS 4.24.6F

Examples

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

- name: Delete VRFs
  arista.eos.eos_vrf:
    name: test
    state: absent

- name: Create aggregate of VRFs with purge
  arista.eos.eos_vrf:
    aggregate:
      - name: test4
        rd: 1:204
      - name: test5
        rd: 1:205
    state: present
    purge: true

- name: Delete aggregate of VRFs
  arista.eos.eos_vrf:
    aggregate:
      - name: test2
      - name: test3
      - name: test4
      - name: test5
    state: absent

Return Values

Key Data Type Description Returned
commands list The list of configuration mode commands to send to the device always

Authors

  • Ricardo Carrillo Cruz (@rcarrillocruz)