/ home / dellemc / dellemc.enterprise_sonic / 2.4.0 / module / sonic_lldp_global

dellemc.enterprise_sonic.sonic_lldp_global (2.4.0) — module

Manage Global LLDP configurations on SONiC

| "added in version" 2.1.0 of dellemc.enterprise_sonic"

Authors: Divya Balasubramanian(@divya-balasubramania)

Install collection

Install with ansible-galaxy collection install dellemc.enterprise_sonic:==2.4.0

Add to requirements.yml

  collections:
    - name: dellemc.enterprise_sonic
      version: 2.4.0

Description

This module provides configuration management of global LLDP parameters for use on LLDP enabled Layer 2 interfaces of devices running SONiC.

It is intended for use in conjunction with LLDP Layer 2 interface configuration applied on participating interfaces.

Usage examples

Scanned by Steampunk Spotter

# Using deleted
#
# Before State:
# -------------
#
# sonic# show running-configuration
# !
# lldp receive
# lldp timer 200
# lldp multiplier 1
# lldp system-name 8999_System
# lldp system-description sonic_system
# !

  - name: Delete LLDP configurations
    dellemc.enterprise_sonic.sonic_lldp_global:
      config:
        hello_time: 200
        system_description : sonic_system
        mode: receive
        multiplier: 1
      state: deleted

Scanned by Steampunk Spotter

# After State:
# ------------
# sonic# show running-configuration | grep lldp
# !
# lldp system-name 8999_System
# !
# sonic#


# Using deleted
#
# Before State:
# -------------
#
# sonic# show running-configuration | grep lldp
# sonic#

  - name: Delete default LLDP configurations
    dellemc.enterprise_sonic.sonic_lldp_global:
      config:
        tlv_select:
          system_capabilities: true
      state: deleted

Scanned by Steampunk Spotter

# After State:
# ------------
# sonic# show running-configuration
# !
# no lldp tlv-select system-capabilities
# !


# Using deleted
#
# Before State:
# -------------
#
# sonic# show running-configuration | grep lldp
# !
# lldp receive
# lldp timer 200
# lldp multiplier 1
# lldp system-name 8999_System
# lldp system-description sonic_system
# !

  - name: Delete all LLDP configuration
    dellemc.enterprise_sonic.sonic_lldp_global:
      config:
      state: deleted

Scanned by Steampunk Spotter

# After State:  (No LLDP global configuration present.)
# ------------
# sonic# show running-configuration | grep lldp
# sonic#


# Using Merged
#
# Before State:
# -------------
#
# sonic# show running-configuration | grep lldp
# sonic#

  - name: Modify LLDP configurations
    dellemc.enterprise_sonic.sonic_lldp_global:
      config:
        enable: false
        multiplier: 9
        system_name : CR_sonic
        hello_time: 18
        mode: receive
        system_description: Sonic_System
        tlv_select:
          management_address: true
          system_capabilities: false
      state: merged

Scanned by Steampunk Spotter

# After State:
# ------------
# sonic# show running-configuration | grep lldp
# !
# no lldp enable
# no lldp tlv-select system_capabilities
# lldp receive
# lldp timer 18
# lldp multiplier 9
# lldp system-name CR_sonic
# lldp system-description Sonic_System
# !


# Using Merged
#
# Before State:
# -------------
#
# sonic# show running-configuration | grep lldp
# !
# lldp receive
# lldp timer 200
# lldp multiplier 1
# lldp system-name 8999_System
# lldp system-description sonic_system
# !

  - name: Modify LLDP configurations
    dellemc.enterprise_sonic.sonic_lldp_global:
      config:
         multiplier: 9
         system_name : CR_sonic
      state: merged

Inputs

state:
choices:
- merged
- deleted
default: merged
description:
- The state specifies the type of configuration update to be performed on the device.
- If the state is "merged", merge specified attributes with existing configured attributes.
- For "deleted", delete the specified attributes from existing configuration.
type: str

config:
description: The set of link layer discovery protocol global attribute configurations
suboptions:
enable:
description:
- This argument is a boolean value to enable or disable LLDP.
type: bool
hello_time:
description:
- Frequency at which LLDP advertisements are sent (in seconds).
- The range is from 5 to 254 sec
type: int
mode:
choices:
- receive
- transmit
description:
- By default both transmit and receive of LLDP frames is enabled.
- This command can be used to configure either in receive only or transmit only
mode.
type: str
multiplier:
description:
- Multiplier value is used to determine the timeout interval (i.e. hello-time
x multiplier value)
- The range is from 1 to 10
type: int
system_description:
description:
- Description of this system to be sent in LLDP advertisements.
- When configured, this value is used in the advertisements instead of the default
system description.
type: str
system_name:
description:
- Specifying a descriptive system name using this command, user may find it easier
to distinguish the device with LLDP.
- By default, the host name is used.
type: str
tlv_select:
description:
- By default, management address and system capabilities TLV are advertised in
LLDP frames.
- This configuration option can be used to selectively suppress sending of these
TLVs to the Peer.
suboptions:
management_address:
description:
- Enable or disable management address TLV.
type: bool
system_capabilities:
description:
- Enable or disable system capabilities TLV.
type: bool
type: dict
type: dict

Outputs

after:
  description: The resulting configuration model invocation.
  returned: when changed
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
  type: list
before:
  description: The configuration prior to the model invocation.
  returned: always
  sample: "The configuration returned will always be in the same format\n of the parameters\
    \ above.\n"
  type: list
commands:
  description: The set of commands pushed to the remote device.
  returned: always
  sample:
  - command 1
  - command 2
  - command 3
  type: list