nxos_lldp_global – Configure and manage Link Layer Discovery Protocol(LLDP) attributes on NX-OS platforms — Ansible Documentation

- AnsibleFest
- Products
- Community
- Webinars & Training
- Blog

Documentation

# nxos_lldp_global – Configure and manage Link Layer Discovery Protocol(LLDP) attributes on NX-OS platforms

New in version 2.9.

- Synopsis
- Parameters
- Notes
- Examples
- Return Values
- Status

## Synopsis

- This module configures and manages the Link Layer Discovery Protocol(LLDP) attributes on NX-OS platforms.

## Parameters

Parameter | Choices/Defaults | Comments
--- | --- | ---
config dictionary |  | A list of link layer discovery configurations
| holdtime integer |  | Amount of time the receiving device should hold the information (in seconds)
| port_id integer | Choices: 0 1 | This attribute defines if the interface names should be advertised in the long(0) or short(1) form.
| reinit integer |  | Amount of time to delay the initialization of LLDP on any interface (in seconds)
| timer integer |  | Frequency at which LLDP updates need to be transmitted (in seconds)
| tlv_select dictionary |  | This attribute can be used to specify the TLVs that need to be sent and received in the LLDP packets. By default, all TLVs are advertised
|  | dcbxp boolean | Choices: no yes | Used to specify the Data Center Bridging Exchange Protocol TLV
|  | management_address dictionary |  | Used to specify the management address in TLV messages
|  |  | v4 boolean | Choices: no yes | Management address with TLV v4
|  |  | v6 boolean | Choices: no yes | Management address with TLV v6
|  | port dictionary |  | Used to manage port based attributes in TLV messages
|  |  | description boolean | Choices: no yes | Used to specify the port description TLV
|  |  | vlan boolean | Choices: no yes | Used to specify the port VLAN ID TLV
|  | power_management boolean | Choices: no yes | Used to specify IEEE 802.3 DTE Power via MDI TLV
|  | system dictionary |  | Used to manage system based attributes in TLV messages
|  |  | capabilities boolean | Choices: no yes | Used to specify the system capabilities TLV
|  |  | description boolean | Choices: no yes | Used to specify the system description TLV
|  |  | name boolean | Choices: no yes | Used to specify the system name TLV
state string | Choices: merged ← replaced deleted | The state of the configuration after module completion

## Notes

Note

- Tested against NxOS 7.3.(0)D1(1) on VIRL
- The LLDP feature needs to be enabled before using this module

## Examples

    # Using merged
    # Before state:
    # -------------
    #
    # user(config)# show running-config | include lldp
    # feature lldp

    - name: Merge provided configuration with device configuration
      nxos_lldp_global:
        config:
          timer: 35
          holdtime: 100
        state: merged

    # After state:
    # ------------
    #
    # user(config)# show running-config | include lldp
    # feature lldp
    # lldp timer 35
    # lldp holdtime 100

    # Using replaced
    # Before state:
    # -------------
    #
    # user(config)# show running-config | include lldp
    # feature lldp
    # lldp holdtime 100
    # lldp reinit 5
    # lldp timer 35

    - name: Replace device configuration of specific LLDP attributes with provided configuration
      nxos_lldp_global:
        config:
          timer: 40
          tlv_select:
            system:
              description: true
              name: false
            management_address:
              v4: true
        state: replaced

    # After state:
    # ------------
    #
    # user(config)# show running-config | include lldp
    # feature lldp
    # lldp timer 40
    # no lldp tlv-select system-name

    # Using deleted
    # Before state:
    # -------------
    #
    # user(config)# show running-config | include lldp
    # feature lldp
    # lldp holdtime 5
    # lldp reinit 3

    - name: Delete LLDP configuration (this will by default remove all lldp configuration)
      nxos_lldp_global:
        state: deleted

    # After state:
    # ------------
    #
    # user(config)# show running-config | include lldp
    # feature lldp

## Return Values

Common return values are documented here, the following are the fields unique to this module:

Key | Returned | Description
--- | --- | ---
after dictionary | when changed | The configuration as structured data after module completion. Sample: The configuration returned will always be in the same format of the parameters above.
before dictionary | always | The configuration as structured data prior to module invocation. Sample: The configuration returned will always be in the same format of the parameters above.
commands list | always | The set of commands pushed to the remote device. Sample: ['lldp holdtime 125', 'lldp reinit 4', 'no lldp tlv-select system-name']

## Status

- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Network Team. [network]

### Red Hat Support

More information about Red Hat’s support of this module is available from this Red Hat Knowledge Base article.

### Authors

- Adharsh Srivats Rangarajan (@adharshsrivatsr)

Hint

If you notice any issues in this documentation, you can edit this document to improve it.