arista.eos.eos_lacp – LACP resource module
Note
This plugin is part of the arista.eos collection (version 1.2.0).
To install it use: ansible-galaxy collection install arista.eos.
To use it in a playbook, specify: arista.eos.eos_lacp.
New in version 1.0.0: of arista.eos
Synopsis
- This module manages Global Link Aggregation Control Protocol (LACP) on Arista EOS devices.
Note
This module has a corresponding action plugin.
Parameters
| Parameter | Choices/Defaults | Comments | ||
|---|---|---|---|---|
| config
dictionary
|
LACP global options.
|
|||
| system
dictionary
|
LACP system options.
|
|||
| priority
integer
|
The system priority to use in LACP negotiations.
Lower value is higher priority.
Refer to vendor documentation for valid values.
|
|||
| running_config
string
|
This option is used only with state parsed.
The value of this option should be the output received from the EOS device by executing the command show running-config | section ^lacp.
The state parsed reads the configuration from running_config option and transforms it into Ansible structured data as per the resource module's argspec and the value is then returned in the parsed key within the result.
|
|||
| state
string
|
|
The state of the configuration after module completion.
|
||
Notes
Note
- Tested against Arista EOS 4.20.10M
- This module works with connection
network_cli. See the EOS Platform Options.
Examples
# Using merged
# Before state:
# -------------
# veos# show running-config | include lacp
# lacp system-priority 10
- name: Merge provided global LACP attributes with device attributes
arista.eos.eos_lacp:
config:
system:
priority: 20
state: merged
# After state:
# ------------
# veos# show running-config | include lacp
# lacp system-priority 20
#
# Using replaced
# Before state:
# -------------
# veos# show running-config | include lacp
# lacp system-priority 10
- name: Replace device global LACP attributes with provided attributes
arista.eos.eos_lacp:
config:
system:
priority: 20
state: replaced
# After state:
# ------------
# veos# show running-config | include lacp
# lacp system-priority 20
#
# Using deleted
# Before state:
# -------------
# veos# show running-config | include lacp
# lacp system-priority 10
- name: Delete global LACP attributes
arista.eos.eos_lacp:
state: deleted
# After state:
# ------------
# veos# show running-config | include lacp
#
#Using rendered:
- name: Use Rendered to convert the structured data to native config
arista.eos.eos_lacp:
config:
system:
priority: 20
state: rendered
# Output:
# ------------
# rendered:
# - "lacp system-priority 20"
#
# Using parsed:
# parsed.cfg
# lacp system-priority 20
- name: Use parsed to convert native configs to structured data
arista.eos.eos_lacp:
running_config: "{{ lookup('file', 'parsed.cfg') }}"
state: parsed
# Output:
# parsed:
# system:
# priority: 20
# Using gathered:
# nathive config:
# -------------
# lacp system-priority 10
- name: Gather lacp facts from the device
arista.eos.eos_lacp:
state: gathered
# Output:
# gathered:
# system:
# priority: 10
#
Return Values
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| after
dictionary
|
when changed |
The configuration as structured data after module completion.
Sample:
The configuration returned will always be in the same format of the parameters above.
|
| before
dictionary
|
always |
The configuration as structured data prior to module invocation.
Sample:
The configuration returned will always be in the same format of the parameters above.
|
| commands
list / elements=string
|
always |
The set of commands pushed to the remote device.
Sample:
['lacp system-priority 10']
|
Authors
- Nathaniel Case (@Qalthos)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/arista/eos/eos_lacp_module.html