W3cubDocs

/Ansible 2.11

ansible.netcommon.net_linkagg – (deprecated, removed after 2022-06-01) Manage link aggregation groups on network devices

Note

This plugin is part of the ansible.netcommon collection (version 1.5.0).

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 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.
min_links
string
Minimum members that should be up before bringing up the link aggregation group.
mode
string
    Choices:
  • True
  • 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
string
Default:
"no"
Purge link aggregation groups not defined in the aggregate parameter.
state
string
    Choices:
  • present ←
  • absent
  • up
  • down
State of the link aggregation group.

Notes

Note

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 Returned Description
commands
list / elements=string
always, except for the platforms that use Netconf transport to manage the device.
The list of configuration mode commands to send to the device

Sample:
['set interfaces bonding bond0', "set interfaces ethernet eth0 bond-group 'bond0'", "set interfaces ethernet eth1 bond-group 'bond0'"]


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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/netcommon/net_linkagg_module.html