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).
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 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 |
Comments |
---|---|
List of interfaces LLDP should be configured on. |
|
Name of the interface LLDP should be configured on. |
|
Purge interfaces not defined in the aggregate parameter. Choices:
|
|
State of the LLDP configuration. Choices:
|
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 |
Description |
---|---|
The list of configuration mode commands to send to the device Returned: always. Sample: [“interface ethernet 1/1 lldp transmit”, “interface ethernet 1/1 lldp receive”] |
Authors
Samer Deeb (@samerd)