On this page
net_lldp_interface - Manage LLDP interfaces configuration on network devices
New in version 2.4.
Synopsis
- This module provides declarative management of LLDP interfaces configuration on network devices.
Options
parameter | required | default | choices | comments |
---|---|---|---|---|
aggregate |
no |
List of interfaces LLDP should be configured on.
|
||
name |
no |
Name of the interface LLDP should be configured on.
|
||
purge |
no |
Purge interfaces not defined in the aggregate parameter.
|
||
state |
no | present |
|
State of the LLDP configuration.
|
Examples
- name: Configure LLDP on specific interfaces
net_lldp_interface:
name: eth1
state: present
- name: Disable LLDP on specific interfaces
net_lldp_interface:
name: eth1
state: disabled
- name: Enable LLDP on specific interfaces
net_lldp_interface:
name: eth1
state: enabled
- name: Delete LLDP on specific interfaces
net_lldp_interface:
name: eth1
state: absent
- name: Create aggregate of LLDP interface configurations
net_lldp_interface:
aggregate:
- { name: eth1 }
- { name: eth2 }
state: present
- name: Delete aggregate of LLDP interface configurations
net_lldp_interface:
aggregate:
- { name: eth1 }
- { name: eth2 }
state: absent
Return Values
Common return values are documented here Return Values, the following are the fields unique to this module:
name | description | returned | type | sample |
---|---|---|---|---|
commands |
The list of configuration mode commands to send to the device
|
always, except for the platforms that use Netconf transport to manage the device. | list | ['set service lldp eth1 disable'] |
Status
This module is flagged as preview which means that it is not guaranteed to have a backwards compatible interface.
Maintenance Info
For more information about Red Hat’s this support of this module, please refer to this knowledge base article<https://access.redhat.com/articles/rhel-top-support-policies>
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, Testing Ansible and Developing Modules.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.4/net_lldp_interface_module.html