Spec-Zone.ru › Ansible

Модуль cisco.ios.ios_bfd_templates – конфигурации шаблонов обнаружения двусторонней пересылки (BFD)

Примечание

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

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

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

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

Новое в cisco.ios 11.3.0

  • Обзор
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Обзор

  • Управляет конфигурациями шаблонов обнаружения двусторонней пересылки (BFD)

Параметры

Параметр

Комментарии

config

list / elements=dictionary

Словарь параметров шаблона BFD

authentication

dictionary

Настройка аутентификации для шаблона BFD

keychain

string

Имя связки ключей для аутентификации

type

string

Тип аутентификации для сеансов BFD

Варианты:

  • "sha_1"
  • "md5"
  • "meticulous_md5"
  • "meticulous_sha_1"

dampening

dictionary

Включает подавление колебаний сеанса

half_life_period

integer

Период полураспада для алгоритма экспоненциального затухания, в минутах.

max_suppress_time

integer

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

reuse_threshold

integer

Порог, при достижении которого подавленный сеанс можно повторно использовать (вывести из режима подавления), в миллисекундах.

suppress_threshold

integer

Порог, при достижении которого сеанс подавляется (переводится в режим подавления), в миллисекундах.

echo

boolean

Включает функцию эхо BFD для всех интерфейсов, использующих этот шаблон.

Варианты:

  • false
  • true

hop

string / обязательный

Тип используемого шаблона

Варианты:

  • "single_hop"
  • "multi_hop"

interval

dictionary

Задает интервал передачи пакетов BFD

min_rx

integer

Минимальный интервал в миллисекундах, который локальная система может поддерживать между получаемыми управляющими пакетами BFD

min_tx

integer

Минимальный интервал в миллисекундах, который локальная система задает для передачи управляющих пакетов BFD

multiplier

integer

Задает количество последовательных управляющих пакетов BFD от узла-соседа, которые должны быть пропущены, прежде чем BFD объявит узел-сосед недоступным и уведомит одноранговый узел BFD уровня 3 о сбое.

name

string / обязательный

Имя используемого шаблона BFD

running_config

string

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

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

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

state

string

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

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

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

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

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

Состояние deleted не поддерживает и не гарантирует выборочное удаление конфигурации. Плейбук должен служить источником истины, а желаемое состояние ресурса должно отражаться в плейбуке. Используйте overridden или replaced, чтобы удалить лишнюю конфигурацию.

Состояние purged полностью удаляет шаблоны BFD с помощью одной команды верхнего уровня no bfd-template, удаляющей все определение шаблона целиком.

Варианты:

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

Примечания

Примечание

  • Проверено на Cisco IOS XE Software, версия 17.13.01a в CML
  • Этот модуль работает с подключением network_cli
  • Дополнительные сведения об использовании Ansible для управления сетевыми устройствами см. в :ref:`Руководстве по сетям Ansible <network_guide>`
  • Дополнительные сведения об использовании Ansible для управления устройствами Cisco см. на `странице интеграции Cisco <https://www.ansible.com/integrations/networks/cisco>`_.

Примеры

# Using merged
# Before state:
# -------------
# router-ios#show running-config | section ^bfd-template
# (no BFD templates configured)

- name: Merge provided configuration with device configuration
  cisco.ios.ios_bfd_templates:
    config:
      - name: template1
        hop: single_hop
        interval:
          min_tx: 200
          min_rx: 200
          multiplier: 3
        authentication:
          type: sha_1
          keychain: bfd_keychain
        echo: true
      - name: template2
        hop: multi_hop
        interval:
          min_tx: 500
          min_rx: 500
          multiplier: 5
        dampening:
          half_life_period: 30
          reuse_threshold: 2000
          suppress_threshold: 5000
          max_suppress_time: 120
    state: merged

# Commands Fired:
# ---------------
# bfd-template single-hop template1
#  interval min-tx 200 min-rx 200 multiplier 3
#  authentication sha-1 keychain bfd_keychain
#  echo
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5
#  dampening 30 2000 5000 120

# After state:
# ------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
#  interval min-tx 200 min-rx 200 multiplier 3
#  authentication sha-1 keychain bfd_keychain
#  echo
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5
#  dampening 30 2000 5000 120

# Using replaced
# Before state:
# -------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
#  interval min-tx 200 min-rx 200 multiplier 3
#  authentication sha-1 keychain bfd_keychain
#  echo
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5

- name: Replace device configuration of specified BFD templates with provided configuration
  cisco.ios.ios_bfd_templates:
    config:
      - name: template1
        hop: single_hop
        interval:
          min_tx: 300
          min_rx: 300
          multiplier: 4
        authentication:
          type: sha_1
          keychain: new_keychain
    state: replaced

# Commands Fired:
# ---------------
# bfd-template single-hop template1
#  no echo
#  interval min-tx 300 min-rx 300 multiplier 4
#  no authentication sha-1 keychain bfd_keychain
#  authentication sha-1 keychain new_keychain

# After state:
# ------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
#  interval min-tx 300 min-rx 300 multiplier 4
#  authentication sha-1 keychain new_keychain
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5

# Using overridden
# Before state:
# -------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
#  interval min-tx 200 min-rx 200 multiplier 3
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5
# bfd-template single-hop template3
#  echo

- name: Override device configuration with provided configuration
  cisco.ios.ios_bfd_templates:
    config:
      - name: template1
        hop: single_hop
        interval:
          min_tx: 300
          min_rx: 300
          multiplier: 5
        authentication:
          type: md5
          keychain: secure_key
    state: overridden

# Commands Fired:
# ---------------
# no bfd-template multi-hop template2
# no bfd-template single-hop template3
# bfd-template single-hop template1
#  interval min-tx 300 min-rx 300 multiplier 5
#  authentication md5 keychain secure_key

# After state:
# ------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
#  interval min-tx 300 min-rx 300 multiplier 5
#  authentication md5 keychain secure_key

# Using deleted
# Before state:
# -------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
#  interval min-tx 200 min-rx 200 multiplier 3
#  authentication sha-1 keychain bfd_keychain
#  echo
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5

- name: Delete specified BFD template
  cisco.ios.ios_bfd_templates:
    config:
      - name: template1
        hop: single_hop
    state: deleted

# Commands Fired:
# ---------------
# bfd-template single-hop template1
#  no echo
#  no interval min-tx 200 min-rx 200 multiplier 3
#  no authentication sha-1 keychain bfd_keychain

# After state:
# ------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5

# Using deleted (to delete all BFD templates )
# Before state:
# -------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
#  interval min-tx 200 min-rx 200 multiplier 3
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5

- name: Delete all BFD template configurations
  cisco.ios.ios_bfd_templates:
    state: deleted

# Commands Fired:
# ---------------
# bfd-template single-hop template1
#  no interval min-tx 200 min-rx 200 multiplier 3
# bfd-template multi-hop template2
#  no interval min-tx 500 min-rx 500 multiplier 5

# After state:
# ------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
# bfd-template multi-hop template2

# Using purged
# Before state:
# -------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
#  interval min-tx 200 min-rx 200 multiplier 3
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5

- name: Purge specified BFD template configurations (complete removal)
  cisco.ios.ios_bfd_templates:
    config:
      - name: template1
        hop: single_hop
    state: purged

# Commands Fired:
# ---------------
# no bfd-template single-hop template1

# After state:
# ------------
# router-ios#show running-config | section ^bfd-template
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5

# Using purged (to remove all BFD templates)
# Before state:
# -------------
# router-ios#show running-config | section ^bfd-template
# bfd-template single-hop template1
#  interval min-tx 200 min-rx 200 multiplier 3
#  authentication sha-1 keychain bfd_keychain
# bfd-template multi-hop template2
#  interval min-tx 500 min-rx 500 multiplier 5
# bfd-template single-hop template3
#  echo

- name: Purge all BFD template configurations (complete removal)
  cisco.ios.ios_bfd_templates:
    config: []
    state: purged

# Commands Fired:
# ---------------
# no bfd-template single-hop template1
# no bfd-template multi-hop template2
# no bfd-template single-hop template3

# After state:
# ------------
# router-ios#show running-config | section ^bfd-template
# (no BFD templates configured)

# Using rendered
- name: Render platform specific commands from task input using rendered state
  cisco.ios.ios_bfd_templates:
    config:
      - name: template1
        hop: single_hop
        interval:
          min_tx: 200
          min_rx: 200
          multiplier: 3
        authentication:
          type: meticulous_sha_1
          keychain: secure_chain
        echo: true
    state: rendered

# Module Execution Result:
# ------------------------
# "rendered": [
#     "bfd-template single-hop template1",
#     "interval min-tx 200 min-rx 200 multiplier 3",
#     "authentication meticulous-sha-1 keychain secure_chain",
#     "echo"
# ]

# Using gathered
- name: Gather BFD template configuration from the device
  cisco.ios.ios_bfd_templates:
    state: gathered

# Module Execution Result:
# ------------------------
# "gathered": [
#     {
#         "name": "template1",
#         "hop": "single_hop",
#         "interval": {
#             "min_tx": 200,
#             "min_rx": 200,
#             "multiplier": 3
#         },
#         "authentication": {
#             "type": "sha_1",
#             "keychain": "bfd_keychain"
#         },
#         "echo": true
#     }
# ]

# Using parsed
- name: Parse the provided configuration to structured format
  cisco.ios.ios_bfd_templates:
    running_config: |
      bfd-template single-hop template1
       interval min-tx 200 min-rx 200 multiplier 3
       authentication sha-1 keychain bfd_keychain
       echo
      bfd-template multi-hop template2
       dampening 30 2000 5000 120
    state: parsed

# Module Execution Result:
# ------------------------
# "parsed": [
#     {
#         "name": "template1",
#         "hop": "single_hop",
#         "interval": {
#             "min_tx": 200,
#             "min_rx": 200,
#             "multiplier": 3
#         },
#         "authentication": {
#             "type": "sha_1",
#             "keychain": "bfd_keychain"
#         },
#         "echo": true
#     },
#     {
#         "name": "template2",
#         "hop": "multi_hop",
#         "dampening": {
#             "half_life_period": 30,
#             "reuse_threshold": 2000,
#             "suppress_threshold": 5000,
#             "max_suppress_time": 120
#         }
#     }
# ]

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

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

Ключ

Описание

after

list / elements=string

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

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

Пример: ["This output will always be in the same format as the module argspec.\n"]

before

list / elements=string

Конфигурация до вызова модуля.

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

Пример: ["This output will always be in the same format as the module argspec.\n"]

commands

list / elements=string

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

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

Пример: ["bfd-template single-hop template1", "interval min-tx 200 min-rx 200 multiplier 3", "authentication sha-1 keychain bfd_keychain", "echo"]

gathered

list / elements=string

Факты о сетевом ресурсе, собранные с удаленного устройства в виде структурированных данных.

Возвращается: если state равен gathered

Пример: ["This output will always be in the same format as the module argspec.\n"]

parsed

list / elements=string

Встроенная конфигурация устройства, указанная в параметре running_config и преобразованная в структурированные данные в соответствии со спецификацией аргументов модуля.

Возвращается: если state равен parsed

Пример: ["This output will always be in the same format as the module argspec.\n"]

rendered

list / elements=string

Предоставленная в задаче конфигурация, преобразованная в собственный формат устройства (автономно).

Возвращается: если state равен rendered

Пример: ["bfd-template single-hop template1", "interval min-tx 200 min-rx 200 multiplier 3", "authentication sha-1 keychain bfd_keychain", "echo"]

Авторы

  • Komal Desai (@komaldesai13)

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

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

© 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_bfd_templates_module.html

Spec-Zone.ru

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