community.network.cnos_l3_interface – Manage Layer-3 interfaces on Lenovo CNOS network devices.¶
Note
This plugin is part of the community.network collection (version 1.3.2).
To install it use: ansible-galaxy collection install community.network.
To use it in a playbook, specify: community.network.cnos_l3_interface.
Synopsis¶
This module provides declarative management of Layer-3 interfaces on CNOS network devices.
Parameters¶
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
aggregate
string
|
List of Layer-3 interfaces definitions. Each of the entry in aggregate list should define name of interface
name and a optional ipv4 or ipv6 address. |
||
|
ipv4
string
|
IPv4 address to be set for the Layer-3 interface mentioned in name option. The address format is <ipv4 address>/<mask>, the mask is number in range 0-32 eg. 10.241.107.1/24
|
||
|
ipv6
string
|
IPv6 address to be set for the Layer-3 interface mentioned in name option. The address format is <ipv6 address>/<mask>, the mask is number in range 0-128 eg. fd5d:12c9:2201:1::1/64
|
||
|
name
string
|
Name of the Layer-3 interface to be configured eg. Ethernet1/2
|
||
|
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_KEYFILEwill 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. |
||
|
state
string
|
|
State of the Layer-3 interface configuration. It indicates if the configuration should be present or absent on remote device.
|
|
Examples¶
- name: Remove Ethernet1/33 IPv4 and IPv6 address
community.network.cnos_l3_interface:
name: Ethernet1/33
state: absent
- name: Set Ethernet1/33 IPv4 address
community.network.cnos_l3_interface:
name: Ethernet1/33
ipv4: 10.241.107.1/24
- name: Set Ethernet1/33 IPv6 address
community.network.cnos_l3_interface:
name: Ethernet1/33
ipv6: "fd5d:12c9:2201:1::1/64"
- name: Set Ethernet1/33 in dhcp
community.network.cnos_l3_interface:
name: Ethernet1/33
ipv4: dhcp
ipv6: dhcp
- name: Set interface Vlan1 (SVI) IPv4 address
community.network.cnos_l3_interface:
name: Vlan1
ipv4: 192.168.0.5/24
- name: Set IP addresses on aggregate
community.network.cnos_l3_interface:
aggregate:
- { name: Ethernet1/33, ipv4: 10.241.107.1/24 }
- { name: Ethernet1/44, ipv4: 10.240.106.1/24,
ipv6: "fd5d:12c9:2201:1::1/64" }
- name: Remove IP addresses on aggregate
community.network.cnos_l3_interface:
aggregate:
- { name: Ethernet1/33, ipv4: 10.241.107.1/24 }
- { name: Ethernet1/44, ipv4: 10.240.106.1/24,
ipv6: "fd5d:12c9:2201:1::1/64" }
state: absent
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Anil Kumar Muraleedharan (@amuraleedhar)