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

Ansible getting started

  • Getting started with Ansible

Installation, Upgrade & Configuration

  • Installation Guide
  • Ansible Porting Guides

Using Ansible

  • Building Ansible inventories
  • Using Ansible command line tools
  • Using Ansible playbooks
  • Protecting sensitive data with Ansible vault
  • Using Ansible modules and plugins
  • Using Ansible collections
  • Using Ansible on Windows and BSD
  • Ansible tips and tricks

Contributing to Ansible

  • Ansible Community Guide
  • Ansible Collections Contributor Guide
  • ansible-core Contributors Guide
  • Advanced Contributor Guide
  • Ansible documentation style 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
      • Cisco.Aci
      • Cisco.Asa
      • Cisco.Dnac
      • Cisco.Intersight
      • Cisco.Ios
        • Description
        • Plugin Index
      • Cisco.Iosxr
      • Cisco.Ise
      • Cisco.Meraki
      • Cisco.Mso
      • Cisco.Nso
      • Cisco.Nxos
      • Cisco.Ucs
    • Collections in the Cloud Namespace
    • Collections in the Cloudscale_ch Namespace
    • Collections in the Community Namespace
    • 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 Grafana 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 Lowlydba 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 Splunk Namespace
    • Collections in the T_systems_mms Namespace
    • Collections in the Theforeman Namespace
    • Collections in the Vmware Namespace
    • Collections in the Vultr 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-core Roadmaps




Ansible
  • Collection Index
  • Collections in the Cisco Namespace
  • Cisco.Ios
  • cisco.ios.ios_linkagg module – Module to configure link aggregation groups.


cisco.ios.ios_linkagg module – Module to configure link aggregation groups.

Note

This module is part of the cisco.ios collection (version 4.3.1).

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 cisco.ios.

To use it in a playbook, specify: cisco.ios.ios_linkagg.

New in cisco.ios 1.0.0

  • DEPRECATED

  • Synopsis

  • Parameters

  • Notes

  • Examples

  • Return Values

  • Status

DEPRECATED

Removed in

major release after 2024-06-01

Why

Updated modules released with more functionality.

Alternative

ios_lag_interfaces

Synopsis

  • This module provides declarative management of link aggregation groups on Cisco IOS network devices.

Note

This module has a corresponding action plugin.

Parameters

Parameter

Comments

aggregate

list / elements=dictionary

List of link aggregation definitions.

group

string / required

Channel-group number for the port-channel Link aggregation group. Range 1-255.

members

list / elements=string

List of members of the link aggregation group.

mode

string

Mode of the link aggregation group.

On mode has to be quoted as ‘on’ or else pyyaml will convert to True before it gets to Ansible.

Choices:

  • "active"

  • "on"

  • "passive"

  • "auto"

  • "desirable"

state

string

State of the link aggregation group.

Choices:

  • "present"

  • "absent"

group

integer

Channel-group number for the port-channel Link aggregation group. Range 1-255.

members

list / elements=string

List of members of the link aggregation group.

mode

string

Mode of the link aggregation group.

On mode has to be quoted as ‘on’ or else pyyaml will convert to True before it gets to Ansible.

Choices:

  • "active"

  • "on"

  • "passive"

  • "auto"

  • "desirable"

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 IOS 15.2

  • This module works with connection network_cli. See https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html

  • For more information on using Ansible to manage network devices see the :ref:`Ansible Network Guide <network_guide>`

  • For more information on using Ansible to manage Cisco devices see the `Cisco integration page <https://www.ansible.com/integrations/networks/cisco>`_.

Examples

- name: Create link aggregation group
  cisco.ios.ios_linkagg:
    group: 10
    state: present

- name: Delete link aggregation group
  cisco.ios.ios_linkagg:
    group: 10
    state: absent

- name: Set link aggregation group to members
  cisco.ios.ios_linkagg:
    group: 200
    mode: active
    members:
    - GigabitEthernet0/0
    - GigabitEthernet0/1

- name: Remove link aggregation group from GigabitEthernet0/0
  cisco.ios.ios_linkagg:
    group: 200
    mode: active
    members:
    - GigabitEthernet0/1

- name: Create aggregate of linkagg definitions
  cisco.ios.ios_linkagg:
    aggregate:
    - {group: 3, mode: on, members: [GigabitEthernet0/1]}
    - {group: 100, mode: passive, members: [GigabitEthernet0/2]}

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 GigabitEthernet0/3", "channel-group 30 mode on", "no interface port-channel 30"]

Status

  • This module will be removed in a major release after 2024-06-01. [deprecated]

  • For more information see DEPRECATED.

Authors

  • Trishna Guha (@trishnaguha)

Collection links

Issue Tracker Repository (Sources)

Previous Next

© Copyright Ansible project contributors. Last updated on Jan 31, 2023.