eos_lldp - Manage LLDP configuration on Arista EOS network devices¶

New in version 2.5.

Synopsis
Parameters
Notes
Examples
Return Values
Status
- Support
- Author

Synopsis ¶

This module provides declarative management of LLDP service on Arista EOS network devices.

Parameters ¶

Parameter	Choices/Defaults	Comments
auth_pass		Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli` and `become: yes` with `become_pass`. This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTH_PASS` will be used instead.
authorize	Choices: no ← yes	Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli` and `become: yes`. This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTHORIZE` will be used instead.
provider		Deprecated Starting with Ansible 2.5 we recommend using `connection: network_cli`. This option is only required if you are using eAPI. For more information please see the EOS Platform Options guide. A dict object containing connection details.
username		Configures the username to use to authenticate the connection to the remote device. This value is used to authenticate either the CLI login or the eAPI authentication depending on which transport is used. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_USERNAME` will be used instead.
authorize	Choices: no ← yes	Instructs the module to enter privileged mode on the remote device before sending any commands. If not specified, the device will attempt to execute all commands in non-privileged mode. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTHORIZE` will be used instead.
ssh_keyfile		Specifies the SSH keyfile to use to authenticate the connection to the remote device. This argument is only used for cli transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_SSH_KEYFILE` will be used instead.
use_proxy (added in 2.5)	Choices: no yes ←	If `no`, the environment variables `http_proxy` and `https_proxy` will be ignored.
auth_pass		Specifies the password to use if required to enter privileged mode on the remote device. If authorize is false, then this argument does nothing. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_AUTH_PASS` will be used instead.
host required		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.
timeout	Default: 10	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.
use_ssl	Choices: no yes ←	Configures the transport to use SSL if set to true only when the `transport=eapi`. If the transport argument is not eapi, this value is ignored.
password		Specifies the password to use to authenticate the connection to the remote device. This is a common argument used for either cli or eapi transports. If the value is not specified in the task, the value of environment variable `ANSIBLE_NET_PASSWORD` will be used instead.
validate_certs	Choices: no yes	If `no`, SSL certificates will not be validated. This should only be used on personally controlled sites using self-signed certificates. If the transport argument is not eapi, this value is ignored.
port	Default: 0 (use common port)	Specifies the port to use when building the connection to the remote device. This value applies to either cli or eapi. The port value will default to the appropriate transport common port if none is provided in the task. (cli=22, http=80, https=443).
transport required	Choices: eapi cli ←	Configures the transport connection to use when connecting to the remote device.
state	Choices: present ← absent	State of the LLDP configuration. If value is present lldp will be enabled else if it is absent it will be disabled.

Notes ¶

Note

Tested against EOS 4.15
For information on using CLI, eAPI and privileged mode see the EOS Platform Options guide
For more information on using Ansible to manage network devices see the Ansible Network Guide
For more information on using Ansible to manage Arista EOS devices see the Arista integration page.

Examples ¶

- name: Enable LLDP service
  eos_lldp:
    state: present

- name: Disable LLDP service
  eos_lldp:
    state: absent

Return Values ¶

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
commands list	always, except for the platforms that use Netconf transport to manage the device.	The list of configuration mode commands to send to the device Sample: ['lldp run']

Status ¶

This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.

Support ¶

For more information about Red Hat’s support of this module, please refer to this Knowledge Base article

Author ¶

Ganesh Nalawade (@ganeshrn)

Hint

If you notice any issues in this documentation you can edit this document to improve it.