ansible / ansible.builtin / v2.7.9 / module / ios_l2_interface Manage Layer-2 interface on Cisco IOS devices. | "added in version" 2.5 of ansible.builtin" Authors: Nathaniel Case (@qalthos) preview | supported by networkansible.builtin.ios_l2_interface (v2.7.9) — module
pip
Install with pip install ansible==2.7.9
This module provides declarative management of Layer-2 interfaces on Cisco IOS devices.
- name: Ensure GigabitEthernet0/5 is in its default l2 interface state ios_l2_interface: name: GigabitEthernet0/5 state: unconfigured
- name: Ensure GigabitEthernet0/5 is configured for access vlan 20 ios_l2_interface: name: GigabitEthernet0/5 mode: access access_vlan: 20
- name: Ensure GigabitEthernet0/5 only has vlans 5-10 as trunk vlans ios_l2_interface: name: GigabitEthernet0/5 mode: trunk native_vlan: 10 trunk_vlans: 5-10
- name: Ensure GigabitEthernet0/5 is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged) ios_l2_interface: name: GigabitEthernet0/5 mode: trunk native_vlan: 10 trunk_vlans: 2-50
- name: Ensure these VLANs are not being tagged on the trunk ios_l2_interface: name: GigabitEthernet0/5 mode: trunk trunk_vlans: 51-4094 state: absent
mode: choices: - access - trunk default: access description: - Mode in which interface needs to be configured. name: aliases: - interface description: - Full name of the interface excluding any logical unit number, i.e. GigabitEthernet0/1. required: true state: choices: - present - absent - unconfigured default: present description: - Manage the state of the Layer-2 Interface configuration. provider: description: - B(Deprecated) - 'Starting with Ansible 2.5 we recommend using C(connection: network_cli).' - For more information please see the U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html). - HORIZONTALLINE - A dict object containing connection details. suboptions: auth_pass: description: - Specifies the password to use if required to enter privileged mode on the remote device. If I(authorize) is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_AUTH_PASS) will be used instead. type: str authorize: default: false description: - 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 C(ANSIBLE_NET_AUTHORIZE) will be used instead. type: bool host: description: - Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport. type: str password: description: - Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_PASSWORD) will be used instead. type: str port: description: - Specifies the port to use when building the connection to the remote device. type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: path timeout: description: - Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error. type: int username: description: - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. type: str type: dict aggregate: description: - List of Layer-2 interface definitions. access_vlan: description: - Configure given VLAN in access port. If C(mode=access), used as the access VLAN ID. native_vlan: description: - Native VLAN to be configured in trunk port. If C(mode=trunk), used as the trunk native VLAN ID. trunk_vlans: description: - List of VLANs to be configured in trunk port. If C(mode=trunk), used as the VLAN range to ADD or REMOVE from the trunk. trunk_allowed_vlans: description: - List of allowed VLANs in a given trunk port. If C(mode=trunk), these are the only VLANs that will be configured on the trunk, i.e. "2-10,15".
commands: description: The list of configuration mode commands to send to the device returned: always, except for the platforms that use Netconf transport to manage the device. sample: - interface GigabitEthernet0/5 - switchport access vlan 20 type: list