ansible / ansible.builtin / v2.8.13 / module / nxos_l2_interface Manage Layer-2 interface on Cisco NXOS devices. | "added in version" 2.5 of ansible.builtin" Authors: Trishna Guha (@trishnaguha) preview | supported by networkansible.builtin.nxos_l2_interface (v2.8.13) — module
pip
Install with pip install ansible==2.8.13
This module provides declarative management of Layer-2 interface on Cisco NXOS devices.
- name: Ensure Eth1/5 is in its default l2 interface state nxos_l2_interface: name: Ethernet1/5 state: unconfigured
- name: Ensure Eth1/5 is configured for access vlan 20 nxos_l2_interface: name: Ethernet1/5 mode: access access_vlan: 20
- name: Ensure Eth1/5 only has vlans 5-10 as trunk vlans nxos_l2_interface: name: Ethernet1/5 mode: trunk native_vlan: 10 trunk_vlans: 5-10
- name: Ensure eth1/5 is a trunk port and ensure 2-50 are being tagged (doesn't mean others aren't also being tagged) nxos_l2_interface: name: Ethernet1/5 mode: trunk native_vlan: 10 trunk_vlans: 2-50
- name: Ensure these VLANs are not being tagged on the trunk nxos_l2_interface: name: Ethernet1/5 mode: trunk trunk_vlans: 51-4094 state: absent
- name: Aggregate Configure interfaces for access_vlan with aggregate nxos_l2_interface: aggregate: - { name: "Ethernet1/2", access_vlan: 6 } - { name: "Ethernet1/7", access_vlan: 15 } mode: access
mode: choices: - access - trunk 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. Ethernet1/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).' - 'Starting with Ansible 2.6 we recommend using C(connection: httpapi) for NX-API.' - This option will be removed in a release after 2022-06-01. - For more information please see the U(https://docs.ansible.com/ansible/latest/network/user_guide/platform_nxos.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 is a common argument used for either I(cli) or I(nxapi) transports. 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. This value applies to either I(cli) or I(nxapi). The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443). type: int ssh_keyfile: description: - Specifies the SSH key to use to authenticate the connection to the remote device. This argument is only used for the I(cli) transport. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_SSH_KEYFILE) will be used instead. type: str 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. NX-API can be slow to return on long-running commands (sh mac, sh bgp, etc). type: int transport: choices: - cli - nxapi default: cli description: - Configures the transport connection to use when connecting to the remote device. The transport argument supports connectivity to the device over cli (ssh) or nxapi. type: str use_proxy: default: true description: - If C(no), the environment variables C(http_proxy) and C(https_proxy) will be ignored. type: bool use_ssl: default: false description: - Configures the I(transport) to use SSL if set to C(yes) only when the C(transport=nxapi), otherwise this value is ignored. type: bool username: description: - Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the nxapi authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable C(ANSIBLE_NET_USERNAME) will be used instead. type: str validate_certs: default: false description: - If C(no), SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not nxapi, this value is ignored. type: bool 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: aliases: - trunk_add_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 eth1/5 - switchport access vlan 20 type: list