You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

community.network.cnos_linkagg – Manage link aggregation groups on Lenovo CNOS devices

Note

This plugin is part of the community.network collection (version 3.0.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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	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. Choices: active on passive
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. Choices: no ← (default) yes
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	Specifies the port to use when building the connection to the remote device. Default: 22
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	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. Default: 10
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. Choices: no ← (default) yes
state string	State of the link aggregation group. Choices: present ← (default) absent

Notes

Note

• Tested against CNOS 10.8.1

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:

Key	Description
commands list / elements=string	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 port-channel 30”, “interface Ethernet1/33”, “channel-group 30 mode on”, “no interface port-channel 30”]

Authors

• Anil Kumar Muraleedharan (@auraleedhar)