Spec-Zone.ru › Ansible

Модуль cisco.ios.ios_lldp_global – модуль ресурсов для настройки LLDP.

Примечание

Этот модуль входит в коллекцию cisco.ios (версия 11.4.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install cisco.ios.

Чтобы использовать её в плейбуке, укажите: cisco.ios.ios_lldp_global.

Добавлено в cisco.ios 1.0.0

  • Краткое описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль настраивает атрибуты протокола обнаружения канального уровня (LLDP) на платформах IOS и управляет ими.

Примечание

Этому модулю соответствует плагин действий.

Псевдонимы: lldp_global

Параметры

Параметр

Комментарии

config

словарь

Словарь параметров LLDP

enabled

логический

Включить LLDP

Варианты:

  • false
  • true

holdtime

целое число

Время удержания LLDP (в секундах), указываемое в пакетах.

Допустимые значения см. в документации поставщика.

reinit

целое число

Укажите задержку (в секундах) перед инициализацией LLDP.

Допустимые значения см. в документации поставщика.

ПРИМЕЧАНИЕ. Если для LLDP задано начальное значение reinit, идемпотентность не будет обеспечена, поскольку устройство Cisco не сохраняет заданное начальное значение reinit. Поэтому Ansible не может определить на стороне устройства, настроено ли соответствующее начальное значение reinit. Если вы будете задавать начальное значение reinit при каждом запуске плейбука, Ansible будет сообщать, что значение changed равно True. Для всех остальных значений reinit идемпотентность будет обеспечена, поскольку устройство Cisco сохраняет эти значения.

timer

целое число

Укажите периодичность отправки пакетов LLDP (в секундах).

Допустимые значения см. в документации поставщика.

tlv_select

словарь

Выбор TLV LLDP (элементов типа-длины-значения) для отправки

ПРИМЕЧАНИЕ. Если настроен параметр tlv-select, идемпотентность не будет обеспечена, поскольку устройство Cisco не сохраняет настроенные параметры tlv-select. Поэтому Ansible не может определить на стороне устройства, настроены ли соответствующие параметры tlv-select. Если вы будете применять параметр tlv-select при каждом запуске плейбука, Ansible будет сообщать, что значение changed равно True.

four_wire_power_management

логический

TLV Cisco 4-wire Power via MDI

Варианты:

  • false
  • true

mac_phy_cfg

логический

TLV конфигурации и состояния MAC/PHY IEEE 802.3

Варианты:

  • false
  • true

management_address

логический

TLV адреса управления

Варианты:

  • false
  • true

port_description

логический

TLV описания порта

Варианты:

  • false
  • true

port_vlan

логический

TLV идентификатора VLAN порта

Варианты:

  • false
  • true

power_management

логический

TLV питания DTE через MDI IEEE 802.3

Варианты:

  • false
  • true

system_capabilities

логический

TLV возможностей системы

Варианты:

  • false
  • true

system_description

логический

TLV описания системы

Варианты:

  • false
  • true

system_name

логический

TLV имени системы

Варианты:

  • false
  • true

running_config

строка

Этот параметр используется только при состоянии parsed.

Значением этого параметра должен быть вывод, полученный с устройства IOS при выполнении команды show running-config | section ^lldp.

Состояние parsed считывает конфигурацию из параметра running_config и преобразует её в структурированные данные Ansible согласно спецификации аргументов модуля ресурсов; затем значение возвращается в ключе parsed результата.

state

строка

Состояние, в котором должна остаться конфигурация

При состояниях replaced и overridden модуль ведёт себя схожим декларативным образом.

Состояния rendered, gathered и parsed не вносят изменений на устройстве.

Состояние rendered преобразует конфигурацию из параметра config в команды CLI для конкретной платформы; результат возвращается в ключе rendered. Для состояния rendered активное подключение к удалённому узлу не требуется.

Состояние gathered получает текущую конфигурацию устройства и преобразует её в структурированные данные в формате, соответствующем спецификации аргументов модуля ресурсов; значение возвращается в ключе gathered результата.

Состояние parsed считывает конфигурацию из параметра running_config и преобразует её в формат JSON согласно параметрам модуля ресурсов; значение возвращается в ключе parsed результата. Значение параметра running_config должно иметь тот же формат, что и вывод команды show running-config | include ip route|ipv6 route, выполненной на устройстве. Для состояния parsed активное подключение к удалённому узлу не требуется.

Варианты:

  • "merged" ← (по умолчанию)
  • "replaced"
  • "overridden"
  • "deleted"
  • "rendered"
  • "gathered"
  • "parsed"

Примечания

Примечание

  • Проверено на Cisco IOSXE версии 17.3 в CML.
  • Этот модуль работает с подключением network_cli. См. https://docs.ansible.com/ansible/latest/network/user_guide/platform_ios.html

Примеры

# Using merged

# Before state:
# -------------
# vios#sh running-config | section ^lldp
# vios1#

- name: Merge provided configuration with device configuration
  cisco.ios.ios_lldp_global:
    config:
      holdtime: 10
      enabled: true
      reinit: 3
      timer: 10
    state: merged

# After state:
# ------------
# vios#sh running-config | section ^lldp
#  lldp timer 10
#  lldp holdtime 10
#  lldp reinit 3
#  lldp run

# Using replaced

# Before state:
# -------------
# vios#sh running-config | section ^lldp
#  lldp timer 10
#  lldp holdtime 10
#  lldp reinit 3
#  lldp run

- name: Replaces LLDP device configuration with provided configuration
  cisco.ios.ios_lldp_global:
    config:
      holdtime: 20
      reinit: 5
    state: replaced

# After state:
# -------------
# vios#sh running-config | section ^lldp
#  lldp holdtime 20
#  lldp reinit 5

# Using Deleted without any config passed
# "(NOTE: This will delete all of configured LLDP module attributes)"

# Before state:
# -------------
# vios#sh running-config | section ^lldp
#  lldp timer 10
#  lldp holdtime 10
#  lldp reinit 3
#  lldp run

- name: Delete LLDP attributes
  cisco.ios.ios_lldp_global:
    state: deleted

# After state:
# -------------
# vios#sh running-config | section ^lldp
# vios1#

# Using Gathered

# Before state:
# -------------
#
# vios#sh running-config | section ^lldp
#  lldp timer 10
#  lldp holdtime 10
#  lldp reinit 3
#  lldp run

- name: Gather listed interfaces with provided configurations
  cisco.ios.ios_lldp_global:
    config:
    state: gathered

# Module Execution Result:
# ------------------------
#
# "gathered": {
#         "enabled": true,
#         "holdtime": 10,
#         "reinit": 3,
#         "timer": 10
#     }

# After state:
# ------------
#
# vios#sh running-config | section ^lldp
#  lldp timer 10
#  lldp holdtime 10
#  lldp reinit 3
#  lldp run

# Using Rendered
- name: Render the commands for provided  configuration
  cisco.ios.ios_lldp_global:
    config:
      holdtime: 10
      enabled: true
      reinit: 3
      timer: 10
    state: rendered

# Module Execution Result:
# ------------------------
#
# "rendered": [
#         "lldp holdtime 10",
#         "lldp run",
#         "lldp timer 10",
#         "lldp reinit 3"
#     ]

# Using Parsed

# File: parsed.cfg
# ----------------
#
# lldp timer 10
# lldp holdtime 10
# lldp reinit 3
# lldp run

- name: Parse the commands for provided configuration
  cisco.ios.ios_lldp_global:
    running_config: "{{ lookup('file', 'parsed.cfg') }}"
    state: parsed

# Module Execution Result:
# ------------------------
#
# "parsed": {
#         "enabled": true,
#         "holdtime": 10,
#         "reinit": 3,
#         "timer": 10
#     }

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже приведены поля, уникальные для этого модуля:

Ключ

Описание

after

словарь

Конфигурация в виде структурированных данных после выполнения модуля.

Возвращается: если были изменения

Пример: "The configuration returned will always be in the same format of the parameters above."

before

словарь

Конфигурация в виде структурированных данных до вызова модуля.

Возвращается: всегда

Пример: "The configuration returned will always be in the same format of the parameters above."

commands

список / элементы=строка

Набор команд, отправленных на удалённое устройство

Возвращается: всегда

Пример: ["lldp holdtime 10", "lldp run", "lldp timer 10"]

Авторы

  • Sumit Jaiswal (@justjais)

Ссылки на коллекцию

  • Отслеживание проблем
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/cisco/ios/ios_lldp_global_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API