community.network.cnos_linkagg – Manage link aggregation groups on Lenovo CNOS 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_linkagg
.
Synopsis¶
This module provides declarative management of link aggregation groups on Lenovo CNOS network devices.
Parameters¶
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
aggregate
string
|
List of link aggregation definitions.
|
||
group
string
|
Channel-group number for the port-channel Link aggregation group. Range 1-255.
|
||
members
string
|
List of members of the link aggregation group.
|
||
mode
string
|
|
Mode of the link aggregation group.
|
|
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. |
||
purge
boolean
|
|
Purge links not defined in the aggregate parameter.
|
|
state
string
|
|
State of the link aggregation group.
|
Examples¶
- name: Create link aggregation group
community.network.cnos_linkagg:
group: 10
state: present
- name: Delete link aggregation group
community.network.cnos_linkagg:
group: 10
state: absent
- name: Set link aggregation group to members
community.network.cnos_linkagg:
group: 200
mode: active
members:
- Ethernet1/33
- Ethernet1/44
- name: Remove link aggregation group from GigabitEthernet0/0
community.network.cnos_linkagg:
group: 200
mode: active
members:
- Ethernet1/33
- name: Create aggregate of linkagg definitions
community.network.cnos_linkagg:
aggregate:
- { group: 3, mode: on, members: [Ethernet1/33] }
- { group: 100, mode: passive, members: [Ethernet1/44] }
Return Values¶
Common return values are documented here, the following are the fields unique to this module:
Authors¶
Anil Kumar Muraleedharan (@auraleedhar)