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 module – Manage link aggregation groups on Lenovo CNOS devices

Note

This module is part of the community.network collection (version 5.0.2).

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.

Aliases: network.cnos.cnos_linkagg

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"`
purge boolean	Purge links not defined in the aggregate parameter. Choices: `false` ← (default) `true`
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)

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

Synopsis

Parameters

Notes

Examples

Return Values