ansible.netcommon.net_linkagg module – (deprecated, removed after 2022-06-01) Manage link aggregation groups on network devices
Note
This module is part of the ansible.netcommon collection (version 2.6.1).
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 ansible.netcommon
.
To use it in a playbook, specify: ansible.netcommon.net_linkagg
.
New in version 1.0.0: of ansible.netcommon
DEPRECATED
- Removed in
major release after 2022-06-01
- Why
Updated modules released with more functionality
- Alternative
Use platform-specific “[netos]_lag_interfaces” module
Synopsis
This module provides declarative management of link aggregation groups on network devices.
Note
This module has a corresponding action plugin.
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. |
|
Minimum members that should be up before bringing up the link aggregation group. |
|
Mode of the link aggregation group. A value of Choices:
Default: “yes” |
|
Name of the link aggregation group. |
|
Purge link aggregation groups not defined in the aggregate parameter. Default: “no” |
|
State of the link aggregation group. Choices:
|
Notes
Note
This module is supported on
ansible_network_os
network platforms. See the Network Platform Options for details.
Examples
- name: configure link aggregation group
ansible.netcommon.net_linkagg:
name: bond0
members:
- eth0
- eth1
- name: remove configuration
ansible.netcommon.net_linkagg:
name: bond0
state: absent
- name: Create aggregate of linkagg definitions
ansible.netcommon.net_linkagg:
aggregate:
- {name: bond0, members: [eth1]}
- {name: bond1, members: [eth2]}
- name: Remove aggregate of linkagg definitions
ansible.netcommon.net_linkagg:
aggregate:
- name: bond0
- name: bond1
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, except for the platforms that use Netconf transport to manage the device. Sample: [“set interfaces bonding bond0”, “set interfaces ethernet eth0 bond-group \u0027bond0\u0027”, “set interfaces ethernet eth1 bond-group \u0027bond0\u0027”] |
Status
This module will be removed in a major release after 2022-06-01. [deprecated]
For more information see DEPRECATED.
Authors
Ricardo Carrillo Cruz (@rcarrillocruz)