arista.eos.eos_lldp_interfaces – LLDP interfaces resource module
arista.eos.eos_lldp_interfaces – LLDP interfaces resource module
Note
This plugin is part of the arista.eos collection (version 1.3.0).
To install it use: ansible-galaxy collection install arista.eos
.
To use it in a playbook, specify: arista.eos.eos_lldp_interfaces
.
New in version 1.0.0: of arista.eos
Synopsis
- This module manages Link Layer Discovery Protocol (LLDP) attributes of interfaces on Arista EOS devices.
Parameters
Parameter | Choices/Defaults | Comments | |
---|---|---|---|
config list / elements=dictionary |
A dictionary of LLDP interfaces options. | ||
name string |
Full name of the interface (i.e. Ethernet1). | ||
receive boolean |
|
Enable/disable LLDP RX on an interface. | |
transmit boolean |
|
Enable/disable LLDP TX on an interface. | |
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 ^interface. The state parsed reads the configuration from | ||
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 run | section ^interface
# interface Ethernet1
# no lldp receive
# interface Ethernet2
# no lldp transmit
- name: Merge provided configuration with running configuration
arista.eos.eos_lldp_interfaces:
config:
- name: Ethernet1
transmit: false
- name: Ethernet2
transmit: false
state: merged
#
# ------------
# After state
# ------------
#
# veos#show run | section ^interface
# interface Ethernet1
# no lldp transmit
# no lldp receive
# interface Ethernet2
# no lldp transmit
# Using replaced
#
#
# ------------
# Before state
# ------------
#
#
# veos#show run | section ^interface
# interface Ethernet1
# no lldp receive
# interface Ethernet2
# no lldp transmit
- name: Replace existing LLDP configuration of specified interfaces with provided
configuration
arista.eos.eos_lldp_interfaces:
config:
- name: Ethernet1
transmit: false
state: replaced
#
# ------------
# After state
# ------------
#
# veos#show run | section ^interface
# interface Ethernet1
# no lldp transmit
# interface Ethernet2
# no lldp transmit
# Using overridden
#
#
# ------------
# Before state
# ------------
#
#
# veos#show run | section ^interface
# interface Ethernet1
# no lldp receive
# interface Ethernet2
# no lldp transmit
- name: Override the LLDP configuration of all the interfaces with provided configuration
arista.eos.eos_lldp_interfaces:
config:
- name: Ethernet1
transmit: false
state: overridden
#
# ------------
# After state
# ------------
#
# veos#show run | section ^interface
# interface Ethernet1
# no lldp transmit
# interface Ethernet2
# Using deleted
#
#
# ------------
# Before state
# ------------
#
#
# veos#show run | section ^interface
# interface Ethernet1
# no lldp receive
# interface Ethernet2
# no lldp transmit
- name: Delete LLDP configuration of specified interfaces (or all interfaces if none
are specified)
arista.eos.eos_lldp_interfaces:
state: deleted
#
# ------------
# After state
# ------------
#
# veos#show run | section ^interface
# interface Ethernet1
# interface Ethernet2
# using rendered:
- name: Use Rendered to convert the structured data to native config
arista.eos.eos_lldp_interfaces:
config:
- name: Ethernet1
transmit: false
- name: Ethernet2
transmit: false
state: rendered
#
# ------------
# Output
# ------------
#
# interface Ethernet1
# no lldp transmit
# interface Ethernet2
# no lldp transmit
# Using parsed
# parsed.cfg
# interface Ethernet1
# no lldp transmit
# interface Ethernet2
# no lldp transmit
- name: Use parsed to convert native configs to structured data
arista.eos.lldp_interfaces:
running_config: "{{ lookup('file', 'parsed.cfg') }}"
state: parsed
# ------------
# Output
# ------------
# parsed:
# - name: Ethernet1
# transmit: False
# - name: Ethernet2
# transmit: False
# Using gathered:
# native config:
# interface Ethernet1
# no lldp transmit
# interface Ethernet2
# no lldp transmit
- name: Gather lldp interfaces facts from the device
arista.eos.lldp_interfaces:
state: gathered
# ------------
# Output
# ------------
# gathered:
# - name: Ethernet1
# transmit: False
# - name: Ethernet2
# transmit: False
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key | Returned | Description |
---|---|---|
after list / elements=string |
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 list / elements=string |
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: ['interface Ethernet1', 'no lldp transmit'] |
Authors
- Nathaniel Case (@Qalthos)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/arista/eos/eos_lldp_interfaces_module.html