cisco.ios.ios_vlans module – Resource module to configure VLANs.
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_vlans.
New in cisco.ios 1.0.0
Synopsis
This module provides declarative management of VLANs on Cisco IOS network devices.
Aliases: vlans
Parameters
Parameter |
Comments |
|---|---|
A dictionary of VLANs options |
|
Members of VLAN |
|
Ethernet Virtual Private Network (EVPN) |
|
VXLAN vni |
|
VLAN Maximum Transmission Unit. Refer to vendor documentation for valid values. |
|
Ascii name of the VLAN. NOTE, name should not be named/appended with default as it is reserved for device default vlans. |
|
Options for private vlan configuration. |
|
List of private VLANs associated with the primary . Only works with `type: primary`. |
|
Private VLAN type Choices:
|
|
Configure as Remote SPAN VLAN Choices:
|
|
Shutdown VLAN switching. Choices:
|
|
Operational state of the VLAN Choices:
|
|
ID of the VLAN. Range 1-4094 |
|
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 vlan. 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 Choices:
|
Notes
Note
Tested against Cisco IOS-XE device with Version 17.13.01 on Cat9k on CML.
Starting from v2.5.0, this module will fail when run against Cisco IOS devices that do not support VLANs. The offline states (
renderedandparsed) will work as expected.This module works with connection
network_cli. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html
Examples
# Using merged
# Before state:
# -------------
#
# vios_l2#show vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
- name: Merge provided configuration with device configuration
cisco.ios.ios_vlans:
config:
- name: Vlan_10
vlan_id: 10
state: active
shutdown: disabled
remote_span: true
- name: Vlan_20
vlan_id: 20
mtu: 610
state: active
shutdown: enabled
- name: Vlan_30
vlan_id: 30
state: suspend
shutdown: enabled
state: merged
# After state:
# ------------
#
# vios_l2#show vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 10 vlan_10 active
# 20 vlan_20 act/lshut
# 30 vlan_30 sus/lshut
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 10 enet 100010 1500 - - - - - 0 0
# 20 enet 100020 610 - - - - - 0 0
# 30 enet 100030 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
#
# Remote SPAN VLANs
# ------------------------------------------------------------------------------
# 10
# Using merged
# Before state:
# -------------
#
# Leaf-01#show run nve | sec ^vlan configuration
# vlan configuration 101
# member evpn-instance 101 vni 10101
# vlan configuration 201
# member evpn-instance 201 vni 10201
- name: Merge provided configuration with device configuration
cisco.ios.ios_vlans:
config:
- vlan_id: 102
member:
vni: 10102
evi: 102
- vlan_id: 901
member:
vni: 50901
state: merged
# After state:
# ------------
#
# Leaf-01#show run nve | sec ^vlan configuration
# vlan configuration 101
# member evpn-instance 101 vni 10101
# vlan configuration 102
# member evpn-instance 102 vni 10102
# vlan configuration 201
# member evpn-instance 201 vni 10201
# vlan configuration 901
# member vni 50901
# Using overridden
# Before state:
# -------------
#
# vios_l2#show vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 10 vlan_10 active
# 20 vlan_20 act/lshut
# 30 vlan_30 sus/lshut
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 10 enet 100010 1500 - - - - - 0 0
# 20 enet 100020 610 - - - - - 0 0
# 30 enet 100030 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
#
# Remote SPAN VLANs
# ------------------------------------------------------------------------------
# 10
- name: Override device configuration of all VLANs with provided configuration
cisco.ios.ios_vlans:
config:
- name: Vlan_10
vlan_id: 10
mtu: 1000
state: overridden
# After state:
# ------------
#
# vios_l2#show vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 10 Vlan_10 active
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 10 enet 100010 1000 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
# Using overridden
# Before state:
# -------------
#
# Leaf-01#show run nve | sec ^vlan configuration
# vlan configuration 101
# member evpn-instance 101 vni 10101
# vlan configuration 102
# member evpn-instance 102 vni 10102
# vlan configuration 201
# member evpn-instance 201 vni 10201
# vlan configuration 901
# member vni 50901
- name: Override device configuration of all VLANs with provided configuration
cisco.ios.ios_vlans:
config:
- vlan_id: 101
member:
vni: 10102
evi: 102
- vlan_id: 102
member:
vni: 10101
evi: 101
state: overridden
# After state:
# ------------
#
# Leaf-01#show run nve | sec ^vlan configuration
# vlan configuration 101
# member evpn-instance 102 vni 10102
# vlan configuration 102
# member evpn-instance 101 vni 10101
# Using replaced
# Before state:
# -------------
#
# vios_l2#show vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 10 vlan_10 active
# 20 vlan_20 act/lshut
# 30 vlan_30 sus/lshut
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 10 enet 100010 1500 - - - - - 0 0
# 20 enet 100020 610 - - - - - 0 0
# 30 enet 100030 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
#
# Remote SPAN VLANs
# ------------------------------------------------------------------------------
# 10
- name: Replaces device configuration of listed VLANs with provided configuration
cisco.ios.ios_vlans:
config:
- vlan_id: 20
name: Test_VLAN20
mtu: 700
shutdown: disabled
- vlan_id: 50
name: pvlan-isolated
private_vlan:
type: isolated
- vlan_id: 60
name: pvlan-community
private_vlan:
type: community
- vlan_id: 70
name: pvlan-primary
private_vlan:
type: primary
associated:
- 50
- 60
state: replaced
# After state:
# ------------
#
# vios_l2#sh vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/0, Gi0/1, Gi0/2, Gi0/3
# 10 Vlan_10 active
# 20 Test_VLAN20 active
# 50 pvlan-isolated active
# 60 pvlan-community active
# 70 pvlan-primary active
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 10 enet 100010 1000 - - - - - 0 0
# 20 enet 100020 700 - - - - - 0 0
# 50 enet 100050 1500 - - - - - 0 0
# 60 enet 100051 1500 - - - - - 0 0
# 70 enet 100059 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1005 trnet 101005 1500 - - - ibm - 0 0
#
# Remote SPAN VLANs
# ------------------------------------------------------------------------------
#
#
# Primary Secondary Type Ports
# ------- --------- ----------------- ------------------------------------------
# 70 50 isolated
# 70 60 community
# Using deleted
# Before state:
# -------------
#
# vios_l2#show vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 10 vlan_10 active
# 20 vlan_20 act/lshut
# 30 vlan_30 sus/lshut
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 10 enet 100010 1500 - - - - - 0 0
# 20 enet 100020 610 - - - - - 0 0
# 30 enet 100030 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
#
# Remote SPAN VLANs
# ------------------------------------------------------------------------------
# 10
- name: Delete attributes of given VLANs
cisco.ios.ios_vlans:
config:
- vlan_id: 10
- vlan_id: 20
state: deleted
# After state:
# -------------
#
# vios_l2#show vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 30 vlan_30 sus/lshut
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 30 enet 100030 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
# Using deleted
# Before state:
# -------------
#
# Leaf-01#show run nve | sec ^vlan configuration
# vlan configuration 101
# member evpn-instance 101 vni 10101
# vlan configuration 102
# member evpn-instance 102 vni 10102
# vlan configuration 201
# member evpn-instance 201 vni 10201
# vlan configuration 901
# member vni 50901
- name: Delete attributes of given VLANs
cisco.ios.ios_vlans:
config:
- vlan_id: 101
state: deleted
# After state:
# -------------
#
# Leaf-01#show run nve | sec ^vlan configuration
# vlan configuration 101
# vlan configuration 102
# member evpn-instance 102 vni 10102
# vlan configuration 201
# member evpn-instance 201 vni 10201
# vlan configuration 901
# member vni 50901
# Using Deleted without any config passed
# "(NOTE: This will delete all of configured vlans attributes)"
# Before state:
# -------------
#
# vios_l2#show vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 10 vlan_10 active
# 20 vlan_20 act/lshut
# 30 vlan_30 sus/lshut
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 10 enet 100010 1500 - - - - - 0 0
# 20 enet 100020 610 - - - - - 0 0
# 30 enet 100030 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
#
# Remote SPAN VLANs
# ------------------------------------------------------------------------------
# 10
- name: Delete attributes of ALL VLANs
cisco.ios.ios_vlans:
state: deleted
# After state:
# -------------
#
# vios_l2#show vlan
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
# Using Deleted without any config passed
# "(NOTE: This will delete all of configured vlans attributes)"
# Before state:
# -------------
#
# Leaf-01#show run nve | sec ^vlan configuration
# vlan configuration 101
# member evpn-instance 101 vni 10101
# vlan configuration 102
# member evpn-instance 102 vni 10102
# vlan configuration 201
# member evpn-instance 201 vni 10201
# vlan configuration 202
# member evpn-instance 202 vni 10202
# vlan configuration 901
# member vni 50901
- name: Delete attributes of ALL VLANs
cisco.ios.ios_vlans:
state: deleted
# After state:
# -------------
#
# Leaf-01#show run nve | sec ^vlan configuration
# no vlan configuration 101
# no vlan configuration 102
# no vlan configuration 201
# no vlan configuration 202
# no vlan configuration 901
# no vlan configuration 902
# Using gathered, vlan configuration only
# Before state:
# -------------
#
# Leaf-01#show run nve | sec ^vlan configuration
# vlan configuration 101
# member evpn-instance 101 vni 10101
# vlan configuration 102
# member evpn-instance 102 vni 10102
# vlan configuration 201
# member evpn-instance 201 vni 10201
# vlan configuration 202
# member evpn-instance 202 vni 10202
# vlan configuration 901
# member vni 50901
- name: Gather listed vlans with provided configurations
cisco.ios.ios_vlans:
state: gathered
# Module Execution Result:
# ------------------------
#
# gathered = [
# {
# "member": {
# "evi": 101,
# "vni": 10101
# },
# "vlan_id": 101
# },
# {
# "member": {
# "evi": 102,
# "vni": 10102
# },
# "vlan_id": 102
# },
# {
# "member": {
# "evi": 201,
# "vni": 10201
# },
# "vlan_id": 201
# },
# {
# "member": {
# "evi": 202,
# "vni": 10202
# },
# "vlan_id": 202
# },
# {
# "member": {
# "vni": 50901
# },
# "vlan_id": 901
# },
# {
# "member": {
# "vni": 50902
# },
# "vlan_id": 902
# }
# ]
# Using Rendered
- name: Render the commands for provided configuration
cisco.ios.ios_vlans:
config:
- name: Vlan_10
vlan_id: 10
state: active
shutdown: disabled
remote_span: true
- name: Vlan_20
vlan_id: 20
mtu: 610
state: active
shutdown: enabled
- name: Vlan_30
vlan_id: 30
state: suspend
shutdown: enabled
state: rendered
# Module Execution Result:
# ------------------------
#
# "rendered": [
# "vlan 10",
# "name Vlan_10",
# "state active",
# "remote-span",
# "no shutdown",
# "vlan 20",
# "name Vlan_20",
# "state active",
# "mtu 610",
# "shutdown",
# "vlan 30",
# "name Vlan_30",
# "state suspend",
# "shutdown"
# ]
# Using Rendered
- name: Render the commands for provided configuration
cisco.ios.ios_vlans:
config:
- vlan_id: 101
member:
vni: 10101
evi: 101
- vlan_id: 102
member:
vni: 10102
evi: 102
state: rendered
# Module Execution Result:
# ------------------------
#
# "rendered": [
# "vlan configuration 101",
# "member evpn-instance 101 vni 10101",
# "vlan configuration 102",
# "member evpn-instance 102 vni 10102"
# ]
# Using Parsed
# File: parsed.cfg
# ----------------
#
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 10 vlan_10 active
# 20 vlan_20 act/lshut
# 30 vlan_30 sus/lshut
# 1002 fddi-default act/unsup
# 1003 token-ring-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trnet-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 10 enet 100010 1500 - - - - - 0 0
# 20 enet 100020 1500 - - - - - 0 0
# 30 enet 100030 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 tr 101003 1500 - - - - - 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trnet 101005 1500 - - - ibm - 0 0
- name: Parse the commands for provided configuration
cisco.ios.ios_vlans:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
# Module Execution Result:
# ------------------------
#
# "parsed": [
# {
# "mtu": 1500,
# "name": "default",
# "shutdown": "disabled",
# "state": "active",
# "vlan_id": 1
# },
# {
# "mtu": 1500,
# "name": "vlan_10",
# "shutdown": "disabled",
# "state": "active",
# "vlan_id": 10
# },
# {
# "mtu": 1500,
# "name": "vlan_20",
# "shutdown": "enabled",
# "state": "active",
# "vlan_id": 20
# },
# {
# "mtu": 1500,
# "name": "vlan_30",
# "shutdown": "enabled",
# "state": "suspend",
# "vlan_id": 30
# },
# {
# "mtu": 1500,
# "name": "fddi-default",
# "shutdown": "enabled",
# "state": "active",
# "vlan_id": 1002
# },
# {
# "mtu": 1500,
# "name": "token-ring-default",
# "shutdown": "enabled",
# "state": "active",
# "vlan_id": 1003
# },
# {
# "mtu": 1500,
# "name": "fddinet-default",
# "shutdown": "enabled",
# "state": "active",
# "vlan_id": 1004
# },
# {
# "mtu": 1500,
# "name": "trnet-default",
# "shutdown": "enabled",
# "state": "active",
# "vlan_id": 1005
# }
# ]
# Using Parsed Vlan configuration only
# File: parsed.cfg
# ----------------
#
# vlan configuration 101
# member evpn-instance 101 vni 10101
# vlan configuration 102
# member evpn-instance 102 vni 10102
# vlan configuration 901
# member vni 50901
- name: Parse the commands for provided configuration
cisco.ios.ios_vlans:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
# Module Execution Result:
# ------------------------
#
# "parsed": [
# {
# "member": {
# "evi": 101,
# "vni": 10101
# },
# "vlan_id": 101
# },
# {
# "member": {
# "evi": 102,
# "vni": 10102
# },
# "vlan_id": 102
# },
# {
# "member": {
# "vni": 50901
# },
# "vlan_id": 901
# }
# ]
# Using Parsed, Vlan and vlan configuration
# File: parsed.cfg
# ----------------
#
# VLAN Name Status Ports
# ---- -------------------------------- --------- -------------------------------
# 1 default active Gi0/1, Gi0/2
# 101 RemoteIsInMyName act/unsup Fa0/1, Fa0/4, Fa0/5, Fa0/6, Fa0/7, Fa0/8, Fa0/9, Fa0/10, Fa0/11, Fa0/12
# Fa0/13, Fa0/14, Fa0/15, Fa0/16, Fa0/17, Fa0/18, Fa0/19, Fa0/20, Fa0/21
# Fa0/22, Fa0/23, Fa0/24, Fa0/25, Fa0/26, Fa0/27, Fa0/28, Fa0/29, Fa0/30
# Fa0/31, Fa0/32, Fa0/33, Fa0/34, Fa0/35, Fa0/36, Fa0/37, Fa0/38, Fa0/39
# Fa0/40, Fa0/41, Fa0/42, Fa0/43, Fa0/44, Fa0/45, Fa0/46, Fa0/47, Fa0/48
# 150 VLAN0150 active
# 888 a_very_long_vlan_name_a_very_long_vlan_name
# active
# 1002 fddi-default act/unsup
# 1003 trcrf-default act/unsup
# 1004 fddinet-default act/unsup
# 1005 trbrf-default act/unsup
#
# VLAN Type SAID MTU Parent RingNo BridgeNo Stp BrdgMode Trans1 Trans2
# ---- ----- ---------- ----- ------ ------ -------- ---- -------- ------ ------
# 1 enet 100001 1500 - - - - - 0 0
# 101 enet 100101 610 - - - - - 0 0
# 150 enet 100150 1500 - - - - - 0 0
# 888 enet 100888 1500 - - - - - 0 0
# 1002 fddi 101002 1500 - - - - - 0 0
# 1003 trcrf 101003 4472 1005 3276 - - srb 0 0
# 1004 fdnet 101004 1500 - - - ieee - 0 0
# 1005 trbrf 101005 4472 - - 15 ibm - 0 0
#
#
# VLAN AREHops STEHops Backup CRF
# ---- ------- ------- ----------
# 1003 7 7 off
#
# Remote SPAN VLANs
# ------------------------------------------------------------------------------
# 150
#
# Primary Secondary Type Ports
# ------- --------- ----------------- ------------------------------------------
#
# vlan configuration 101
# member evpn-instance 101 vni 10101
# vlan configuration 102
# member evpn-instance 102 vni 10102
# vlan configuration 901
# member vni 50901
- name: Parse the commands for provided configuration
cisco.ios.ios_vlans:
running_config: "{{ lookup('file', './parsed.cfg') }}"
state: parsed
# Module Execution Result:
# ------------------------
#
# "parsed": [
# {
# "name": "default",
# "vlan_id": 1,
# "state": "active",
# "shutdown": "disabled",
# "mtu": 1500,
# },
# {
# "name": "RemoteIsInMyName",
# "vlan_id": 101,
# "state": "active",
# "shutdown": "enabled",
# "mtu": 610,
# "member": {"evi": 101, "vni": 10101},
# },
# {
# "name": "VLAN0150",
# "vlan_id": 150,
# "state": "active",
# "shutdown": "disabled",
# "mtu": 1500,
# "remote_span": True,
# },
# {
# "name": "a_very_long_vlan_name_a_very_long_vlan_name",
# "vlan_id": 888,
# "state": "active",
# "shutdown": "disabled",
# "mtu": 1500,
# },
# {
# "name": "fddi-default",
# "vlan_id": 1002,
# "state": "active",
# "shutdown": "enabled",
# "mtu": 1500,
# },
# {
# "name": "trcrf-default",
# "vlan_id": 1003,
# "state": "active",
# "shutdown": "enabled",
# "mtu": 4472,
# },
# {
# "name": "fddinet-default",
# "vlan_id": 1004,
# "state": "active",
# "shutdown": "enabled",
# "mtu": 1500,
# },
# {
# "name": "trbrf-default",
# "vlan_id": 1005,
# "state": "active",
# "shutdown": "enabled",
# "mtu": 4472,
# },
# {"vlan_id": 102, "member": {"evi": 102, "vni": 10102}},
# {"vlan_id": 901, "member": {"vni": 50901}},
# ]
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: |