ansible.builtin.ios_linkagg (v2.9.24) — module

Manage link aggregation groups on Cisco IOS network devices

| "added in version" 2.5 of ansible.builtin"

Authors: Trishna Guha (@trishnaguha)

preview | supported by network

Install Ansible via pip

Install with pip install ansible==2.9.24

Description

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

Usage examples

  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: create link aggregation group
  ios_linkagg:
    group: 10
    state: present
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: delete link aggregation group
  ios_linkagg:
    group: 10
    state: absent
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: set link aggregation group to members
  ios_linkagg:
    group: 200
    mode: active
    members:
      - GigabitEthernet0/0
      - GigabitEthernet0/1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: remove link aggregation group from GigabitEthernet0/0
  ios_linkagg:
    group: 200
    mode: active
    members:
      - GigabitEthernet0/1
  • Success
    Steampunk Spotter scan finished with no errors, warnings or hints.
- name: Create aggregate of linkagg definitions
  ios_linkagg:
    aggregate:
      - { group: 3, mode: on, members: [GigabitEthernet0/1] }
      - { group: 100, mode: passive, members: [GigabitEthernet0/2] }

Inputs

    
mode:
    choices:
    - active
    - 'on'
    - passive
    - auto
    - desirable
    description:
    - Mode of the link aggregation group.

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

purge:
    default: false
    description:
    - Purge links not defined in the I(aggregate) parameter.
    type: bool

state:
    choices:
    - present
    - absent
    default: present
    description:
    - State of the link aggregation group.

members:
    description:
    - List of members of the link aggregation group.

aggregate:
    description: List of link aggregation definitions.

Outputs

commands:
  description: 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
  type: list