community.network.cnos_interface – Manage Interface on Lenovo CNOS network devices¶
Note
This plugin is part of the community.network collection (version 2.1.1).
To install it use: ansible-galaxy collection install community.network
.
To use it in a playbook, specify: community.network.cnos_interface
.
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate
string
|
List of Interfaces definitions.
|
||
delay
string
|
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
string
|
Description of Interface.
|
||
duplex
string
|
|
Interface link status
|
|
enabled
boolean
|
|
Interface link status.
|
|
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. |
||
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. |
|
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
|
Default: 22
|
Specifies the port to use when building the connection to the remote device.
|
|
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_KEYFILE will be used instead. |
||
timeout
string
|
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
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. |
||
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 |
|
tx_rate
string
|
Transmit rate in bits per second (bps).
This is state check parameter only.
Supports conditionals, see Conditionals in Networking Modules
|
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:
Authors¶
Anil Kumar Muraleedharan(@amuraleedhar)