net_linkagg – Manage link aggregation groups on network devices
New in version 2.4.
Synopsis
- This module provides declarative management of link aggregation groups on network devices.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
aggregate - | List of link aggregation definitions. | |
members - / required | List of members interfaces of the link aggregation group. The value can be single interface or list of interfaces. | |
min_links - | Minimum members that should be up before bringing up the link aggregation group. | |
mode - |
"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 - / required | Name of the link aggregation group. | |
purge - | Default: "no" | Purge link aggregation groups not defined in the aggregate parameter. |
state - |
| State of the link aggregation group. |
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 net_linkagg: name: bond0 members: - eth0 - eth1 - name: remove configuration net_linkagg: name: bond0 state: absent - name: Create aggregate of linkagg definitions net_linkagg: aggregate: - { name: bond0, members: [eth1] } - { name: bond1, members: [eth2] } - name: Remove aggregate of linkagg definitions 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 | 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 is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]
Red Hat Support
More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.
Authors
- Ricardo Carrillo Cruz (@rcarrillocruz)
Hint
If you notice any issues in this documentation you can edit this document to improve it.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/net_linkagg_module.html