Note
This plugin is part of the ansible.netcommon collection (version 2.4.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 ansible.netcommon.
To use it in a playbook, specify: ansible.netcommon.net_lldp.
New in version 1.0.0: of ansible.netcommon
major release after 2022-06-01
Updated modules released with more functionality
Use platform-specific “[netos]_lldp_global” module
Note
This module has a corresponding action plugin.
| Parameter | Choices/Defaults | Comments |
|---|---|---|
| state string |
| State of the LLDP service configuration. |
Note
ansible_network_os network platforms. See the Network Platform Options for details.- name: Enable LLDP service
ansible.netcommon.net_lldp:
state: present
- name: Disable LLDP service
ansible.netcommon.net_lldp:
state: absent
Common return values are documented here, the following are the fields unique to this module:
| Key | Returned | Description |
|---|---|---|
| commands list / elements=string | 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: ['set service lldp'] |
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/ansible/netcommon/net_lldp_module.html