cisco.nxos.nxos_vlans – VLANs resource module¶
Note
This plugin is part of the cisco.nxos collection (version 1.4.0).
To install it use: ansible-galaxy collection install cisco.nxos
.
To use it in a playbook, specify: cisco.nxos.nxos_vlans
.
New in version 1.0.0: of cisco.nxos
Synopsis¶
This module creates and manages VLAN configurations on Cisco NX-OS.
Note
This module has a corresponding action plugin.
Parameters¶
Examples¶
# Using merged
# Before state:
# -------------
# vlan 1
- name: Merge provided configuration with device configuration.
cisco.nxos.nxos_vlans:
config:
- vlan_id: 5
name: test-vlan5
- vlan_id: 10
enabled: false
state: merged
# After state:
# ------------
# vlan 5
# name test-vlan5
# state active
# no shutdown
# vlan 10
# state active
# shutdown
# Using replaced
# Before state:
# -------------
# vlan 1
# vlan 5
# name test-vlan5
# vlan 10
# shutdown
- name: Replace device configuration of specified vlan with provided configuration.
cisco.nxos.nxos_vlans:
config:
- vlan_id: 5
name: test-vlan
enabled: false
- vlan_id: 10
enabled: false
state: replaced
# After state:
# ------------
# vlan 1
# vlan 5
# name test-vlan
# state active
# shutdown
# vlan 10
# state active
# shutdown
# Using overridden
# Before state:
# -------------
# vlan 1
# vlan 3
# name testing
# vlan 5
# name test-vlan5
# shutdown
# vlan 10
# shutdown
- name: Override device configuration of all vlans with provided configuration.
cisco.nxos.nxos_vlans:
config:
- vlan_id: 5
name: test-vlan
- vlan_id: 10
state: active
state: overridden
# After state:
# ------------
# vlan 5
# name test-vlan
# state active
# no shutdown
# vlan 10
# state active
# no shutdown
# Using deleted
# Before state:
# -------------
# vlan 1
# vlan 5
# vlan 10
- name: Delete vlans.
cisco.nxos.nxos_vlans:
config:
- vlan_id: 5
- vlan_id: 10
state: deleted
# After state:
# ------------
#
# Using rendered
- name: Use rendered state to convert task input to device specific commands
cisco.nxos.nxos_vlans:
config:
- vlan_id: 5
name: vlan5
mapped_vni: 100
- vlan_id: 6
name: vlan6
state: suspend
state: rendered
# Task Output (redacted)
# -----------------------
# rendered:
# - vlan 5
# - name vlan5
# - vn-segment 100
# - vlan 6
# - name vlan6
# - state suspend
# Using parsed
# parsed.cfg
# ------------
# {
# "TABLE_vlanbrief": {
# "ROW_vlanbrief": [
# {
# "vlanshowbr-vlanid": "1",
# "vlanshowbr-vlanid-utf": "1",
# "vlanshowbr-vlanname": "default",
# "vlanshowbr-vlanstate": "active",
# "vlanshowbr-shutstate": "noshutdown"
# },
# {
# "vlanshowbr-vlanid": "5",
# "vlanshowbr-vlanid-utf": "5",
# "vlanshowbr-vlanname": "vlan5",
# "vlanshowbr-vlanstate": "suspend",
# "vlanshowbr-shutstate": "noshutdown"
# },
# {
# "vlanshowbr-vlanid": "6",
# "vlanshowbr-vlanid-utf": "6",
# "vlanshowbr-vlanname": "VLAN0006",
# "vlanshowbr-vlanstate": "active",
# "vlanshowbr-shutstate": "noshutdown"
# },
# {
# "vlanshowbr-vlanid": "7",
# "vlanshowbr-vlanid-utf": "7",
# "vlanshowbr-vlanname": "vlan7",
# "vlanshowbr-vlanstate": "active",
# "vlanshowbr-shutstate": "noshutdown"
# }
# ]
# },
# "TABLE_mtuinfo": {
# "ROW_mtuinfo": [
# {
# "vlanshowinfo-vlanid": "1",
# "vlanshowinfo-media-type": "enet",
# "vlanshowinfo-vlanmode": "ce-vlan"
# },
# {
# "vlanshowinfo-vlanid": "5",
# "vlanshowinfo-media-type": "enet",
# "vlanshowinfo-vlanmode": "ce-vlan"
# },
# {
# "vlanshowinfo-vlanid": "6",
# "vlanshowinfo-media-type": "enet",
# "vlanshowinfo-vlanmode": "ce-vlan"
# },
# {
# "vlanshowinfo-vlanid": "7",
# "vlanshowinfo-media-type": "enet",
# "vlanshowinfo-vlanmode": "ce-vlan"
# }
# ]
# }
# }
#
# vlan 1,5-7
# vlan 5
# state suspend
# name vlan5
# vlan 7
# name vlan7
# vn-segment 100
- name: Use parsed state to convert externally supplied config to structured format
cisco.nxos.nxos_vlans:
running_config: "{{ lookup('file', 'parsed.cfg') }}"
state: parsed
# Task output (redacted)
# -----------------------
# parsed:
# - vlan_id: 5
# enabled: True
# mode: "ce"
# name: "vlan5"
# state: suspend
#
# - vlan_id: 6
# enabled: True
# mode: "ce"
# state: active
#
# - vlan_id: 7
# enabled: True
# mode: "ce"
# name: "vlan7"
# state: active
# mapped_vni: 100
# Using gathered
# Existing device config state
# -------------------------------
# nxos-9k# show vlan | json
# {"TABLE_vlanbrief": {"ROW_vlanbrief": [{"vlanshowbr-vlanid": "1", "vlanshowbr-vlanid-utf": "1", "vlanshowbr-vlanname": "default", "vlanshowbr-vlanstate
# ": "active", "vlanshowbr-shutstate": "noshutdown"}, {"vlanshowbr-vlanid": "5", "vlanshowbr-vlanid-utf": "5", "vlanshowbr-vlanname": "vlan5", "vlanshowb
# r-vlanstate": "suspend", "vlanshowbr-shutstate": "noshutdown"}, {"vlanshowbr-vlanid": "6", "vlanshowbr-vlanid-utf": "6", "vlanshowbr-vlanname": "VLAN00
# 06", "vlanshowbr-vlanstate": "active", "vlanshowbr-shutstate": "noshutdown"}, {"vlanshowbr-vlanid": "7", "vlanshowbr-vlanid-utf": "7", "vlanshowbr-vlan
# name": "vlan7", "vlanshowbr-vlanstate": "active", "vlanshowbr-shutstate": "shutdown"}]}, "TABLE_mtuinfo": {"ROW_mtuinfo": [{"vlanshowinfo-vlanid": "1",
# "vlanshowinfo-media-type": "enet", "vlanshowinfo-vlanmode": "ce-vlan"}, {"vlanshowinfo-vlanid": "5", "vlanshowinfo-media-type": "enet", "vlanshowinfo-
# vlanmode": "ce-vlan"}, {"vlanshowinfo-vlanid": "6", "vlanshowinfo-media-type": "enet", "vlanshowinfo-vlanmode": "ce-vlan"}, {"vlanshowinfo-vlanid": "7"
# , "vlanshowinfo-media-type": "enet", "vlanshowinfo-vlanmode": "ce-vlan"}]}}
#
# nxos-9k# show running-config | section ^vlan
# vlan 1,5-7
# vlan 5
# state suspend
# name vlan5
# vlan 7
# shutdown
# name vlan7
# vn-segment 190
- name: Gather vlans facts from the device using nxos_vlans
cisco.nxos.nxos_vlans:
state: gathered
# Task output (redacted)
# -----------------------
# gathered:
# - vlan_id: 5
# enabled: True
# mode: "ce"
# name: "vlan5"
# state: suspend
#
# - vlan_id: 6
# enabled: True
# mode: "ce"
# state: active
#
# - vlan_id: 7
# enabled: False
# mode: "ce"
# name: "vlan7"
# state: active
# mapped_vni: 190
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Trishna Guha (@trishnaguha)