cisco.ios.ios_lldp_global – Модуль ресурсов LLDP
Примечание
Этот плагин входит в коллекцию cisco.ios (версия 1.3.0).
Для его установки используйте: ansible-galaxy collection install cisco.ios.
Для использования в книге задач укажите: cisco.ios.ios_lldp_global.
Новый в версии 1.0.0: коллекции cisco.ios
Обзор
- Этот модуль настраивает и управляет атрибутами протокола Link Layer Discovery Protocol (LLDP) на платформах IOS.
Примечание
У этого модуля есть соответствующий плагин действий.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| config словарь | Словарь параметров LLDP | |||
| enabled логическое значение |
| Включить LLDP | ||
| holdtime целое число | Время удержания LLDP (в сек), которое отправляется в пакетах. Обратитесь к документации поставщика для получения допустимых значений. | |||
| reinit целое число | Укажите задержку (в сек) для инициализации LLDP. Обратитесь к документации поставщика для получения допустимых значений. ПРИМЕЧАНИЕ. Если LLDP reinit настроен с начальным значением, идемпотенция не будет поддерживаться, так как устройство Cisco не записывает начальное значение reinit. В связи с этим Ansible не может проверить, настроено ли соответствующее начальное значение reinit на стороне устройства или нет. Если вы пытаетесь применить начальное значение reinit в каждом запуске задачи, Ansible покажет, что изменения произошли (True). Для любого другого значения reinit идемпотенция будет сохранена, поскольку любое другое значение reinit записывается в устройстве Cisco. | |||
| timer целое число | Укажите частоту отправки пакетов LLDP (в сек). Обратитесь к документации поставщика для получения допустимых значений. | |||
| tlv_select словарь | Выбор LLDP TLV (тип-длина-значение) для отправки ПРИМЕЧАНИЕ. Если tlv-select настроен, идемпотенция не будет поддерживаться, так как устройство Cisco не записывает настроенные параметры tlv-select. В связи с этим Ansible не может проверить, настроены ли соответствующие параметры tlv-select на стороне устройства или нет. Если вы пытаетесь применить параметр tlv-select в каждой задаче, Ansible покажет, что изменения произошли (True). | |||
| four_wire_power_management логическое значение |
| Управление электропитанием 4-проводного кабеля через TLV MDI | ||
| mac_phy_cfg логическое значение |
| TLV конфигурации/статуса MAC/Phy IEEE 802.3 | ||
| management_address логическое значение |
| TLV управляющего адреса | ||
| port_description логическое значение |
| TLV описания порта | ||
| port_vlan логическое значение |
| TLV идентификатора VLAN порта | ||
| power_management логическое значение |
| TLV электропитания DTE IEEE 802.3 через MDI | ||
| system_capabilities логическое значение |
| TLV возможностей системы | ||
| system_description логическое значение |
| TLV описания системы | ||
| system_name логическое значение |
| TLV имени системы | ||
| running_config строка | Этот параметр используется только со состоянием parsed. Значение этого параметра должно быть результатом выполнения команды show running-config | section ^lldp на устройстве IOS. Состояние parsed считывает конфигурацию из параметра running_config, преобразует ее в структурированные данные Ansible, соответствующие параметрам модуля ресурсов, и возвращает значение в ключе parsed результата. | |||
| state строка |
| Состояние, в котором должна храниться конфигурация Состояния отрендерить, собрать и обработать не производят никаких изменений на устройстве. Состояние отрендерить преобразует конфигурацию в config в платформо-специфические команды CLI, которые будут возвращены в ключе отрендерить результата. Для состояния отрендерить активное подключение к удаленному хосту не требуется.Состояние собрать извлечёт конфигурацию работы с устройства и преобразует её в структурированные данные в формате, соответствующем параметрам модуля ресурсов, и возвращает значение в ключе собрать результата. Состояние обработать читает конфигурацию из running_config параметра и преобразует ее в формат JSON в соответствии с параметрами модуля ресурсов, и значение возвращается в ключе обработать результата. Значение параметра running_config должно быть в том же формате, что и вывод команды show running-config | include ip route|ipv6 route, выполняемой на устройстве. Для состояния обработать активное подключение к удаленному хосту не требуется. | ||
Примечания
Примечание
- Тестировалось на Cisco IOSv версии 15.2 на VIRL.
Примеры
# 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 словарь | при изменении | Конфигурация в виде структурированных данных после завершения модуля. Пример: Возвращаемая конфигурация всегда будет в том же формате, что и вышеуказанные параметры. |
| before словарь | всегда | Конфигурация в виде структурированных данных перед вызовом модуля. Пример: Возвращаемая конфигурация всегда будет в том же формате, что и вышеуказанные параметры. |
| commands список / элементы=строка | всегда | Набор команд, отправленных на удаленное устройство Пример: ['lldp holdtime 10', 'lldp run', 'lldp timer 10'] |
Авторы
- Sumit Jaiswal (@justjais)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/cisco/ios/ios_lldp_global_module.html