vyos_linkagg - Manage link aggregation groups on VyOS network devices
New in version 2.4.
Synopsis
- This module provides declarative management of link aggregation groups on VyOS network devices.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
aggregate | no | List of link aggregation definitions. | ||
members | no | List of members of the link aggregation group. | ||
mode | no |
| Mode of the link aggregation group. | |
name | yes | Name of the link aggregation group. | ||
state | no | present |
| State of the link aggregation group. |
Examples
- name: configure link aggregation group vyos_linkagg: name: bond0 members: - eth0 - eth1 - name: remove configuration vyos_linkagg: name: bond0 state: absent - name: Create aggregate of linkagg definitions vyos_linkagg: aggregate: - { name: bond0, members: [eth1] } - { name: bond1, members: [eth2] } - name: Remove aggregate of linkagg definitions vyos_linkagg: aggregate: - name: bond0 - name: bond1 state: absent
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
commands | The list of configuration mode commands to send to the device | always, except for the platforms that use Netconf transport to manage the device. | list | ['set interfaces bonding bond0', "set interfaces ethernet eth0 bond-group 'bond0'", "set interfaces ethernet eth1 bond-group 'bond0'"] |
Notes
Note
- Tested against VYOS 1.1.7
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/vyos_linkagg_module.html