mellanox.onyx.onyx_linkagg – Manage link aggregation groups on Mellanox ONYX network devices

Note

This plugin is part of the mellanox.onyx collection (version 1.0.0).

To install it use: ansible-galaxy collection install mellanox.onyx.

To use it in a playbook, specify: mellanox.onyx.onyx_linkagg.

Synopsis

• This module provides declarative management of link aggregation groups on Mellanox ONYX network devices.

Parameters

Parameter	Choices/Defaults	Comments
aggregate string		List of link aggregation definitions.
members string / required		List of members interfaces of the link aggregation group. The value can be single interface or list of interfaces.
mode string	Choices: on active passive Default: "yes"	Mode of the link aggregation group. A value of on will enable LACP. active configures the link to actively information about the state of the link, or it can be configured in passive mode ie. send link state information only when received them from another link.
name string / required		Name of the link aggregation group.
purge boolean	Choices: no ← yes	Purge link aggregation groups not defined in the aggregate parameter.
state string	Choices: present ← absent up down	State of the link aggregation group.

Examples

- name: Configure link aggregation group
  onyx_linkagg:
    name: Po1
    members:
      - Eth1/1
      - Eth1/2

- name: Remove configuration
  onyx_linkagg:
    name: Po1
    state: absent

- name: Create aggregate of linkagg definitions
  onyx_linkagg:
    aggregate:
        - { name: Po1, members: [Eth1/1] }
        - { name: Po2, members: [Eth1/2] }

- name: Remove aggregate of linkagg definitions
  onyx_linkagg:
    aggregate:
      - name: Po1
      - name: Po2
    state: absent

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.	The list of configuration mode commands to send to the device Sample: ['interface port-channel 1', 'exit', 'interface ethernet 1/1 channel-group 1 mode on', 'interface ethernet 1/2 channel-group 1 mode on']

Authors

• Samer Deeb (@samerd)