community.network.cnos_l2_interface module – Manage Layer-2 interface on Lenovo CNOS devices.

Note

This module is part of the community.network collection (version 3.3.0).

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 community.network.

To use it in a playbook, specify: community.network.cnos_l2_interface.

Synopsis

  • This module provides declarative management of Layer-2 interfaces on Lenovo CNOS devices.

Parameters

Parameter

Comments

access_vlan

string

Configure given VLAN in access port. If mode=access, used as the access VLAN ID.

aggregate

string

List of Layer-2 interface definitions.

mode

string

Mode in which interface needs to be configured.

Choices:

  • access ← (default)

  • trunk

name

aliases: interface

string / required

Full name of the interface excluding any logical unit number, i.e. Ethernet1/3.

native_vlan

string

Native VLAN to be configured in trunk port. If mode=trunk, used as the trunk native VLAN ID.

provider

string

Deprecated

Starting with Ansible 2.5 we recommend using connection: network_cli.

For more information please see the CNOS Platform Options guide.

A dict object containing connection details.

auth_pass

string

Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable ANSIBLE_NET_AUTH_PASS will be used instead.

authorize

boolean

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 ANSIBLE_NET_AUTHORIZE will be used instead.

Choices:

  • no ← (default)

  • yes

host

string / required

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.

password

string

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 ANSIBLE_NET_PASSWORD will be used instead.

port

string

Specifies the port to use when building the connection to the remote device.

Default: 22

ssh_keyfile

string

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 ANSIBLE_NET_SSH_KEYFILEwill be used instead.

timeout

string

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.

Default: 10

username

string

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 ANSIBLE_NET_USERNAME will be used instead.

state

string

Manage the state of the Layer-2 Interface configuration.

Choices:

  • present ← (default)

  • absent

  • unconfigured

trunk_allowed_vlans

string

List of allowed VLANs in a given trunk port. If mode=trunk, these are the only VLANs that will be configured on the trunk, i.e. “2-10,15”.

trunk_vlans

string

List of VLANs to be configured in trunk port. If mode=trunk, used as the VLAN range to ADD or REMOVE from the trunk.

Examples

- name: Ensure Ethernet1/5 is in its default l2 interface state
  community.network.cnos_l2_interface:
    name: Ethernet1/5
    state: unconfigured

- name: Ensure Ethernet1/5 is configured for access vlan 20
  community.network.cnos_l2_interface:
    name: Ethernet1/5
    mode: access
    access_vlan: 20

- name: Ensure Ethernet1/5 only has vlans 5-10 as trunk vlans
  community.network.cnos_l2_interface:
    name: Ethernet1/5
    mode: trunk
    native_vlan: 10
    trunk_vlans: 5-10

- name: Ensure Ethernet1/5 is a trunk port and ensure 2-50 are being tagged
        (doesn't mean others aren't also being tagged)
  community.network.cnos_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
  community.network.cnos_l2_interface:
    name: Ethernet1/5
    mode: trunk
    trunk_vlans: 51-4094
    state: absent

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

commands

list / elements=string

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 Ethernet1/5”, “switchport access vlan 20”]

Authors

  • Anil Kumar Muraleedharan (@amuraleedhar)