W3cubDocs

/Ansible 2.10

ansible.netcommon.net_lldp_interface – (deprecated, removed after 2022-06-01) Manage LLDP interfaces configuration on network devices

Note

This plugin is part of the ansible.netcommon collection.

To install it use: ansible-galaxy collection install ansible.netcommon.

To use it in a playbook, specify: ansible.netcommon.net_lldp_interface.

New in version 1.0.0: of ansible.netcommon

DEPRECATED

Removed in

major release after 2022-06-01

Why

Updated modules released with more functionality

Alternative

Use platform-specific “[netos]_lldp_interfaces” module

Synopsis

  • This module provides declarative management of LLDP interfaces configuration on network devices.

Note

This module has a corresponding action plugin.

Parameters

Parameter Choices/Defaults Comments
aggregate
string
List of interfaces LLDP should be configured on.
name
string
Name of the interface LLDP should be configured on.
purge
string
Default:
"no"
Purge interfaces not defined in the aggregate parameter.
state
string
    Choices:
  • present ←
  • absent
  • enabled
  • disabled
State of the LLDP configuration.

Notes

Note

Examples

- name: Configure LLDP on specific interfaces
  ansible.netcommon.net_lldp_interface:
    name: eth1
    state: present

- name: Disable LLDP on specific interfaces
  ansible.netcommon.net_lldp_interface:
    name: eth1
    state: disabled

- name: Enable LLDP on specific interfaces
  ansible.netcommon.net_lldp_interface:
    name: eth1
    state: enabled

- name: Delete LLDP on specific interfaces
  ansible.netcommon.net_lldp_interface:
    name: eth1
    state: absent

- name: Create aggregate of LLDP interface configurations
  ansible.netcommon.net_lldp_interface:
    aggregate:
    - {name: eth1}
    - {name: eth2}
    state: present

- name: Delete aggregate of LLDP interface configurations
  ansible.netcommon.net_lldp_interface:
    aggregate:
    - {name: eth1}
    - {name: eth2}
    state: absent

Return Values

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 eth1 disable']


Status

  • This module will be removed in a major release after 2022-06-01. [deprecated]
  • For more information see DEPRECATED.

Authors

  • Ganesh Nalawade (@ganeshrn)

© 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/ansible/netcommon/net_lldp_interface_module.html