cisco.ios.ios_linkagg (8.0.0) — module

Install collection

Install with ansible-galaxy collection install cisco.ios:==8.0.0

Add to requirements.yml

  collections:
    - name: cisco.ios
      version: 8.0.0

Description

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

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

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

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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] }

Inputs

    
mode:
    choices:
    - active
    - 'on'
    - passive
    - auto
    - desirable
    description:
    - 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.
    type: str

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

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.
    type: str

members:
    description:
    - List of members of the link aggregation group.
    elements: str
    type: list

aggregate:
    description: List of link aggregation definitions.
    elements: dict
    suboptions:
      group:
        description:
        - Channel-group number for the port-channel Link aggregation group. Range 1-255.
        required: true
        type: str
      members:
        description:
        - List of members of the link aggregation group.
        elements: str
        type: list
      mode:
        choices:
        - active
        - 'on'
        - passive
        - auto
        - desirable
        description:
        - 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.
        type: str
      state:
        choices:
        - present
        - absent
        description:
        - State of the link aggregation group.
        type: str
    type: list

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