• AnsibleFest
  • Products
  • Community
  • Webinars & Training
  • Blog
Ansible Logo
Documentation
Ansible
5

Installation, Upgrade & Configuration

  • Installation Guide
  • Ansible Porting Guides

Using Ansible

  • User Guide

Contributing to Ansible

  • Ansible Community Guide

Extending Ansible

  • Developer Guide

Common Ansible Scenarios

  • Legacy Public Cloud Guides
  • Network Technology Guides
  • Virtualization and Containerization Guides

Network Automation

  • Network Getting Started
  • Network Advanced Topics
  • Network Developer Guide

Ansible Galaxy

  • Galaxy User Guide
  • Galaxy Developer Guide

Reference & Appendices

  • Collection Index
    • Collections in the Amazon Namespace
    • Collections in the Ansible Namespace
    • Collections in the Arista Namespace
    • Collections in the Awx Namespace
    • Collections in the Azure Namespace
    • Collections in the Check_point Namespace
    • Collections in the Chocolatey Namespace
    • Collections in the Cisco Namespace
    • Collections in the Cloud Namespace
    • Collections in the Cloudscale_ch Namespace
    • Collections in the Community Namespace
      • Community.Aws
      • Community.Azure
      • Community.Ciscosmb
      • Community.Crypto
      • Community.Digitalocean
      • Community.Dns
      • Community.Docker
      • Community.Fortios
      • Community.General
      • Community.Google
      • Community.Grafana
      • Community.Hashi_Vault
      • Community.Hrobot
      • Community.Kubernetes
      • Community.Kubevirt
      • Community.Libvirt
      • Community.Mongodb
      • Community.Mysql
      • Community.Network
        • Description
        • Plugin Index
      • Community.Okd
      • Community.Postgresql
      • Community.Proxysql
      • Community.Rabbitmq
      • Community.Routeros
      • Community.Sap
      • Community.Skydive
      • Community.Sops
      • Community.Vmware
      • Community.Windows
      • Community.Zabbix
    • Collections in the Containers Namespace
    • Collections in the Cyberark Namespace
    • Collections in the Dellemc Namespace
    • Collections in the F5networks Namespace
    • Collections in the Fortinet Namespace
    • Collections in the Frr Namespace
    • Collections in the Gluster Namespace
    • Collections in the Google Namespace
    • Collections in the Hetzner Namespace
    • Collections in the Hpe Namespace
    • Collections in the Ibm Namespace
    • Collections in the Infinidat Namespace
    • Collections in the Infoblox Namespace
    • Collections in the Inspur Namespace
    • Collections in the Junipernetworks Namespace
    • Collections in the Kubernetes Namespace
    • Collections in the Mellanox Namespace
    • Collections in the Netapp Namespace
    • Collections in the Netapp_eseries Namespace
    • Collections in the Netbox Namespace
    • Collections in the Ngine_io Namespace
    • Collections in the Openstack Namespace
    • Collections in the Openvswitch Namespace
    • Collections in the Ovirt Namespace
    • Collections in the Purestorage Namespace
    • Collections in the Sensu Namespace
    • Collections in the Servicenow Namespace
    • Collections in the Splunk Namespace
    • Collections in the T_systems_mms Namespace
    • Collections in the Theforeman Namespace
    • Collections in the Vmware Namespace
    • Collections in the Vyos Namespace
    • Collections in the Wti Namespace
  • Indexes of all modules and plugins
  • Playbook Keywords
  • Return Values
  • Ansible Configuration Settings
  • Controlling how Ansible behaves: precedence rules
  • YAML Syntax
  • Python 3 Support
  • Interpreter Discovery
  • Releases and maintenance
  • Testing Strategies
  • Sanity Tests
  • Frequently Asked Questions
  • Glossary
  • Ansible Reference: Module Utilities
  • Special Variables
  • Red Hat Ansible Automation Platform
  • Ansible Automation Hub
  • Logging Ansible output

Roadmaps

  • Ansible Roadmap




Ansible
  • »
  • Collection Index »
  • Collections in the Community Namespace »
  • Community.Network »
  • community.network.cnos_linkagg module – Manage link aggregation groups on Lenovo CNOS devices


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

Note

This module is part of the community.network collection (version 3.3.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

  • Parameters

  • Notes

  • Examples

  • Return Values

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)

Collection links

Issue Tracker Repository (Sources)

Previous Next

© Copyright Ansible project contributors. Last updated on May 19, 2022.