You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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

Note

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

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

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	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	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. Choices: on active passive Default: “yes”
name string / required	Name of the link aggregation group.
purge boolean	Purge link aggregation groups not defined in the aggregate parameter. Choices: no ← (default) yes
state string	State of the link aggregation group. Choices: present ← (default) absent up down

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	Description
commands list / elements=string	The list of configuration mode commands to send to the device Returned: always. 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)

Collection links

Issue Tracker Repository (Sources)