.. _cisco.ios.ios_vrf_module: ***************** cisco.ios.ios_vrf ***************** **Module to configure VRF definitions.** Version added: 1.0.0 .. contents:: :local: :depth: 1 Synopsis -------- - This module provides declarative management of VRF definitions on Cisco IOS devices. It allows playbooks to manage individual or the entire VRF collection. It also supports purging VRF definitions from the configuration that are not explicitly defined. Parameters ---------- .. raw:: html
Parameter Choices/Defaults Comments
associated_interfaces
list / elements=string
This is a intent option and checks the operational state of the for given vrf name for associated interfaces. If the value in the associated_interfaces does not match with the operational state of vrf interfaces on device it will result in failure.
delay
integer
Default:
10
Time in seconds to wait before checking for the operational state on remote device.
description
string
Provides a short description of the VRF definition in the current active configuration. The VRF definition value accepts alphanumeric characters used to provide additional information about the VRF.
interfaces
list / elements=string
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.
name
string
The name of the VRF definition to be managed on the remote IOS device. The VRF definition name is an ASCII string name used to uniquely identify the VRF. This argument is mutually exclusive with the vrfs argument
provider
dictionary
Deprecated
Starting with Ansible 2.5 we recommend using connection: network_cli.
For more information please see the https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html.
A dict object containing connection details.
auth_pass
string
Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.
authorize
boolean
    Choices:
  • no ←
  • yes
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 ANSIBLE_NET_AUTHORIZE will be used instead.
host
string
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.
password
string
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_PASSWORD will be used instead.
port
integer
Specifies the port to use when building the connection to the remote device.
ssh_keyfile
path
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_SSH_KEYFILE will be used instead.
timeout
integer
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.
username
string
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_USERNAME will be used instead.
purge
boolean
    Choices:
  • no ←
  • yes
Instructs the module to consider the VRF definition absolute. It will remove any previously configured VRFs on the device.
rd
string
The router-distinguisher value uniquely identifies the VRF to routing processes on the remote IOS system. The RD value takes the form of A:B where A and B are both numeric values.
route_both
list / elements=string
Adds an export and import list of extended route target communities to the VRF.
route_both_ipv4
list / elements=string
Adds an export and import list of extended route target communities in address-family configuration submode to the VRF.
route_both_ipv6
list / elements=string
Adds an export and import list of extended route target communities in address-family configuration submode to the VRF.
route_export
list / elements=string
Adds an export list of extended route target communities to the VRF.
route_export_ipv4
list / elements=string
Adds an export list of extended route target communities in address-family configuration submode to the VRF.
route_export_ipv6
list / elements=string
Adds an export list of extended route target communities in address-family configuration submode to the VRF.
route_import
list / elements=string
Adds an import list of extended route target communities to the VRF.
route_import_ipv4
list / elements=string
Adds an import list of extended route target communities in address-family configuration submode to the VRF.
route_import_ipv6
list / elements=string
Adds an import list of extended route target communities in address-family configuration submode to the VRF.
state
string
    Choices:
  • present ←
  • absent
Configures the state of the VRF definition as it relates to the device operational configuration. When set to present, the VRF should be configured in the device active configuration and when set to absent the VRF should not be in the device active configuration
vrfs
list / elements=raw
The set of VRF definition objects to be configured on the remote IOS device. Ths list entries can either be the VRF name or a hash of VRF definitions and attributes. This argument is mutually exclusive with the name argument.

Notes ----- .. note:: - Tested against IOS 15.6 - This module works with connection ``network_cli``. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html - For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide ` - For more information on using Ansible to manage Cisco devices see the `Cisco integration page `_. Examples -------- .. code-block:: yaml - name: configure a vrf named management cisco.ios.ios_vrf: name: management description: oob mgmt vrf interfaces: - Management1 - name: remove a vrf named test cisco.ios.ios_vrf: name: test state: absent - name: configure set of VRFs and purge any others cisco.ios.ios_vrf: vrfs: - red - blue - green purge: yes - name: Creates a list of import RTs for the VRF with the same parameters cisco.ios.ios_vrf: name: test_import rd: 1:100 route_import: - 1:100 - 3:100 - name: Creates a list of import RTs in address-family configuration submode for the VRF with the same parameters cisco.ios.ios_vrf: name: test_import_ipv4 rd: 1:100 route_import_ipv4: - 1:100 - 3:100 - name: Creates a list of import RTs in address-family configuration submode for the VRF with the same parameters cisco.ios.ios_vrf: name: test_import_ipv6 rd: 1:100 route_import_ipv6: - 1:100 - 3:100 - name: Creates a list of export RTs for the VRF with the same parameters cisco.ios.ios_vrf: name: test_export rd: 1:100 route_export: - 1:100 - 3:100 - name: Creates a list of export RTs in address-family configuration submode for the VRF with the same parameters cisco.ios.ios_vrf: name: test_export_ipv4 rd: 1:100 route_export_ipv4: - 1:100 - 3:100 - name: Creates a list of export RTs in address-family configuration submode for the VRF with the same parameters cisco.ios.ios_vrf: name: test_export_ipv6 rd: 1:100 route_export_ipv6: - 1:100 - 3:100 - name: Creates a list of import and export route targets for the VRF with the same parameters cisco.ios.ios_vrf: name: test_both rd: 1:100 route_both: - 1:100 - 3:100 - name: Creates a list of import and export route targets in address-family configuration submode for the VRF with the same parameters cisco.ios.ios_vrf: name: test_both_ipv4 rd: 1:100 route_both_ipv4: - 1:100 - 3:100 - name: Creates a list of import and export route targets in address-family configuration submode for the VRF with the same parameters cisco.ios.ios_vrf: name: test_both_ipv6 rd: 1:100 route_both_ipv6: - 1:100 - 3:100 Return Values ------------- Common return values are documented `here `_, the following are the fields unique to this module: .. raw:: html
Key Returned Description
commands
list
always
The list of configuration mode commands to send to the device

Sample:
['vrf definition ansible', 'description management vrf', {'rd': '1:100'}]
delta
string
always
The time elapsed to perform all operations

Sample:
0:00:10.469466
end
string
always
The time the job ended

Sample:
2016-11-16 10:38:25.595612
start
string
always
The time the job started

Sample:
2016-11-16 10:38:15.126146


Status ------ Authors ~~~~~~~ - Peter Sprygada (@privateip)