Spec-Zone.ru › Ansible

Модуль cisco.dnac.fabric_transits_workflow_manager – Модуль ресурсов для транзитов SDA fabric

Примечание

Этот модуль входит в состав коллекции cisco.dnac (версия 6.20.0).

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

Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробной информации.

Чтобы использовать его в книге задач, укажите: cisco.dnac.fabric_transits_workflow_manager.

Новое в cisco.dnac 6.18.0

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

Обзор

  • Управление операциями с транзитами SDA fabric.
  • API для создания транзитных сетей.
  • API для обновления транзитных сетей.
  • API для удаления транзитных сетей.

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

  • dnacentersdk >= 2.9.2
  • python >= 3.9

Параметры

Параметр

Комментарии

config

список / элементы=словарь / обязательный

Список конфигураций транзита SDA-ткани.

Каждый элемент списка представляет конфигурацию транзитной сети.

sda_fabric_transits

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

Конфигурации транзита SDA-ткани.

ip_transit_settings

словарь

Настройки конфигурации транзита на основе IP.

Требуется, когда тип установлен в IP_BASED_TRANSIT.

IP_BASED_TRANSIT не может быть обновлен.

autonomous_system_number

строка

Используется протоколами маршрутизации, такими как BGP, для управления маршрутизацией между различными автономными системами.

Номер автономной системы (ASN) должен быть от 1 до 4294967295.

ASN должен быть уникальным для каждого IP-транзита.

Требуется, когда transit_type установлен в IP_BASED_TRANSIT.

routing_protocol_name

строка

Определяет протокол для определения наилучших путей передачи данных между сетями.

Варианты:

  • "BGP" ← (по умолчанию)

name

строка

Имя транзита SDA-ткани.

Обеспечивает беспрепятственную коммуникацию между различными сегментами сети.

Требуется для операций в транзитах SDA-ткани.

sda_transit_settings

словарь

Настройки конфигурации транзита на основе SDA.

Требуется, когда transit_type установлен в SDA_LISP_PUB_SUB_TRANSIT или SDA_LISP_BGP_TRANSIT.

control_plane_network_device_ips

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

Указывает IP-адреса сетевых устройств, образующих управляющую плоскость.

Требуется, когда transit_type установлен в SDA_LISP_BGP_TRANSIT или SDA_LISP_PUB_SUB_TRANSIT.

Требуется хотя бы одно устройство управляющей плоскости.

Максимально 2 устройства управляющей плоскости допускаются, когда transit_type равен SDA_LISP_BGP_TRANSIT.

Максимально 4 устройства управляющей плоскости допускаются, когда transit_type равен SDA_LISP_PUB_SUB_TRANSIT.

SDA_LISP_PUB_SUB_TRANSIT поддерживает только устройства с IOS XE 17.6 или более поздними версиями.

Устройства должны присутствовать в сайте или зоне Fabric.

is_multicast_over_transit_enabled

булево

Определяет, разрешен ли трафик multicast для прохождения через транзитную сеть.

Включение этого параметра позволяет распределить данные нескольким получателям по разным сегментам сети.

Доступно только при transit_type установлен в SDA_LISP_PUB_SUB_TRANSIT.

Варианты:

  • false
  • true

transit_type

строка

Тип транзита ткани. IP_BASED_TRANSIT - отвечает за управление маршрутизацией IP и гарантирует поток данных между различными сегментами сети. SDA_LISP_PUB_SUB_TRANSIT - способствует отвязке информации о местоположении и идентификаторе устройств, что позволяет динамическую маршрутизацию. SDA_LISP_BGP_TRANSIT - интегрирует LISP с BGP для управления и оптимизации решений маршрутизации между различными сегментами сети.

Варианты:

  • "IP_BASED_TRANSIT" ← (по умолчанию)
  • "SDA_LISP_PUB_SUB_TRANSIT"
  • "SDA_LISP_BGP_TRANSIT"

config_verify

булево

Установите в True для проверки Cisco Catalyst Center после применения конфигурации playbook.

Варианты:

  • false ← (по умолчанию)
  • true

dnac_api_task_timeout

целое

Определяет время ожидания в секундах для API-запросов для получения подробностей о задаче. Если подробности о задаче не получены в течение этого периода, процесс завершится, и будет записано уведомление о времени ожидания.

По умолчанию: 1200

dnac_debug

булево

Указывает, включена ли отладка в Cisco Catalyst Center SDK.

Варианты:

  • false ← (по умолчанию)
  • true

dnac_host

строка / обязательный

Имя хоста Cisco Catalyst Center.

dnac_log

булево

Флаг для включения/выключения ведения журнала выполнения playbook.

Если True и dnac_log_file_path указан, - Создать файл журнала в месте выполнения с указанным именем.

Если True и dnac_log_file_path не указан, - Создать файл журнала в месте выполнения с именем ‘dnac.log’.

Если False, - Ведение журнала отключено.

Если файл журнала не существует, - Он создается в режиме добавления или записи в зависимости от флага “dnac_log_append”.

Если файл журнала существует, - Он перезаписывается или дополняется в зависимости от флага “dnac_log_append”.

Варианты:

  • false ← (по умолчанию)
  • true
END_OF_DOCUMENT_MARKER

dnac_log_append

boolean

Определяет режим файла. Установите значение True для режима «добавления». Установите значение False для режима «записи».

Варианты:

  • false
  • true ← (default)

dnac_log_file_path

string

Управляет ведением журнала. Журналы записываются, если dnac_log имеет значение True.

Если путь не указан, - Когда ‘dnac_log_append’ равно True, ‘dnac.log’ создается в текущем каталоге Ansible; журналы добавляются. - Когда ‘dnac_log_append’ равно False, ‘dnac.log’ создается; журналы перезаписываются.

Если путь указан, - Когда ‘dnac_log_append’ равно True, файл открывается в режиме добавления. - Когда ‘dnac_log_append’ равно False, файл открывается в режиме записи (w). - В сценариях с общим файлом без режима добавления содержимое перезаписывается после каждого выполнения модуля. - Для общего файла журнала установите append в значение False для первого модуля (для перезаписи); для последующих модулей установите append в значение True.

Значение по умолчанию: "dnac.log"

dnac_log_level

string

Устанавливает порог для уровня журнала. Сообщения с уровнем, равным или выше этого, будут регистрироваться. Уровни перечислены в порядке серьезности [CRITICAL, ERROR, WARNING, INFO, DEBUG].

CRITICAL указывает на серьезные ошибки, останавливающие программу. Отображает только сообщения CRITICAL.

ERROR указывает на проблемы, препятствующие работе функции. Отображает сообщения ERROR и CRITICAL.

WARNING указывает на потенциальные будущие проблемы. Отображает сообщения WARNING, ERROR, CRITICAL.

INFO отслеживает нормальную работу. Отображает сообщения INFO, WARNING, ERROR, CRITICAL.

DEBUG предоставляет подробную диагностическую информацию. Отображает все сообщения журнала.

Значение по умолчанию: "WARNING"

dnac_password

string

Пароль для аутентификации в центре Cisco Catalyst.

dnac_port

string

Указывает номер порта, связанного с центром Cisco Catalyst.

Значение по умолчанию: "443"

dnac_task_poll_interval

integer

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

Значение по умолчанию: 2

dnac_username

aliases: user

string

Имя пользователя для аутентификации в центре Cisco Catalyst.

Значение по умолчанию: "admin"

dnac_verify

boolean

Флаг для включения или отключения проверки сертификата SSL.

Варианты:

  • false
  • true ← (default)

dnac_version

string

Указывает версию центра Cisco Catalyst, которую должен использовать SDK.

Значение по умолчанию: "2.2.3.3"

state

string

Состояние центра Cisco Catalyst после завершения работы модуля.

Варианты:

  • "merged" ← (default)
  • "deleted"

validate_response_schema

boolean

Флаг для Cisco Catalyst Center SDK для включения проверки текстов запросов на соответствие JSON-схеме.

Варианты:

  • false
  • true ← (default)

Примечания

Примечание

  • Используемые методы SDK: devices.Devices.get_device_list, sda.Sda.get_transit_networks, sda.Sda.add_transit_networks, sda.Sda.update_transit_networks, sda.Sda.delete_transit_network_by_id, task.Task.get_tasks_by_id, task.Task.get_task_details_by_id,
  • Используемые пути: get /dna/intent/api/v1/network-device, get /dna/intent/api/v1/sda/transitNetworks, post /dna/intent/api/v1/sda/transitNetworks, put /dna/intent/api/v1/sda/transitNetworks, delete /dna/intent/api/v1/sda/transitNetworks/${id}, get /dna/intent/api/v1/tasks/${id} get /dna/intent/api/v1/tasks/${id}/detail
  • Не поддерживает check_mode
  • Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco Catalyst Center SDK
  • Параметры, начинающиеся с dnac_, используются Python SDK Cisco Catalyst Center для установления соединения

Примеры

- name: Create SDA fabric transit of transit_type IP_BASED_TRANSIT
  cisco.dnac.fabric_transits_workflow_manager:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: IP_BASED_TRANSIT
      ip_transit_settings:
        routing_protocol_name: BGP
        autonomous_system_number: 1234

- name: Create SDA fabric transit of transit_type SDA_LISP_BGP_TRANSIT
  cisco.dnac.fabric_transits_workflow_manager:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_BGP_TRANSIT
      sda_transit_settings:
        control_plane_network_device_ips:
        - string
        - string

- name: Create SDA fabric transit of transit_type SDA_LISP_PUB_SUB_TRANSIT
  cisco.dnac.fabric_transits_workflow_manager:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_PUB_SUB_TRANSIT
      sda_transit_settings:
        is_multicast_over_transit_enabled: false
        control_plane_network_device_ips:
        - string
        - string
        - string
        - string

- name: Update SDA fabric transit of transit_type SDA_LISP_BGP_TRANSIT
  cisco.dnac.fabric_transits_workflow_manager:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_BGP_TRANSIT
      sda_transit_settings:
        control_plane_network_device_ips:
        - string
        - string

- name: Update the multicast over transit
  cisco.dnac.fabric_transits_workflow_manager:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_PUB_SUB_TRANSIT
      sda_transit_settings:
        is_multicast_over_transit_enabled: true

- name: Update the control plane network devices
  cisco.dnac.fabric_transits_workflow_manager:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: merged
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit
      transit_type: SDA_LISP_PUB_SUB_TRANSIT
      sda_transit_settings:
        control_plane_network_device_ips:
        - string
        - string
        - string

- name: Delete SDA fabric transit
  cisco.dnac.fabric_transits_workflow_manager:
    dnac_host: "{{dnac_host}}"
    dnac_username: "{{dnac_username}}"
    dnac_password: "{{dnac_password}}"
    dnac_verify: "{{dnac_verify}}"
    dnac_port: "{{dnac_port}}"
    dnac_version: "{{dnac_version}}"
    dnac_debug: "{{dnac_debug}}"
    dnac_log: True
    dnac_log_level: "{{ dnac_log_level }}"
    state: deleted
    config_verify: True
    config:
    - sda_fabric_transits:
      - name: sample_transit1
      - name: sample_transit2

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

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

Ключ

Описание

response_1

словарь

Словарь или список с ответом, возвращённым Cisco Catalyst Center Python SDK

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

response_2

словарь

Словарь или список с ответом, возвращённым Cisco Catalyst Center Python SDK

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

response_3

словарь

Словарь или список с ответом, возвращённым Cisco Catalyst Center Python SDK

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

Пример: {"response": {"taskId": "string", "url": "string"}, "version": "string"}

Авторы

  • Muthu Rakesh (@MUTHU-RAKESH-27) Madhan Sankaranarayanan (@madhansansel)

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

  • Система отслеживания проблем
  • Репозиторий (Исходные файлы)

© 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/dnac/fabric_transits_workflow_manager_module.html

Spec-Zone.ru

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