Модуль cisco.dnac.network_compliance_workflow_manager – Модуль соответствия сетевым нормам для управления задачами соответствия на доступных устройствах в Cisco Catalyst Center.

Примечание

Данный модуль входит в коллекцию cisco.dnac (версия 6.20.0).

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

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

Для использования в плейбуке укажите: cisco.dnac.network_compliance_workflow_manager.

Впервые появился в cisco.dnac 6.14.0

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

Описание

Выполнение проверок соответствия или синхронизации конфигураций на доступных устройствах по IP-адресу(ам) или сайту.
API для выполнения полных проверок соответствия или проверок по определённым категориям на доступных устройствах.
API для синхронизации конфигурации устройства(ов).

Требования

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

dnacentersdk == 2.7.0
python >= 3.9

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
config список / элементы=словарь / обязательный	Список подробностей о устройствах для выполнения проверки соответствия или синхронизации конфигурации устройства.
ip_address_list список / элементы=строка	Список IP-адресов устройств для выполнения проверки соответствия или синхронизации конфигурации устройства. Для выполнения модулем требуется либо «ip_address_list», либо «site_name». Если указаны оба параметра «site_name» и «ip_address_list», операции выполняются на устройствах, присутствующих как в «ip_address_list», так и в указанном сайте. (например, [“204.1.2.2”, “204.1.2.5”, “204.1.2.4”])
run_compliance логическое	Определяет, должна ли быть выполнена полная проверка соответствия на устройствах, указанных в «ip_address_list» и/или «site_name». Если True, тогда проверка соответствия будет запущена для всех категорий. Если False, проверка соответствия не будет запущена, даже если указаны категории run_compliance. Примечание - Эта операция не может быть выполнена для точек доступа (AP) и, если они указаны, они будут пропущены. Варианты: `false` `true` ← (по умолчанию)
run_compliance_batch_size целое число	Указывает количество устройств, включаемых в одну группу для операций соответствия. Этот параметр важен для оптимизации производительности при проверках соответствия в больших масштабах. Обработка устройств группами позволяет повысить скорость и эффективность операции, сократить общее время и свести к минимуму риск перегрузки системных ресурсов. Регулировка этого параметра обеспечивает баланс между пропускной способностью и использованием ресурсов, гарантируя плавное и эффективное управление соответствием. Примечание - Более высокое значение для run_compliance_batch_size может привести к ошибкам из-за увеличенной нагрузки на систему. По умолчанию: `100`
run_compliance_categories список / элементы=строка	Указание категорий соответствия позволяет выполнять проверки соответствия только для указанных категорий. Категория может иметь одно или несколько значений из списка «INTENT», «RUNNING_CONFIG», «IMAGE», «PSIRT», «EOX», «NETWORK_SETTINGS». Категория «INTENT» сопоставляется с типами соответствия «NETWORK_SETTINGS», «NETWORK_PROFILE», «WORKFLOW», «FABRIC», «APPLICATION_VISIBILITY». Если «run_compliance» имеет значение False, проверка соответствия не будет запущена, даже если указаны «run_compliance_categories». (например, [“INTENT”, “RUNNING_CONFIG”, “IMAGE”, “PSIRT”, “EOX”, “NETWORK_SETTINGS”])
site_name строка	При указании «site_name» модуль выполняет операцию на всех устройствах, расположенных в указанном сайте. Это строковое значение, которое должно представлять собой полное иерархическое имя сайта. Для выполнения модулем требуется либо «site_name», либо «ip_address_list». Если указаны оба параметра «site_name» и «ip_address_list», операции выполняются на устройствах, присутствующих как в «ip_address_list», так и в указанном сайте. (например, «Global/USA/San Francisco/Building_2/floor_1»)
sync_device_config логическое	Определяет, следует ли синхронизировать конфигурацию устройства на устройствах, указанных в «ip_address_list» и/или «site_name». Синхронизация конфигурации устройства в основном касается состояния `RUNNING_CONFIG`. Если установлено в True, и если состояние `RUNNING_CONFIG` не соответствует требованиям, эта операция сохранит текущую конфигурацию устройства в стартовую, выполнив «write memory» на устройстве. Примечание: Эта операция не может быть выполнена для точек доступа (AP), и если они указаны, они будут пропущены. Варианты: `false` ← (по умолчанию) `true`
config_verify логическое	Установите в значение True, чтобы проверить конфигурацию Cisco Catalyst Center после применения конфигурации из плейбука. Варианты: `false` ← (по умолчанию) `true`
dnac_api_task_timeout целое число	Определяет таймаут в секундах для вызовов API для получения подробностей о задаче. Если данные о задаче не получены в течение этого периода, процесс завершится, и об этом будет записано уведомление о таймауте. По умолчанию: `1200`
dnac_debug логическое	Указывает, включена ли отладка в SDK Cisco Catalyst Center. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательный	Имя хоста Cisco Catalyst Center.
dnac_log логическое	Флаг для включения/отключения ведения журнала выполнения плейбука. При значении True и указании dnac_log_file_path: - Создает файл журнала в месте выполнения с указанным именем. При значении True и без указания dnac_log_file_path: - Создаёт файл журнала в месте выполнения с именем ‘dnac.log’. При значении False: - Ведение журнала отключено. Если файл журнала не существует: - Он создаётся в режиме добавления или записи в зависимости от флага “dnac_log_append”. Если файл журнала существует: - Он перезаписывается или дополняется в зависимости от флага “dnac_log_append”. Варианты: `false` ← (по умолчанию) `true`
dnac_log_append логическое	Определяет режим файла. Установите в значение True для режима «append». Установите в значение False для режима «write». Варианты: `false` `true` ← (по умолчанию)

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` ← (значение по умолчанию)
dnac_version string	Указывает версию Cisco Catalyst Center, которую должен использовать SDK. Значение по умолчанию: `"2.2.3.3"`
state string	Состояние Cisco Catalyst Center после завершения модуля. Варианты: `"merged"` ← (значение по умолчанию)
validate_response_schema boolean	Флаг для Cisco Catalyst Center SDK, включающий проверку соответствия тел запросов JSON-схеме. Варианты: `false` `true` ← (значение по умолчанию)

Примечания

Примечание

Используемые методы SDK: compliance.Compliance.run_compliance compliance.Compliance.commit_device_configuration task.Task.get_task_by_id task.Task.get_task_details_by_id task.Task.get_task_tree task.Task.get_tasks compliance.Compliance.compliance_details_of_device devices.Devices.get_device_list devices.Devices.get_device_by_id site.Site.get_site site.Site.get_membership site_design.Site_design.get_sites site_design.Site_design.get_site_assigned_network_devices
Используемые пути: post /dna/intent/api/v1/compliance/ post /dna/intent/api/v1/network-device-config/write-memory get /dna/intent/api/v1/task/{taskId} get /dna/intent/api/v1/task/{taskId}/tree get /dna/intent/api/v1/compliance/${deviceUuid}/detail get /dna/intent/api/v1/membership/${siteId} get /dna/intent/api/v1/site get /dna/intent/api/v1/networkDevices/assignedToSite get /dna/intent/api/v1/sites get /dna/intent/api/v1/tasks/${id}/detail get /dna/intent/api/v1/tasks get /dna/intent/api/v1/network-device/${id} get /dna/intent/api/v1/network-device
Не поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco Catalyst Center SDK
Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления подключения

Примеры

- name: Run Compliance check on device(s) using IP address list (run_compliance by default is True)
  cisco.dnac.network_compliance_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
    config:
      - ip_address_list: ["204.1.2.2", "204.1.2.5", "204.1.2.4"]

- name: Run Compliance check on device(s) using IP address list
  cisco.dnac.network_compliance_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
    config:
      - ip_address_list: ["204.1.2.2", "204.1.2.5", "204.1.2.4"]
        run_compliance: true

- name: Run Compliance check on device(s) using Site
  cisco.dnac.network_compliance_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
    config:
      - site_name: "Global/USA/San Francisco/Building_1/floor_1"
        run_compliance: true

- name: Run Compliance check on device(s) using both IP address list and Site
  cisco.dnac.network_compliance_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
    config:
      - ip_address_list: ["204.1.2.2", "204.1.2.5", "204.1.2.4"]
        site_name: "Global/USA/San Francisco/Building_1/floor_1"
        run_compliance: true

- name: Run Compliance check with specific categories on device(s) using IP address list
  cisco.dnac.network_compliance_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
    config:
      - ip_address_list: ["204.1.2.2", "204.1.2.5", "204.1.2.4"]
        run_compliance: true
        run_compliance_categories: ["INTENT", "RUNNING_CONFIG", "IMAGE", "PSIRT"]

- name: Run Compliance check with specific categories on device(s) using Site
  cisco.dnac.network_compliance_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
    config:
      - site_name: "Global/USA/San Francisco/Building_1/floor_1"
        run_compliance: true
        run_compliance_categories: ["INTENT", "RUNNING_CONFIG", "IMAGE", "PSIRT"]

- name: Run Compliance check with specific categories on device(s) using both IP address list and Site
  cisco.dnac.network_compliance_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
    config:
      - ip_address_list: ["204.1.2.2", "204.1.2.5", "204.1.2.4"]
        site_name: "Global/USA/San Francisco/Building_1/floor_1"
        run_compliance: true
        run_compliance_categories: ["INTENT", "RUNNING_CONFIG", "IMAGE", "PSIRT"]

- name: Sync Device Configuration on device(s) using IP address list
  cisco.dnac.network_compliance_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
    config:
      - site_name: "Global"
        sync_device_config: true
        run_compliance: False

- name: Sync Device Configuration on device(s) using Site
  cisco.dnac.network_compliance_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
    config:
      - site_name: "Global/USA/San Francisco/Building_1/floor_1"
        sync_device_config: true
        run_compliance: false

- name: Sync Device Configuration on device(s) using both IP address list and Site
  cisco.dnac.network_compliance_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
    config:
      - ip_address_list: ["204.1.2.2", "204.1.2.5", "204.1.2.4"]
        site_name: "Global/USA/San Francisco/Building_1/floor_1"
        sync_device_config: true
        run_compliance: false

- name: Run Compliance and Sync Device Configuration using both IP address list and Site
  cisco.dnac.network_compliance_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
    config:
      - ip_address_list: ["204.1.2.2", "204.1.2.5", "204.1.2.4"]
        site_name: "Global/USA/San Francisco/Building_1/floor_1"
        run_compliance: true
        run_compliance_categories: ["INTENT", "RUNNING_CONFIG", "IMAGE", "PSIRT"]
        sync_device_config: true

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

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

Ключ	Описание
sample_response_1 словарь	Словарь с ответом, возвращенным Python SDK Cisco Catalyst Center Возвращается: всегда Пример: `"{\n \"status\": \"string\",\n \"changed\": bool,\n \"msg\": \"string\"\n \"response\": {\n \"taskId\": \"string\",\n \"url\": \"string\"\n },\n \"data\": dict,\n \"version\": \"string\"\n}\n"`
sample_response_2 словарь	Словарь с ответом, возвращенным Python SDK Cisco Catalyst Center Возвращается: всегда Пример: `"{\n \"status\": \"string\",\n \"changed\": bool,\n \"msg\": \"string\"\n \"response\": {\n \"taskId\": \"string\",\n \"url\": \"string\"\n },\n \"version\": \"string\"\n}\n"`
sample_response_3 словарь	Словарь с ответом, возвращенным Python SDK Cisco Catalyst Center Возвращается: всегда Пример: `"{\n \"changed\": bool,\n \"msg\": \"string\"\n}\n"`

Авторы

Rugvedi Kapse (@rukapse) Madhan Sankaranarayanan (@madhansansel) Sonali Deepthi (@skesali)

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

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