community.network.cnos_interface module – Manage Interface on Lenovo CNOS network devices

Note

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

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_interface.

Synopsis

  • This module provides declarative management of Interfaces on Lenovo CNOS network devices.

Aliases: network.cnos.cnos_interface

Parameters

Parameter

Comments

aggregate

string

List of Interfaces definitions.

delay

string

Time in seconds to wait before checking for the operational state on remote device. This wait is applicable for operational state argument which are state with values up/down, tx_rate and rx_rate

Default: 20

description

string

Description of Interface.

duplex

string

Interface link status

Choices:

  • "full"

  • "half"

  • "auto" ← (default)

enabled

boolean

Interface link status.

Choices:

  • false

  • true ← (default)

mtu

string

Maximum size of transmit packet.

name

string / required

Name of the Interface.

neighbors

string

Check operational state of given interface name for LLDP neighbor.

The following suboptions are available.

host

string

LLDP neighbor host for given interface name.

port

string

LLDP neighbor port to which interface name is connected.

rx_rate

string

Receiver rate in bits per second (bps).

This is state check parameter only.

Supports conditionals, see Conditionals in Networking Modules

speed

string

Interface link speed.

state

string

State of the Interface configuration, up means present and operationally up and down means present and operationally down

Choices:

  • "present" ← (default)

  • "absent"

  • "up"

  • "down"

tx_rate

string

Transmit rate in bits per second (bps).

This is state check parameter only.

Supports conditionals, see Conditionals in Networking Modules

Notes

Note

  • Tested against CNOS 10.8.1

Examples

- name: Configure interface
  community.network.cnos_interface:
      name: Ethernet1/33
      description: test-interface
      speed: 100
      duplex: half
      mtu: 999

- name: Remove interface
  community.network.cnos_interface:
    name: loopback3
    state: absent

- name: Make interface up
  community.network.cnos_interface:
    name: Ethernet1/33
    enabled: true

- name: Make interface down
  community.network.cnos_interface:
    name: Ethernet1/33
    enabled: false

- name: Check intent arguments
  community.network.cnos_interface:
    name: Ethernet1/33
    state: up
    tx_rate: ge(0)
    rx_rate: le(0)

- name: Check neighbors intent arguments
  community.network.cnos_interface:
    name: Ethernet1/33
    neighbors:
    - port: eth0
      host: netdev

- name: Config + intent
  community.network.cnos_interface:
    name: Ethernet1/33
    enabled: false
    state: down

- name: Add interface using aggregate
  community.network.cnos_interface:
    aggregate:
    - { name: Ethernet1/33, mtu: 256, description: test-interface-1 }
    - { name: Ethernet1/44, mtu: 516, description: test-interface-2 }
    duplex: full
    speed: 100
    state: present

- name: Delete interface using aggregate
  community.network.cnos_interface:
    aggregate:
    - name: loopback3
    - name: loopback6
    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/33", "description test-interface", "duplex half", "mtu 512"]

Authors

  • Anil Kumar Muraleedharan(@amuraleedhar)