dellemc.enterprise_sonic.sonic_lldp_global 模块 – 在 SONiC 上管理全局 LLDP 配置

注意

此模块是 dellemc.enterprise_sonic 集合（版本 2.5.1）的一部分。

如果您正在使用 ansible 包，您可能已经安装了此集合。它不包含在 ansible-core 中。要检查是否已安装，请运行 ansible-galaxy collection list。

要安装它，请使用：ansible-galaxy collection install dellemc.enterprise_sonic。

要在 playbook 中使用它，请指定：dellemc.enterprise_sonic.sonic_lldp_global。

dellemc.enterprise_sonic 2.1.0 中的新功能

概要

  • 此模块提供全局 LLDP 参数的配置管理，以便在运行 SONiC 的设备的 LLDP 启用二层接口上使用。

  • 它旨在与在参与接口上应用的 LLDP 二层接口配置结合使用。

参数

参数

注释

config

字典

链路层发现协议全局属性配置集

enable

布尔值

此参数是一个布尔值，用于启用或禁用 LLDP。

选项

  • false

  • true

hello_time

整数

发送 LLDP 广播的频率（以秒为单位）。

范围是 5 到 254 秒

mode

字符串

默认情况下，启用 LLDP 帧的发送和接收。

此命令可用于配置为仅接收或仅发送模式。

选项

  • "receive"

  • "transmit"

multiplier

整数

乘数值用于确定超时间隔（即 hello-time x 乘数值）

范围是 1 到 10

system_description

字符串

要在 LLDP 广播中发送的此系统的描述。

配置后，此值将用于广播中，而不是默认的系统描述。

system_name

字符串

使用此命令指定描述性系统名称，用户可能会发现使用 LLDP 更容易区分设备。

默认情况下，使用主机名。

tlv_select

字典

默认情况下，管理地址和系统功能 TLV 在 LLDP 帧中广播。

此配置选项可用于选择性地禁止向对等方发送这些 TLV。

management_address

布尔值

启用或禁用管理地址 TLV。

选项

  • false

  • true

system_capabilities

布尔值

启用或禁用系统功能 TLV。

选项

  • false

  • true

state

字符串

状态指定要在设备上执行的配置更新类型。

如果状态为“merged”，则将指定的属性与现有的配置属性合并。

对于“deleted”，则从现有配置中删除指定的属性。

选项

  • "merged" ← （默认）

  • "deleted"

注意

注意

  • 已针对戴尔科技公司的 Enterprise SONiC 发行版进行测试。

  • 支持 check_mode。

示例

# 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

# 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

# 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

# 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

# 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

# After State:
# ------------
# sonic# show running-configuration | grep lldp
# !
# lldp receive
# lldp timer 200
# lldp multiplier 9
# lldp system-name CR_sonic
# lldp system-description sonic_system
# !

返回值

常见返回值在此处记录，以下是此模块独有的字段

键

描述

after

列表 / 元素=字符串

生成的配置模块调用。

返回：当更改时

示例： ["返回的配置将始终与上面的参数格式相同。\n"]

after(生成)

列表 / 元素=字符串

生成的配置模块调用。

返回：当 check_mode

示例： ["返回的配置将始终与上面的参数格式相同。\n"]

before

列表 / 元素=字符串

模块调用之前的配置。

返回：始终

示例： ["返回的配置将始终与上面的参数格式相同。\n"]

commands

列表 / 元素=字符串

推送到远程设备的命令集。

返回：始终

示例： ["command 1", "command 2", "command 3"]

作者

  • Divya Balasubramanian(@divya-balasubramania)