cnos_interface – Manage Interface on Lenovo CNOS network devices — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# cnos_interface – Manage Interface on Lenovo CNOS network devices

New in version 2.3.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

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

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
aggregate - added in 2.8 |  | List of Interfaces definitions.
delay - added in 2.8 | Default: 20 | 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
description - added in 2.8 |  | Description of Interface.
duplex - added in 2.8 | Choices: full half auto ← | Interface link status
enabled boolean added in 2.8 | Choices: no yes ← | Interface link status.
mtu - added in 2.8 |  | Maximum size of transmit packet.
name - / required added in 2.8 |  | Name of the Interface.
neighbors - added in 2.8 |  | Check operational state of given interface `name` for LLDP neighbor. The following suboptions are available.
| host - |  | LLDP neighbor host for given interface `name`.
| port - |  | LLDP neighbor port to which interface `name` is connected.
provider - added in 2.8 |  | 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 - |  | 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 | Choices: no ← yes | 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.
| host - / 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 - |  | 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 - | Default: 22 | Specifies the port to use when building the connection to the remote device.
| ssh_keyfile - |  | 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_KEYFILE` will be used instead.
| timeout - | Default: 10 | 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.
| username - |  | 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.
rx_rate - added in 2.8 |  | Receiver rate in bits per second (bps). This is state check parameter only. Supports conditionals, see Conditionals in Networking Modules
speed - added in 2.8 |  | Interface link speed.
state - added in 2.8 | Choices: present ← absent up down | State of the Interface configuration, `up` means present and operationally up and `down` means present and operationally `down`
tx_rate - added in 2.8 |  | 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
      cnos_interface:
          name: Ethernet1/33
          description: test-interface
          speed: 100
          duplex: half
          mtu: 999

    - name: remove interface
      cnos_interface:
        name: loopback3
        state: absent

    - name: make interface up
      cnos_interface:
        name: Ethernet1/33
        enabled: True

    - name: make interface down
      cnos_interface:
        name: Ethernet1/33
        enabled: False

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

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

    - name: Config + intent
      cnos_interface:
        name: Ethernet1/33
        enabled: False
        state: down

    - name: Add interface using aggregate
      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
      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 | Returned | Description
--- | --- | ---
commands list | always, except for the platforms that use Netconf transport to manage the device. | The list of configuration mode commands to send to the device. Sample: ['interface Ethernet1/33', 'description test-interface', 'duplex half', 'mtu 512']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]

### Authors

- Anil Kumar Muraleedharan(@amuraleedhar)

Hint

If you notice any issues in this documentation you can edit this document to improve it.