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 |
|---|---|
List of link aggregation definitions. |
|
List of members interfaces of the link aggregation group. The value can be single interface or list of interfaces. |
|
Mode of the link aggregation group. A value of Choices:
Default: |
|
Name of the link aggregation group. |
|
Purge link aggregation groups not defined in the aggregate parameter. Choices:
|
|
State of the link aggregation group. Choices:
|
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 |
|---|---|
The list of configuration mode commands to send to the device Returned: always. Sample: |