Spec-Zone.ru › Ansible

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

Примечание

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

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

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

Для использования в playbook, укажите: cisco.ios.ios_lldp_global.

Новое в cisco.ios 1.0.0

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

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

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

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

Параметры

Параметр

Комментарии

config

словарь

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

enabled

логическое

Включить LLDP

Варианты:

  • false
  • true

holdtime

целое число

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

Обратитесь к документации производителя для допустимых значений.

reinit

целое число

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

Обратитесь к документации производителя для допустимых значений.

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

timer

целое число

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

Обратитесь к документации производителя для допустимых значений.

tlv_select

словарь

Выбор TLV LLDP, т.е. type-length-value для отправки

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

four_wire_power_management

логическое

Cisco 4-wire Power via MDI TLV

Варианты:

  • false
  • true

mac_phy_cfg

логическое

IEEE 802.3 MAC/Phy Configuration/status TLV

Варианты:

  • false
  • true

management_address

логическое

Management Address TLV

Варианты:

  • false
  • true

port_description

логическое

Port Description TLV

Варианты:

  • false
  • true

port_vlan

логическое

Port VLAN ID TLV

Варианты:

  • false
  • true

power_management

логическое

IEEE 802.3 DTE Power via MDI TLV

Варианты:

  • false
  • true

system_capabilities

логическое

System Capabilities TLV

Варианты:

  • false
  • true

system_description

логическое

System Description TLV

Варианты:

  • false
  • true

system_name

логическое

System Name TLV

Варианты:

  • false
  • true

running_config

строка

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

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

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

состояние

строка

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

Модуль имеет декларативно схожее поведение для замены и перезаписи состояния.

Состояния 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
#     }

Значения возврата

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

Ключ

Описание

после

словарь

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

Возвращается: при изменении

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

до

словарь

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

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

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

команды

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

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

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

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

Авторы

  • Сумит Джаисвал (@justjais)

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

  • Система отслеживания ошибок
  • Репозиторий (источники)

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

Spec-Zone.ru

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