cisco.ios.ios_vrf_global module – Resource module to configure global VRF definitions.
Note
This module is part of the cisco.ios collection (version 9.0.3).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.ios.
To use it in a playbook, specify: cisco.ios.ios_vrf_global.
New in cisco.ios 8.0.0
Synopsis
This module provides declarative management of VRF definitions on Cisco IOS.
Parameters
Parameter |
Comments |
|---|---|
A dictionary containing device configurations for VRF, including a list of VRF definitions. |
|
List of VRF definitions. |
|
VRF specific description |
|
VRF IPv4 configuration |
|
IPv4 multicast configuration |
|
Enable multicast-specific topology Choices:
|
|
VRF IPv6 configuration |
|
IPv6 multicast configuration |
|
Enable multicast-specific topology Choices:
|
|
Name of the VRF. |
|
Specify route distinguisher (RD). |
|
Specify target VPN extended configurations. |
|
Both export and import target-VPN configuration. |
|
Export target-VPN configuration. |
|
Import target-VPN configuration. |
|
Virtual networking configuration. |
|
Identifier used to tag packets associated with this VNET. |
|
Configure vpn-id for the VRF as specified in RFC 2685. |
|
Configure vpn-id in RFC 2685 format. |
|
This option is used only with state parsed. The value of this option should be the output received from the IOS device by executing the command show running-config | section ^vrf. The state parsed reads the configuration from |
|
The state the configuration should be left in The states rendered, gathered and parsed does not perform any change on the device. The state rendered will transform the configuration in The state gathered will fetch the running configuration from device and transform it into structured data in the format as per the resource module argspec and the value is returned in the gathered key within the result. The state parsed reads the configuration from The state deleted only removes the VRF attributes that this module manages and does not negate the VRF completely. Thereby, preserving address-family related configurations under VRF context. The state purged removes all the VRF definitions from the target device. Use caution with this state. Refer to examples for more details. Choices:
|
Notes
Note
Tested against Cisco IOS-XE version 17.3 on CML.
This module works with connection
network_cli. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.htmlThe module examples uses callback plugin (stdout_callback = yaml) to generate task output in yaml format.
Examples
# Using merged
# Before state:
# -------------
#
# admin#show running-config | section ^vrf
- name: Merge provided configuration with device configuration
cisco.ios.ios_vrf_global:
config:
vrfs:
- name: VRF2
description: This is a test VRF for merged state
ipv4:
multicast:
multitopology: true
ipv6:
multicast:
multitopology: true
rd: "2:3"
route_target:
export: "192.0.2.0:100"
import_config: "192.0.2.3:200"
vpn:
id: "2:45"
vnet:
tag: 200
state: merged
# Task output
# -------------
#
# before: {}
#
# commands:
# - vrf definition VRF2
# - description This is a test VRF for merged state
# - ipv4 multicast multitopology
# - ipv6 multicast multitopology
# - rd 2:3
# - route-target export 192.0.2.0:100
# - route-target import 192.0.2.3:200
# - vnet tag 200
# - vpn id 2:45
#
# after:
# - name: VRF2
# description: This is a test VRF for merged state
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "2:3"
# route_target:
# export: "192.0.2.0:100"
# import_config: "192.0.2.3:200"
# vnet:
# tag: 200
# vpn:
# id: "2:45"
# After state:
# -------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vnet tag 200
# description This is a test VRF for merged state
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 2:3
# vpn id 2:45
# route-target export 192.0.2.0:100
# route-target import 192.0.2.3:200
# Using replaced
# Before state:
# -------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vnet tag 200
# description This is a test VRF for merged state
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 2:3
# vpn id 2:45
# route-target export 192.0.2.0:100
# route-target import 192.0.2.3:200
- name: Replace the provided configuration with the existing running configuration
cisco.ios.ios_vrf_global:
config:
vrfs:
- name: VRF7
description: VRF7 description
ipv4:
multicast:
multitopology: true
ipv6:
multicast:
multitopology: true
rd: "7:8"
route_target:
export: "198.51.100.112:500"
import_config: "192.0.2.4:400"
vpn:
id: "5:45"
vnet:
tag: 300
state: replaced
# Task Output:
# ------------
#
# before:
# - name: VRF2
# description: This is a test VRF for merged state
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "2:3"
# route_target:
# export: "192.0.2.0:100"
# import_config: "192.0.2.3:200"
# vnet:
# tag: 200
# vpn:
# id: "2:45"
#
# commands:
# - vrf definition VRF7
# - description VRF7 description
# - ipv4 multicast multitopology
# - ipv6 multicast multitopology
# - rd 7:8
# - route-target export 198.51.100.112:500
# - route-target import 192.0.2.4:400
# - vnet tag 300
# - vpn id 5:45
#
# after:
# - name: VRF2
# description: This is a test VRF for merged state
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "2:3"
# route_target:
# export: "192.0.2.0:100"
# import_config: "192.0.2.3:200"
# vnet:
# tag: 200
# vpn:
# id: "2:45
# - name: VRF7
# description: VRF7 description
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "7:8"
# route_target:
# export: "198.51.100.112:500"
# import_config: "192.0.2.4:400"
# vnet:
# tag: 300
# vpn:
# id: "5:45"
#
# After state:
# -------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vnet tag 200
# description This is a test VRF for merged state
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 2:3
# vpn id 2:45
# route-target export 192.0.2.0:100
# route-target import 192.0.2.3:200
# vrf definition VRF7
# vnet tag 300
# description VRF7 description
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 7:8
# route-target export 198.51.100.112:500
# route-target import 192.0.2.4:400
# vpn id 5:45
# Using Overridden
# Before state:
# -------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vnet tag 200
# description This is a test VRF for merged state
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 2:3
# vpn id 2:45
# route-target export 192.0.2.0:100
# route-target import 192.0.2.3:200
# vrf definition VRF7
# vnet tag 300
# description VRF7 description
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 7:8
# route-target export 198.51.100.112:500
# route-target import 192.0.2.4:400
# vpn id 5:45
- name: Override the provided configuration with the existing running configuration
cisco.ios.ios_vrf_global:
config:
vrfs:
- name: VRF6
description: VRF6 description
ipv4:
multicast:
multitopology: true
ipv6:
multicast:
multitopology: true
rd: "6:7"
route_target:
export: "198.51.0.2:400"
import_config: "198.51.0.5:200"
vpn:
id: "4:5"
vnet:
tag: 500
state: overridden
# Task Output:
# ------------
#
# before:
# - name: VRF2
# description: This is a test VRF for merged state
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "2:3"
# route_target:
# export: "192.0.2.0:100"
# import_config: "192.0.2.3:200"
# vnet:
# tag: 200
# vpn:
# id: "2:45
# - name: VRF7
# description: VRF7 description
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "7:8"
# route_target:
# export: "198.51.100.112:500"
# import_config: "192.0.2.4:400"
# vnet:
# tag: 300
# vpn:
# id: "5:45"
#
# commands:
# - vrf definition VRF2
# - no description This is a test VRF for merged state
# - no ipv4 multicast multitopology
# - no ipv6 multicast multitopology
# - no rd 2:3
# - no route-target export 192.0.2.0:100
# - no route-target import 192.0.2.3:200
# - no vnet tag 200
# - no vpn id 2:45
# - vrf definition VRF7
# - no description VRF7 description
# - no ipv4 multicast multitopology
# - no ipv6 multicast multitopology
# - no rd 7:8
# - no route-target export 198.51.100.112:500
# - no route-target import 192.0.2.4:400
# - no vnet tag 300
# - no vpn id 5:45
# - vrf definition VRF6
# - description VRF6 description
# - ipv4 multicast multitopology
# - ipv6 multicast multitopology
# - rd 6:7
# - route-target export 198.51.0.2:400
# - route-target import 198.51.0.5:200
# - vnet tag 500
# - vpn id 4:5
#
# after:
# - name: VRF2
# - name: VRF6
# description: VRF6 description
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "6:7"
# route_target:
# export: "198.51.0.2:400"
# import_config: "198.51.0.5:200"
# vnet:
# tag: 500
# vpn:
# id: "4:5
# - name: VRF7
# After state:
# ------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vrf definition VRF6
# vnet tag 500
# description VRF6 description
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 6:7
# vpn id 4:5
# route-target export 198.51.0.2:400
# route-target import 198.51.0.5:200
# vrf definition VRF7
# Using Deleted
# Before state:
# -------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vrf definition VRF6
# vnet tag 500
# description VRF6 description
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 6:7
# vpn id 4:5
# route-target export 198.51.0.2:400
# route-target import 198.51.0.5:200
# vrf definition VRF7
- name: Delete the provided configuration when config is given
cisco.ios.ios_vrf_global:
config:
vrfs:
- name: VRF2
- name: VRF6
- name: VRF7
state: deleted
# Task Output:
# ------------
#
# before:
# - name: VRF2
# - name: VRF6
# description: VRF6 description
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "6:7"
# route_target:
# export: "198.51.0.2:400"
# import_config: "198.51.0.5:200"
# vnet:
# tag: 500
# vpn:
# id: "4:5"
# - name: VRF7
#
# commands:
# - vrf definition VRF2
# - vrf definition VRF6
# - no description VRF6 description
# - no ipv4 multicast multitopology
# - no ipv6 multicast multitopology
# - no rd 6:7
# - no route-target export 198.51.0.2:400
# - no route-target import 198.51.0.5:200
# - no vnet tag 500
# - no vpn id 4:5
# - vrf definition VRF7
#
# after:
# - name: VRF2
# - name: VRF6
# - name: VRF7
# After state:
# -------------
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vrf definition VRF6
# vrf definition VRF7
# Using Deleted with empty config
# Before state:
# -------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vrf definition VRF6
# vnet tag 500
# description VRF6 description
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 6:7
# vpn id 4:5
# route-target export 198.51.0.2:400
# route-target import 198.51.0.5:200
# vrf definition VRF7
- name: Delete the provided configuration when config is empty
cisco.ios.ios_vrf_global:
config:
state: deleted
# Task Output:
# ------------
#
# before:
# - name: VRF2
# - name: VRF6
# description: VRF6 description
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "6:7"
# route_target:
# export: "198.51.0.2:400"
# import_config: "198.51.0.5:200"
# vnet:
# tag: 500
# vpn:
# id: "4:5"
# - name: VRF7
# commands:
# - vrf definition VRF2
# - vrf definition VRF6
# - no description VRF6 description
# - no ipv4 multicast multitopology
# - no ipv6 multicast multitopology
# - no rd 6:7
# - no route-target export 198.51.0.2:400
# - no route-target import 198.51.0.5:200
# - no vnet tag 500
# - no vpn id 4:5
# - vrf definition VRF7
#
# after:
# - name: VRF2
# - name: VRF6
# - name: VRF7
# After state:
# -------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vrf definition VRF6
# vrf definition VRF7
# Using purged - would delete all the VRF definitions
# Before state:
# -------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vrf definition VRF6
# vrf definition VRF7
- name: Purge all the configuration from the device
cisco.ios.ios_vrf_global:
state: purged
# Task Output:
# ------------
#
# before:
# - name: VRF2
# - name: VRF6
# - name: VRF7
# commands:
# - no vrf definition VRF2
# - no vrf definition VRF6
# - no vrf definition VRF7
# after: {}
# After state:
# -------------
#
# admin#show running-config | section ^vrf
# Using Rendered
- name: Render provided configuration with device configuration
cisco.ios.ios_vrf_global:
config:
vrfs:
- name: VRF2
description: This is a test VRF for merged state
ipv4:
multicast:
multitopology: true
ipv6:
multicast:
multitopology: true
rd: "2:3"
route_target:
export: "192.0.2.0:100"
import_config: "192.0.2.3:200"
vpn:
id: "2:45"
vnet:
tag: 200
state: rendered
# Task Output:
# ------------
#
# rendered:
# - vrf definition VRF2
# - description This is a test VRF for merged state
# - ipv4 multicast multitopology
# - ipv6 multicast multitopology
# - rd 2:3
# - route-target export 192.0.2.0:100
# - route-target import 192.0.2.3:200
# - vnet tag 200
# - vpn id 2:45
# Using Gathered
# Before state:
# -------------
#
# admin#show running-config | section ^vrf
# vrf definition VRF2
# vnet tag 200
# description This is a test VRF for merged state
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 2:3
# vpn id 2:45
# route-target export 192.0.2.0:100
# route-target import 192.0.2.3:200
- name: Gather existing running configuration
cisco.ios.ios_vrf_global:
config:
state: gathered
# Task Output:
# ------------
#
# gathered:
# vrfs:
# - name: VRF2
# description: This is a test VRF for merged state
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "2:3"
# route_target:
# export: "192.0.2.0:100"
# import_config: "192.0.2.3:200"
# vnet:
# tag: 200
# vpn:
# id: "2:45"
# Using parsed
# File: parsed.cfg
# ----------------
#
# vrf definition test
# vnet tag 34
# description This is test VRF
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 192.0.2.0:300
# vpn id 3:4
# route-target export 192.0.2.0:100
# route-target import 192.0.2.2:300
# vrf definition test2
# vnet tag 35
# description This is test VRF
# ipv4 multicast multitopology
# ipv6 multicast multitopology
# rd 192.0.2.3:300
- name: Parse the provided configuration
cisco.ios.ios_vrf_global:
running_config: "{{ lookup('file', 'parsed.cfg') }}"
state: parsed
# Task Output:
# ------------
#
# parsed:
# vrfs:
# - name: test
# description: This is test VRF
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "192.0.2.0:300"
# route_target:
# export: "192.0.2.0:100"
# import_config: "192.0.2.2:300"
# vnet:
# tag: 34
# vpn:
# id: "3:4"
# - name: test2
# description: This is test VRF
# ipv4:
# multicast:
# multitopology: true
# ipv6:
# multicast:
# multitopology: true
# rd: "192.0.2.3:300"
# vnet:
# tag: 35
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The resulting configuration after module execution. Returned: when changed Sample: |
|
The configuration prior to the module execution. Returned: when state is Sample: |
|
The set of commands pushed to the remote device. Returned: when state is Sample: |
|
Facts about the network resource gathered from the remote device as structured data. Returned: when state is Sample: |
|
The device native config provided in running_config option parsed into structured data as per module argspec. Returned: when state is Sample: |
|
The provided configuration in the task rendered in device-native format (offline). Returned: when state is Sample: |