W3cubDocs

/Ansible

mellanox.onyx.onyx_lldp – Manage LLDP 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.

Synopsis

  • This module provides declarative management of LLDP service configuration on Mellanox ONYX network devices.

Parameters

Parameter Choices/Defaults Comments
state
string
    Choices:
  • present ←
  • absent
State of the LLDP protocol configuration.

Examples

- name: Enable LLDP protocol
  onyx_lldp:
    state: present

- name: Disable LLDP protocol
  onyx_lldp:
    state: lldp

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:
['lldp']


Authors

  • Samer Deeb (@samerd)

© 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/mellanox/onyx/onyx_lldp_module.html