vyos.vyos.vyos_linkagg – (deprecated, removed after 2022-06-01) Manage link aggregation groups on VyOS network devices
Note
This plugin is part of the vyos.vyos collection (version 2.6.0).
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 vyos.vyos.
To use it in a playbook, specify: vyos.vyos.vyos_linkagg.
New in version 1.0.0: of vyos.vyos
DEPRECATED
- Removed in
major release after 2022-06-01
- Why
Updated modules released with more functionality.
- Alternative
vyos_lag_interfaces
Synopsis
This module provides declarative management of link aggregation groups on VyOS network devices.
Note
This module has a corresponding action plugin.
Parameters
| Parameter | Choices/Defaults | Comments | |
|---|---|---|---|
|
aggregate
list
/ elements=dictionary
|
List of link aggregation definitions.
|
||
|
members
list
/ elements=string
|
List of members of the link aggregation group.
|
||
|
mode
string
|
|
Mode of the link aggregation group.
|
|
|
name
string
/ required
|
Name of the link aggregation group.
|
||
|
state
string
|
|
State of the link aggregation group.
|
|
|
members
list
/ elements=string
|
List of members of the link aggregation group.
|
||
|
mode
string
|
|
Mode of the link aggregation group.
|
|
|
name
string
|
Name of the link aggregation group.
|
||
|
provider
dictionary
|
Deprecated
Starting with Ansible 2.5 we recommend using
connection: network_cli.For more information please see the Network Guide.
A dict object containing connection details.
|
||
|
host
string
|
Specifies the DNS host name or address for connecting to the remote device over the specified transport. The value of host is used as the destination address for the transport.
|
||
|
password
string
|
Specifies the password to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_PASSWORD will be used instead. |
||
|
port
integer
|
Specifies the port to use when building the connection to the remote device.
|
||
|
ssh_keyfile
path
|
Specifies the SSH key to use to authenticate the connection to the remote device. This value is the path to the key used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_SSH_KEYFILE will be used instead. |
||
|
timeout
integer
|
Specifies the timeout in seconds for communicating with the network device for either connecting or sending commands. If the timeout is exceeded before the operation is completed, the module will error.
|
||
|
username
string
|
Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate the SSH session. If the value is not specified in the task, the value of environment variable
ANSIBLE_NET_USERNAME will be used instead. |
||
|
state
string
|
|
State of the link aggregation group.
|
|
Notes
Note
Tested against VYOS 1.1.7
For more information on using Ansible to manage network devices see the Ansible Network Guide
Examples
- name: configure link aggregation group
vyos.vyos.vyos_linkagg:
name: bond0
members:
- eth0
- eth1
- name: remove configuration
vyos.vyos.vyos_linkagg:
name: bond0
state: absent
- name: Create aggregate of linkagg definitions
vyos.vyos.vyos_linkagg:
aggregate:
- {name: bond0, members: [eth1]}
- {name: bond1, members: [eth2]}
- name: Remove aggregate of linkagg definitions
vyos.vyos.vyos_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:
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)