Модуль cisco.dnac.fabric_sites_zones_workflow_manager – Управление сайтами/зонами Fabric и обновление шаблона профиля аутентификации в Cisco Catalyst Center.

Примечание

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

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

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

Для использования в playbook используйте: cisco.dnac.fabric_sites_zones_workflow_manager.

Новая функция в cisco.dnac 6.17.0

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

Описание

Создание сайтов Fabric для операции SDA в Cisco Catalyst Center.
Обновление сайтов Fabric для операции SDA в Cisco Catalyst Center.
Создание зон Fabric для операции SDA в Cisco Catalyst Center.
Обновление зон Fabric для операции SDA в Cisco Catalyst Center.
Удаление сайтов Fabric из Cisco Catalyst Center.
Удаление зон Fabric из Cisco Catalyst Center.
Настройка шаблона профиля аутентификации для сайта/зоны Fabric в Cisco Catalyst Center.

Требования

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

dnacentersdk >= 2.9.2
python >= 3.9

Параметры

Параметр	Комментарии
config список / элементы=словарь / обязательно	Список, содержащий подробные настройки для создания, обновления или удаления сайтов и зон ткани в среде Software-Defined Access (SDA). Он также включает в себя спецификации для обновления шаблона профиля аутентификации для этих сайтов. Каждый элемент в списке представляет собой конкретную операцию, выполняемую в инфраструктуре SDA, такую как добавление, изменение или удаление сайтов/зон ткани и изменения в профилях аутентификации.
fabric_sites словарь	Словарь, содержащий подробные настройки для управления REST-точками входа, которые будут получать журналы аудита и события с платформы Cisco Catalyst Center. Этот словарь необходим для указания атрибутов и параметров, требуемых для управления жизненным циклом сайтов ткани, зон и связанных профилей аутентификации.
authentication_profile строка	Применяемый к указанной ткани профиль аутентификации. Этот профиль определяет защищённость и управление доступом к сети внутри сайта. Возможные значения включают «Закрытая аутентификация», «Низкий эффект», «Без аутентификации» и «Открытая аутентификация». Эта настройка важна при создании или обновлении сайта ткани или обновлении шаблона профиля аутентификации.
fabric_type строка / обязательно	Указывает тип сайта, который будет управляться в среде SDA. Допустимые значения — «fabric_site» и «fabric_zone». Значение по умолчанию — «fabric_site», что указывает на конфигурацию более широкой зоны сети, тогда как «fabric_zone» обычно относится к более конкретному сегменту внутри сайта.
is_pub_sub_enabled булево	Булево значение, указывающее, включен ли механизм pub/sub для узлов управления в сайте ткани. Эта функция актуальна только при создании или обновлении сайтов ткани, а не зон ткани. При установке в значение True, pub/sub обеспечивает более эффективное взаимодействие и управление внутри сайта. По умолчанию значение True для сайтов ткани, а для зон ткани эта настройка не применяется. Варианты: `false` `true`
site_name строка / обязательно	Это имя однозначно идентифицирует сайт для операций, таких как создание, обновление или удаление сайтов или зон ткани, а также для обновления шаблона профиля аутентификации. Этот параметр обязателен для любой операции управления сайтами/зонами ткани.
update_authentication_profile словарь	Словарь, содержащий подробные данные, необходимые для обновления шаблона профиля аутентификации, связанного со сайтом ткани. Он включает в себя расширенные настройки, которые позволяют точно настроить процесс аутентификации и контрольные параметры безопасности внутри сайта.
authentication_order строка	Указывает основной метод аутентификации для сайта. Доступные методы — «dot1x» (IEEE 802.1X) и «mac» (аутентификация на основе MAC). Эта настройка определяет порядок, в котором пытаются применяться механизмы аутентификации.
dot1x_fallback_timeout целое число	Срок ожидания в секундах для возврата к аутентификации 802.1X. Это значение должно быть в диапазоне от 3 до 120 секунд. Оно определяет период ожидания устройства перед попыткой альтернативного метода аутентификации, если 802.1X не удался.
enable_bpu_guard булево	Булевое значение, включающее или отключающее BPDU Guard. BPDU Guard обеспечивает механизм безопасности, отключая порт при получении BPDU (Bridge Protocol Data Unit), защищая от потенциальных циклов сети. Эта настройка по умолчанию равна true и применима только при установке профиля аутентификации в «Закрытую аутентификацию». Варианты: `false` `true`
number_of_hosts строка	Указывает количество хостов, разрешённых на порт. Доступные варианты — «Single» для одного устройства на порт или «Unlimited» для нескольких устройств. Эта настройка помогает в управлении доступом к сети и поддержании безопасности.
wake_on_lan булево	Булевое значение, указывающее, включена ли функция Wake-on-LAN. Wake-on-LAN позволяет сети удалённо включать устройства, находящиеся в режиме низкой мощности. Варианты: `false` `true`
config_verify булево	Установите в значение True, чтобы проверить конфигурацию Cisco Catalyst Center после применения конфигурации playbook. Варианты: `false` ← (по умолчанию) `true`
dnac_api_task_timeout целое число	Определяет срок ожидания в секундах для вызовов API для получения деталей задачи. Если данные задачи не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о превышении времени ожидания. По умолчанию: `1200`
dnac_debug булево	Указывает, включена ли отладка в SDK Cisco Catalyst Center. Варианты: `false` ← (по умолчанию) `true`

dnac_host string / required	Имя хоста Cisco Catalyst Center.
dnac_log boolean	Флаг для включения/отключения ведения журнала выполнения playbook. Если значение true и указан dnac_log_file_path, - создается файл журнала в месте выполнения с указанным именем. Если значение true и dnac_log_file_path не указан, - создается файл журнала в месте выполнения с именем «dnac.log». Если значение false, - ведение журнала отключено. Если файл журнала не существует, - он создается в режиме добавления или записи в зависимости от флага «dnac_log_append». Если файл журнала существует, - он перезаписывается или к нему добавляется информация в зависимости от флага «dnac_log_append». Варианты: `false` ← (default) `true`
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 Center.
dnac_port string	Указывает номер порта, связанного с Cisco Catalyst Center. Значение по умолчанию: `"443"`
dnac_task_poll_interval integer	Указывает интервал в секундах между последовательными вызовами API для получения сведений о задаче. Значение по умолчанию: `2`
dnac_username aliases: user string	Имя пользователя для аутентификации в Cisco Catalyst Center. Значение по умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Указывает версию Cisco Catalyst Center, которую должен использовать SDK. Значение по умолчанию: `"2.2.3.3"`
state string	Требуемое состояние Cisco Catalyst Center после выполнения модуля. Варианты: `"merged"` ← (default) `"deleted"`
validate_response_schema boolean	Флаг для Cisco Catalyst Center SDK для включения проверки тел запросов на соответствие схеме JSON. Варианты: `false` `true` ← (default)

Примечания

Примечание

Для обеспечения правильной работы модуля для масштабируемых наборов, которые включают создание или обновление сайтов/зон Fabric и обработку обновления шаблона профиля аутентификации, предоставьте допустимый ввод в playbook. В случае возникновения сбоя модуль остановит выполнение, не переходя к дальнейшим операциям.
При удалении сайтов Fabric обязательно укажите ввод для удаления связанных с ними зон Fabric в playbook. Сайты Fabric нельзя удалить, пока не будут удалены все подчинённые зоны Fabric.
Используемые методы SDK: ccc_fabric_sites.FabricSitesZones.get_site ccc_fabric_sites.FabricSitesZones.get_fabric_sites ccc_fabric_sites.FabricSitesZones.get_fabric_zones ccc_fabric_sites.FabricSitesZones.add_fabric_site ccc_fabric_sites.FabricSitesZones.update_fabric_site ccc_fabric_sites.FabricSitesZones.add_fabric_zone ccc_fabric_sites.FabricSitesZones.update_fabric_zone ccc_fabric_sites.FabricSitesZones.get_authentication_profiles ccc_fabric_sites.FabricSitesZones.update_authentication_profile ccc_fabric_sites.FabricSitesZones.delete_fabric_site_by_id ccc_fabric_sites.FabricSitesZones.delete_fabric_zone_by_id
Не поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого встроенный диспетчер подключений из Cisco Catalyst Center SDK
Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления соединения

Примеры

- name: Create a fabric site for SDA with the specified name.
  cisco.dnac.fabric_sites_zones_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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - fabric sites:
          site_name: "Global/Test_SDA/Bld1"
          authentication_profile: "Closed Authentication"
          is_pub_sub_enabled: False

- name: Update a fabric site for SDA with the specified name.
  cisco.dnac.fabric_sites_zones_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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - fabric sites:
          site_name: "Global/Test_SDA/Bld1"
          authentication_profile: "Open Authentication"

- name: Update a fabric zone for SDA with the specified name.
  cisco.dnac.fabric_sites_zones_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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - fabric sites:
          site_name: "Global/Test_SDA/Bld1/Floor1"
          fabric_type: "fabric_zone"
          authentication_profile: "Closed Authentication"

- name: Update fabric zone for sda with given name.
  cisco.dnac.fabric_sites_zones_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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - fabric sites:
          site_name: "Global/Test_SDA/Bld1/Floor1"
          fabric_type: "fabric_zone"
          authentication_profile: "Open Authentication"

- name: Update/customise authentication profile template for fabric site/zone.
  cisco.dnac.fabric_sites_zones_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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: merged
    config:
      - fabric_sites:
          site_name: "Global/Test_SDA/Bld1"
          fabric_type: "fabric_zone"
          authentication_profile: "Open Authentication"
          is_pub_sub_enabled: False
          update_authentication_profile:
            authentication_order: "dot1x"
            dot1x_fallback_timeout: 28
            wake_on_lan: False
            number_of_hosts: "Single"

- name: Deleting/removing fabric site from sda from Cisco Catalyst Center
  cisco.dnac.fabric_sites_zones_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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: deleted
    config:
      - fabric_sites:
          site_name: "Global/Test_SDA/Bld1"

- name: Deleting/removing fabric zone from sda from Cisco Catalyst Center
  cisco.dnac.fabric_sites_zones_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_level: "{{dnac_log_level}}"
    dnac_log: False
    state: deleted
    config:
      - fabric_sites:
          site_name: "Global/Test_SDA/Bld1/Floor1"
          fabric_type: "fabric_zone"

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco Catalyst Center Python SDK Возвращается: всегда Пример: `{"response": {"taskId": "string", "url": "string"}, "version": "string"}`

Авторы

Абишек Махешвари (@abmahesh) Мадан Санкаранайянан (@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_sites_zones_workflow_manager_module.html