cisco / cisco.ios / 8.0.0 / module / ios_l2_interfaces Resource module to configure L2 interfaces. | "added in version" 1.0.0 of cisco.ios" Authors: Sagar Paul (@KB-petByte), Sumit Jaiswal (@justjais)cisco.ios.ios_l2_interfaces (8.0.0) — module
Install with ansible-galaxy collection install cisco.ios:==8.0.0
collections: - name: cisco.ios version: 8.0.0
This module provides declarative management of Layer-2 interface on Cisco IOS devices.
# Using merged # Before state: # ------------- # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport access vlan 20 # media-type rj45 # negotiation auto - name: Merge provided configuration with device configuration cisco.ios.ios_l2_interfaces: config: - name: GigabitEthernet0/1 mode: access access: vlan: 10 voice: vlan: 40 - name: GigabitEthernet0/2 mode: trunk trunk: allowed_vlans: 10-20,40 native_vlan: 20 pruning_vlans: 10,20 encapsulation: dot1q state: merged
# Task Output # ----------- # # before: # - name: GigabitEthernet0/1 # - access: # vlan: 20 # name: GigabitEthernet0/2 # commands: # - interface GigabitEthernet0/1 # - switchport access vlan 10 # - switchport voice vlan 40 # - switchport mode access # - interface GigabitEthernet0/2 # - switchport mode trunk # - switchport trunk encapsulation dot1q # - switchport trunk native vlan 20 # - switchport trunk allowed vlan 10-20,40 # - switchport trunk pruning vlan 10,20 # after: # - access: # vlan: 10 # mode: access # name: GigabitEthernet0/1 # voice: # vlan: 40 # - mode: trunk # name: GigabitEthernet0/2 # trunk: # allowed_vlans: # - 10-20 # - '40' # encapsulation: dot1q # native_vlan: 20 # pruning_vlans: # - '10' # - '20' # After state: # ------------ # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # switchport access vlan 10 # switchport voice vlan 40 # switchport mode access # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport trunk allowed vlan 10-20,40 # switchport trunk encapsulation dot1q # switchport trunk native vlan 20 # switchport trunk pruning vlan 10,20 # switchport mode trunk # media-type rj45 # negotiation auto # Using replaced # Before state: # ------------- # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # switchport access vlan 20 # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport access vlan 20 # media-type rj45 # negotiation auto - name: Replaces device configuration with provided configuration cisco.ios.ios_l2_interfaces: config: - name: GigabitEthernet0/2 trunk: allowed_vlans: 20-25,40 native_vlan: 20 pruning_vlans: 10 encapsulation: isl state: replaced
# Task Output # ----------- # # before: # - name: GigabitEthernet0/1 # - access: # vlan: 20 # name: GigabitEthernet0/2 # commands: # - interface GigabitEthernet0/2 # - no switchport access vlan # - switchport trunk encapsulation isl # - switchport trunk native vlan 20 # - switchport trunk allowed vlan 20-25,40 # - switchport trunk pruning vlan 10 # after: # - access: # vlan: 20 # name: GigabitEthernet0/1 # - name: GigabitEthernet0/2 # trunk: # allowed_vlans: # - 20-25 # - '40' # encapsulation: isl # native_vlan: 20 # pruning_vlans: # - '10' # After state: # ------------- # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # switchport access vlan 20 # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport trunk allowed vlan 20-25,40 # switchport trunk encapsulation isl # switchport trunk native vlan 20 # switchport trunk pruning vlan 10 # media-type rj45 # negotiation auto # Using overridden # Before state: # ------------- # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # switchport trunk encapsulation dot1q # switchport trunk native vlan 20 # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport access vlan 20 # switchport trunk encapsulation dot1q # switchport trunk native vlan 20 # media-type rj45 # negotiation auto - name: Override device configuration of all l2 interfaces with provided configuration cisco.ios.ios_l2_interfaces: config: - name: GigabitEthernet0/2 access: vlan: 20 voice: vlan: 40 state: overridden
# Task Output # ----------- # # before: # - name: GigabitEthernet0/1 # trunk: # encapsulation: dot1q # native_vlan: 20 # - access: # vlan: 20 # name: GigabitEthernet0/2 # trunk: # encapsulation: dot1q # native_vlan: 20 # commands: # - interface GigabitEthernet0/1 # - no switchport trunk encapsulation # - no switchport trunk native vlan # - interface GigabitEthernet0/2 # - switchport voice vlan 40 # - no switchport trunk encapsulation # - no switchport trunk native vlan # after: # - name: GigabitEthernet0/1 # - access: # vlan: 20 # name: GigabitEthernet0/2 # voice: # vlan: 40 # After state: # ------------- # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport access vlan 20 # switchport voice vlan 40 # media-type rj45 # negotiation auto # Using deleted # Before state: # ------------- # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # switchport access vlan 20 # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport access vlan 20 # switchport trunk allowed vlan 20-40,60,80 # switchport trunk encapsulation dot1q # switchport trunk native vlan 10 # switchport trunk pruning vlan 10 # media-type rj45 # negotiation auto - name: Delete IOS L2 interfaces as in given arguments cisco.ios.ios_l2_interfaces: config: - name: GigabitEthernet0/1 state: deleted
# Task Output # ----------- # # before: # - access: # vlan: 20 # name: GigabitEthernet0/1 # - access: # vlan: 20 # name: GigabitEthernet0/2 # trunk: # allowed_vlans: # - 20-40 # - '60' # - '80' # encapsulation: dot1q # native_vlan: 10 # pruning_vlans: # - '10' # commands: # - interface GigabitEthernet0/1 # - no switchport access vlan # after: # - name: GigabitEthernet0/1 # - access: # vlan: 20 # name: GigabitEthernet0/2 # trunk: # allowed_vlans: # - 20-40 # - '60' # - '80' # encapsulation: dot1q # native_vlan: 10 # pruning_vlans: # - '10' # After state: # ------------- # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport access vlan 20 # switchport trunk allowed vlan 20-40,60,80 # switchport trunk encapsulation dot1q # switchport trunk native vlan 10 # switchport trunk pruning vlan 10 # media-type rj45 # negotiation auto # Using deleted without config - delete all configuration # Before state: # ------------- # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # switchport access vlan 20 # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport access vlan 20 # switchport trunk allowed vlan 20-40,60,80 # switchport trunk encapsulation dot1q # switchport trunk native vlan 10 # switchport trunk pruning vlan 10 # media-type rj45 # negotiation auto - name: Delete IOS L2 interfaces as in given arguments cisco.ios.ios_l2_interfaces: state: deleted
# Task Output # ----------- # # before: # - access: # vlan: 20 # name: GigabitEthernet0/1 # - access: # vlan: 20 # name: GigabitEthernet0/2 # trunk: # allowed_vlans: # - 20-40 # - '60' # - '80' # encapsulation: dot1q # native_vlan: 10 # pruning_vlans: # - '10' # commands: # - interface GigabitEthernet0/1 # - no switchport access vlan # - interface GigabitEthernet0/2 # - no switchport access vlan # - no switchport trunk encapsulation # - no switchport trunk native vlan # - no switchport trunk allowed vlan # - no switchport trunk pruning vlan # after: # - name: GigabitEthernet0/1 # - name: GigabitEthernet0/2 # After state: # ------------- # # viosl2#show running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # negotiation auto # interface GigabitEthernet0/2 # description This is test # media-type rj45 # negotiation auto # Using gathered # Before state: # ------------- # # vios#sh running-config | section ^interface # interface GigabitEthernet0/1 # description Configured by Ansible # switchport access vlan 20 # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport access vlan 20 # switchport trunk allowed vlan 20-40,60,80 # switchport trunk encapsulation dot1q # switchport trunk native vlan 10 # switchport trunk pruning vlan 10 # media-type rj45 # negotiation auto - name: Gather facts for l2 interfaces cisco.ios.ios_l2_interfaces: config: state: gathered
# Task Output # ----------- # # gathered: # - access: # vlan: 20 # name: GigabitEthernet0/1 # - access: # vlan: 20 # name: GigabitEthernet0/2 # trunk: # allowed_vlans: # - 20-40 # - '60' # - '80' # encapsulation: dot1q # native_vlan: 10 # pruning_vlans: # - '10' # Using rendered - name: Render the commands for provided configuration cisco.ios.ios_l2_interfaces: config: - name: GigabitEthernet0/1 access: vlan: 30 - name: GigabitEthernet0/2 trunk: allowed_vlans: 10-20,40 native_vlan: 20 pruning_vlans: 10,20 encapsulation: dot1q state: rendered
# Task Output # ----------- # # rendered: # - interface GigabitEthernet0/1 # - switchport access vlan 30 # - interface GigabitEthernet0/2 # - switchport trunk encapsulation dot1q # - switchport trunk native vlan 20 # - switchport trunk allowed vlan 10-20,40 # - switchport trunk pruning vlan 10,20 # Using Parsed # File: parsed.cfg # ---------------- # # interface GigabitEthernet0/1 # description Configured by Ansible # switchport access vlan 20 # negotiation auto # interface GigabitEthernet0/2 # description This is test # switchport access vlan 20 # switchport trunk allowed vlan 20-40,60,80 # switchport trunk encapsulation dot1q # switchport trunk native vlan 10 # switchport trunk pruning vlan 10 # media-type rj45 # negotiation auto - name: Parse the commands for provided configuration cisco.ios.ios_l2_interfaces: running_config: "{{ lookup('file', 'parsed.cfg') }}" state: parsed
state: choices: - merged - replaced - overridden - deleted - rendered - gathered - parsed default: merged description: - The state the configuration should be left in - The states I(rendered), I(gathered) and I(parsed) does not perform any change on the device. - The state I(rendered) will transform the configuration in C(config) option to platform specific CLI commands which will be returned in the I(rendered) key within the result. For state I(rendered) active connection to remote host is not required. - The state I(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 I(gathered) key within the result. - The state I(parsed) reads the configuration from C(running_config) option and transforms it into JSON format as per the resource module parameters and the value is returned in the I(parsed) key within the result. The value of C(running_config) option should be the same format as the output of command I(show running-config | include ip route|ipv6 route) executed on device. For state I(parsed) active connection to remote host is not required. type: str config: description: A dictionary of Layer-2 interface options elements: dict suboptions: access: description: - Switchport mode access command to configure the interface as a layer 2 access. suboptions: vlan: description: - Configure given VLAN in access port. It's used as the access VLAN ID. type: int vlan_name: description: - Set VLAN when interface is in access mode. type: str type: dict mode: choices: - access - trunk - dot1q_tunnel - dynamic - dynamic_auto - dynamic_desirable - private_vlan_host - private_vlan_promiscuous - private_vlan_trunk description: - Mode in which interface needs to be configured. - An interface whose trunk encapsulation is "Auto" can not be configured to "trunk" mode. type: str name: description: - Full name of the interface excluding any logical unit number, i.e GigabitEthernet0/1. required: true type: str trunk: description: - Switchport mode trunk command to configure the interface as a Layer 2 trunk. Note The encapsulation is always set to dot1q. suboptions: allowed_vlans: description: - List of allowed VLANs in a given trunk port. These are the only VLANs that will be configured on the trunk. elements: str type: list encapsulation: choices: - dot1q - isl - negotiate description: - Trunking encapsulation when interface is in trunking mode. type: str native_vlan: description: - Native VLAN to be configured in trunk port. It's used as the trunk native VLAN ID. type: int pruning_vlans: description: - Pruning VLAN to be configured in trunk port. It's used as the trunk pruning VLAN ID. elements: str type: list type: dict voice: description: - Switchport mode voice command to configure the interface with a voice vlan. suboptions: vlan: description: - Configure given voice VLAN on access port. It's used as the voice VLAN ID. type: int vlan_name: description: - Set VLAN when interface is in access mode. type: str vlan_tag: choices: - dot1p - none - untagged description: - Set VLAN Tag. dot1p (Priority tagged on PVID) none (Don't tell telephone about voice vlan) untagged (Untagged on PVID) type: str type: dict type: list running_config: description: - This option is used only with state I(parsed). - The value of this option should be the output received from the IOS device by executing the command B(show running-config | section ^interface). - The state I(parsed) reads the configuration from C(running_config) option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the I(parsed) key within the result. type: str
after: description: The resulting configuration after module execution. returned: when changed sample: 'This output will always be in the same format as the module argspec. ' type: dict before: description: The configuration prior to the module execution. returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or C(purged) sample: 'This output will always be in the same format as the module argspec. ' type: dict commands: description: The set of commands pushed to the remote device. returned: when I(state) is C(merged), C(replaced), C(overridden), C(deleted) or C(purged) sample: - interface GigabitEthernet0/2 - switchport trunk allowed vlan 15-20,40 - switchport trunk encapsulation dot1q type: list gathered: description: Facts about the network resource gathered from the remote device as structured data. returned: when I(state) is C(gathered) sample: 'This output will always be in the same format as the module argspec. ' type: list parsed: description: The device native config provided in I(running_config) option parsed into structured data as per module argspec. returned: when I(state) is C(parsed) sample: 'This output will always be in the same format as the module argspec. ' type: list rendered: description: The provided configuration in the task rendered in device-native format (offline). returned: when I(state) is C(rendered) sample: - interface GigabitEthernet0/1 - switchport access vlan 30 - switchport trunk encapsulation dot1q type: list