community.general.icx_linkagg (0.1.1) — module

Install collection

Install with ansible-galaxy collection install community.general:==0.1.1

Add to requirements.yml

  collections:
    - name: community.general
      version: 0.1.1

Description

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

Usage examples

Scanned by Steampunk Spotter

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

- name: create static link aggregation group
  icx_linkagg:
    group: 10
    mode: static
    name: LAG1

Scanned by Steampunk Spotter

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

- name: create link aggregation group with auto id
  icx_linkagg:
    group: auto
    mode: dynamic
    name: LAG2

Scanned by Steampunk Spotter

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

- name: delete link aggregation group
  icx_linkagg:
    group: 10
    state: absent

Scanned by Steampunk Spotter

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

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

Scanned by Steampunk Spotter

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

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

Inputs

    
mode:
    choices:
    - dynamic
    - static
    description:
    - Mode of the link aggregation group.
    type: str

name:
    description:
    - Name of the LAG
    type: str

group:
    description:
    - Channel-group number for the port-channel Link aggregation group. Range 1-255 or
      set to 'auto' to auto-generates a LAG ID
    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 port members or ranges of the link aggregation group.
    type: list

aggregate:
    description:
    - List of link aggregation definitions.
    suboptions:
      check_running_config:
        description:
        - 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.
        type: bool
      group:
        description:
        - Channel-group number for the port-channel Link aggregation group. Range 1-255
          or set to 'auto' to auto-generates a LAG ID
        type: int
      members:
        description:
        - List of port members or ranges of the link aggregation group.
        type: list
      mode:
        choices:
        - dynamic
        - static
        description:
        - Mode of the link aggregation group.
        type: str
      name:
        description:
        - Name of the LAG
        type: str
      state:
        choices:
        - present
        - absent
        description:
        - State of the link aggregation group.
        type: str
    type: list

check_running_config:
    default: true
    description:
    - 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.
    type: bool

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