W3cubDocs

/Ansible 2.11

community.network.icx_linkagg – Manage link aggregation groups on Ruckus ICX 7000 series switches

Note

This plugin is part of the community.network collection (version 2.0.1).

To install it use: ansible-galaxy collection install community.network.

To use it in a playbook, specify: community.network.icx_linkagg.

Synopsis

  • This module provides declarative management of link aggregation groups on Ruckus ICX network devices.

Parameters

Parameter Choices/Defaults Comments
aggregate
list / elements=string
List of link aggregation definitions.
check_running_config
boolean
    Choices:
  • no
  • yes
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter.
group
integer
Channel-group number for the port-channel Link aggregation group. Range 1-255 or set to 'auto' to auto-generates a LAG ID
members
list / elements=string
List of port members or ranges of the link aggregation group.
mode
string
    Choices:
  • dynamic
  • static
Mode of the link aggregation group.
name
string
Name of the LAG
state
string
    Choices:
  • present
  • absent
State of the link aggregation group.
check_running_config
boolean
    Choices:
  • no
  • yes ←
Check running configuration. This can be set as environment variable. Module will use environment variable value(default:True), unless it is overridden, by specifying it as module parameter.
group
integer
Channel-group number for the port-channel Link aggregation group. Range 1-255 or set to 'auto' to auto-generates a LAG ID
members
list / elements=string
List of port members or ranges of the link aggregation group.
mode
string
    Choices:
  • dynamic
  • static
Mode of the link aggregation group.
name
string
Name of the LAG
purge
boolean
    Choices:
  • no ←
  • yes
Purge links not defined in the aggregate parameter.
state
string
    Choices:
  • present ←
  • absent
State of the link aggregation group.

Notes

Note

Examples

- name: Create static link aggregation group
  community.network.icx_linkagg:
    group: 10
    mode: static
    name: LAG1

- name: Create link aggregation group with auto id
  community.network.icx_linkagg:
    group: auto
    mode: dynamic
    name: LAG2

- name: Delete link aggregation group
  community.network.icx_linkagg:
    group: 10
    state: absent

- name: Set members to LAG
  community.network.icx_linkagg:
    group: 200
    mode: static
    members:
      - ethernet 1/1/1 to 1/1/6
      - ethernet 1/1/10

- name: Remove links other then LAG id 100 and 3 using purge
  community.network.icx_linkagg:
    aggregate:
      - { group: 3}
      - { group: 100}
    purge: true

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
commands
list / elements=string
always, except for the platforms that use Netconf transport to manage the device.
The list of configuration mode commands to send to the device

Sample:
['lag LAG1 dynamic id 11', 'ports ethernet 1/1/1 to 1/1/6', 'no ports ethernet 1/1/10', 'no lag LAG1 dynamic id 12']


Authors

  • Ruckus Wireless (@Commscope)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/network/icx_linkagg_module.html