community.network.cnos_interface (5.0.2) — module

Manage Interface on Lenovo CNOS network devices

Authors: Anil Kumar Muraleedharan(@amuraleedhar)

Install collection

Install with ansible-galaxy collection install community.network:==5.0.2


Add to requirements.yml

  collections:
    - name: community.network
      version: 5.0.2

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Configure interface
  community.network.cnos_interface:
      name: Ethernet1/33
      description: test-interface
      speed: 100
      duplex: half
      mtu: 999
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Remove interface
  community.network.cnos_interface:
    name: loopback3
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Make interface up
  community.network.cnos_interface:
    name: Ethernet1/33
    enabled: true
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Make interface down
  community.network.cnos_interface:
    name: Ethernet1/33
    enabled: false
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Check intent arguments
  community.network.cnos_interface:
    name: Ethernet1/33
    state: up
    tx_rate: ge(0)
    rx_rate: le(0)
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Check neighbors intent arguments
  community.network.cnos_interface:
    name: Ethernet1/33
    neighbors:
    - port: eth0
      host: netdev
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Config + intent
  community.network.cnos_interface:
    name: Ethernet1/33
    enabled: false
    state: down
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- 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
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Delete interface using aggregate
  community.network.cnos_interface:
    aggregate:
    - name: loopback3
    - name: loopback6
    state: absent

Inputs

    
mtu:
    description:
    - Maximum size of transmit packet.

name:
    description:
    - Name of the Interface.
    required: true

delay:
    default: 20
    description:
    - Time in seconds to wait before checking for the operational state on remote device.
      This wait is applicable for operational state argument which are I(state) with values
      C(up)/C(down), I(tx_rate) and I(rx_rate)

speed:
    description:
    - Interface link speed.

state:
    choices:
    - present
    - absent
    - up
    - down
    default: present
    description:
    - State of the Interface configuration, C(up) means present and operationally up and
      C(down) means present and operationally C(down)

duplex:
    choices:
    - full
    - half
    - auto
    default: auto
    description:
    - Interface link status

enabled:
    default: true
    description:
    - Interface link status.
    type: bool

rx_rate:
    description:
    - Receiver rate in bits per second (bps).
    - This is state check parameter only.
    - Supports conditionals, see L(Conditionals in Networking Modules, ../network/user_guide/network_working_with_command_output.html)

tx_rate:
    description:
    - Transmit rate in bits per second (bps).
    - This is state check parameter only.
    - Supports conditionals, see L(Conditionals in Networking Modules, ../network/user_guide/network_working_with_command_output.html)

aggregate:
    description: List of Interfaces definitions.

neighbors:
    description:
    - Check operational state of given interface C(name) for LLDP neighbor.
    - The following suboptions are available.
    suboptions:
      host:
        description:
        - LLDP neighbor host for given interface C(name).
      port:
        description:
        - LLDP neighbor port to which interface C(name) is connected.

description:
    description:
    - Description of Interface.

Outputs

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 Ethernet1/33
  - description test-interface
  - duplex half
  - mtu 512
  type: list