ansible / ansible.builtin / v2.9.17 / module / eos_vrf Manage VRFs on Arista EOS network devices | "added in version" 2.4 of ansible.builtin" Authors: Ricardo Carrillo Cruz (@rcarrillocruz) preview | supported by networkansible.builtin.eos_vrf (v2.9.17) — module
pip
Install with pip install ansible==2.9.17
This module provides declarative management of VRFs on Arista EOS network devices.
- 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
rd: description: - Route distinguisher of the VRF name: description: - Name of the VRF. required: true delay: default: 10 description: - Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state arguments. purge: default: false description: - Purge VRFs not defined in the I(aggregate) parameter. type: bool state: choices: - present - absent default: present description: - State of the VRF configuration. provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for eAPI.' - This option will be removed in a release after 2022-06-01. - For more information please see the L(EOS Platform Options guide, ../network/user_guide/platform_eos.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. type: str authorize: default: false description: - Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTHORIZE) will be used instead. type: bool host: description: - Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either I(cli) or I(eapi) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: default: 0 description: - Specifies the port to use when building the connection to the remote device. This value applies to either I(cli) or I(eapi). - The port value will default to the appropriate transport common port if none is provided in the task (cli=22, http=80, https=443). type: int ssh_keyfile: description: - Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for I(cli) transports. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: path timeout: description: - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. type: int transport: choices: - cli - eapi default: cli description: - Configures the transport connection to use when connecting to the remote device. type: str use_proxy: default: true description: - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. type: bool use_ssl: default: true description: - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=eapi). If the transport argument is not eapi, this value is ignored. type: bool username: description: - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. type: str validate_certs: default: true description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not eapi, this value is ignored. type: bool type: dict aggregate: description: List of VRFs definitions interfaces: description: - 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. associated_interfaces: description: - 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. version_added: '2.5' version_added_collection: ansible.builtin
commands: description: The list of configuration mode commands to send to the device returned: always sample: - vrf definition test - rd 1:100 - interface Ethernet1 - vrf forwarding test type: list