ios_vrf - Manage the collection of VRF definitions on Cisco IOS devices
New in version 2.3.
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.
Options
| parameter | required | default | choices | comments | |||||||||||||||||||||||||||||||||||||||||||||
|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|---|
| auth_pass | no | none | 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 | no |
| 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. | ||||||||||||||||||||||||||||||||||||||||||||||
| delay (added in 2.4)
| no | 10 | Time in seconds to wait before checking for the operational state on remote device. | ||||||||||||||||||||||||||||||||||||||||||||||
| description | no | 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 | no | 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 | no | 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 | no | A dict object containing connection details. |
|||||||||||||||||||||||||||||||||||||||||||||||
| |||||||||||||||||||||||||||||||||||||||||||||||||
| purge | no | Instructs the module to consider the VRF definition absolute. It will remove any previously configured VRFs on the device. | |||||||||||||||||||||||||||||||||||||||||||||||
| rd | no | 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. | |||||||||||||||||||||||||||||||||||||||||||||||
| state | no | present |
| 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 | no | 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. | |||||||||||||||||||||||||||||||||||||||||||||||
Examples
- name: configure a vrf named management
ios_vrf:
name: management
description: oob mgmt vrf
interfaces:
- Management1
- name: remove a vrf named test
ios_vrf:
name: test
state: absent
- name: configure set of VRFs and purge any others
ios_vrf:
vrfs:
- red
- blue
- green
purge: yes
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 ansible', 'description management vrf', {'rd': '1:100'}] |
| delta | The time elapsed to perform all operations | always | str | 0:00:10.469466 |
| end | The time the job ended | always | str | 2016-11-16 10:38:25.595612 |
| start | The time the job started | always | str | 2016-11-16 10:38:15.126146 |
Notes
Note
- Tested against IOS 15.6
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/ios_vrf_module.html