mellanox.onyx.onyx_lldp_interface – Manage LLDP interfaces configuration on Mellanox ONYX network devices
Note
This plugin is part of the mellanox.onyx collection (version 1.0.0).
To install it use: ansible-galaxy collection install mellanox.onyx.
To use it in a playbook, specify: mellanox.onyx.onyx_lldp_interface.
Synopsis
- This module provides declarative management of LLDP interfaces configuration on Mellanox ONYX network devices.
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
boolean
|
|
Purge interfaces not defined in the aggregate parameter.
|
| state
string
|
|
State of the LLDP configuration.
|
Examples
- name: Configure LLDP on specific interfaces
onyx_lldp_interface:
name: Eth1/1
state: present
- name: Disable LLDP on specific interfaces
onyx_lldp_interface:
name: Eth1/1
state: disabled
- name: Enable LLDP on specific interfaces
onyx_lldp_interface:
name: Eth1/1
state: enabled
- name: Delete LLDP on specific interfaces
onyx_lldp_interface:
name: Eth1/1
state: absent
- name: Create aggregate of LLDP interface configurations
onyx_lldp_interface:
aggregate:
- { name: Eth1/1 }
- { name: Eth1/2 }
state: present
- name: Delete aggregate of LLDP interface configurations
onyx_lldp_interface:
aggregate:
- { name: Eth1/1 }
- { name: Eth1/2 }
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. |
The list of configuration mode commands to send to the device
Sample:
['interface ethernet 1/1 lldp transmit', 'interface ethernet 1/1 lldp receive']
|
Authors
- Samer Deeb (@samerd)
© 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/mellanox/onyx/onyx_lldp_interface_module.html