You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation .
vyos_linkagg - Manage link aggregation groups on VyOS network devices
This module provides declarative management of link aggregation groups on VyOS network devices.
parameter
required
default
choices
comments
aggregate
no
List of link aggregation definitions.
members
no
List of members of the link aggregation group.
mode
no
802.3ad active-backup broadcast round-robin transmit-load-balance adaptive-load-balance xor-hash on
Mode of the link aggregation group.
name
yes
Name of the link aggregation group.
state
no
present
State of the link aggregation group.
- 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
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'"]
Note
Tested against VYOS 1.1.7
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
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 .
Copyright © 2017 Red Hat, Inc.
Last updated on Nov 15, 2022.
Ansible docs are generated from GitHub sources using Sphinx using a theme provided by Read the Docs . . Module documentation is not edited directly, but is generated from the source code for the modules. To submit an update to module docs, edit the 'DOCUMENTATION' metadata in the modules directory of the core source code repository .