Модуль cisco.dnac.discovery_workflow_manager – Модуль ресурсов для обработки задач обнаружения устройств.
Примечание
Этот модуль входит в коллекцию cisco.dnac (версия 6.20.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install cisco.dnac. Для использования этого модуля потребуются дополнительные требования. Подробности см. в разделе Требования.
Чтобы использовать его в книге задач, укажите: cisco.dnac.discovery_workflow_manager.
Новое в cisco.dnac 6.6.0
Описание
- Управляет обнаружением устройств с помощью IP-адреса, диапазона адресов, CDP и LLDP, включая удаление обнаруженных устройств.
- API для обнаружения устройства или нескольких устройств
- API для удаления обнаружения устройства или нескольких устройств
Требования
Ниже приведены требования, необходимые на хосте, на котором выполняется этот модуль.
- dnacentersdk == 2.6.10
- python >= 3.9
Параметры
Параметр | Комментарии |
|---|---|
config list / elements=dictionary / required | Список подробностей управляемого устройства. |
|
cdp_level integer |
Общее количество уровней в методе обнаружения CDP Default: |
|
delete_all boolean |
Параметр для удаления всех обнаружений за один раз Choices:
|
|
discovery_name string / required |
Имя задачи обнаружения |
|
discovery_specific_credentials dictionary |
Учетные данные, специально созданные пользователем для выполнения обнаружения устройств. |
|
cli_credentials_list list / elements=dictionary |
Список учетных данных CLI, которые будут использоваться во время обнаружения устройств. |
|
enable_password string |
Пароль enable для аутентификации CLI, обязателен при использовании учетных данных CLI. |
|
password string |
Пароль для аутентификации CLI, обязателен при использовании учетных данных CLI. |
|
username string |
Имя пользователя для аутентификации CLI, обязательно при использовании учетных данных CLI. |
|
http_read_credential dictionary |
Учетные данные для чтения HTTP используются для аутентификации и специально предназначены для предоставления права только на чтение определенных ресурсов с устройства. |
|
password string |
Пароль для аутентификации HTTP(S) чтения, обязателен при использовании HTTP-учетных данных. |
|
port integer |
Порт для аутентификации HTTP(S) чтения, обязателен для использования HTTP-учетных данных. |
|
secure boolean |
Флаг для аутентификации HTTP(S) чтения, не обязателен при использовании HTTP-учетных данных. Choices:
|
|
username string |
Имя пользователя для аутентификации HTTP(S) чтения, обязательно при использовании HTTP-учетных данных. |
|
http_write_credential dictionary |
Учетные данные для записи HTTP используются для аутентификации и предоставляют Cisco Catalyst Center возможность изменять конфигурации, обновлять программное обеспечение или выполнять другие изменения на сетевом устройстве. |
|
password string |
Пароль для аутентификации HTTP(S) записи, обязателен при использовании HTTP-учетных данных. |
|
port integer |
Порт для аутентификации HTTP(S) записи, обязателен при использовании HTTP-учетных данных. |
|
secure boolean |
Флаг для аутентификации HTTP(S) записи, не обязателен при использовании HTTP-учетных данных. Choices:
|
|
username string |
Имя пользователя для аутентификации HTTP(S) записи, обязательно при использовании HTTP-учетных данных. |
|
net_conf_port string |
Используется, когда сеть содержит беспроводные контроллеры на базе IOS XE. Это используется для обнаружения и включения беспроводных служб на контроллерах. Для работы требуются действительные учетные данные SSH. Избегайте стандартных портов, таких как 22, 80 и 8080. |
|
snmp_v2_read_credential dictionary |
Учетные данные SNMP v2, которые необходимо создать и использовать для связи с устройством по протоколу SNMP в режиме чтения. SNMP v2 также обеспечивает шифрование данных, но использует типы данных. |
|
community string |
Строка сообщества SNMP V2 для чтения позволяет Cisco Catalyst Center извлекать данные только для чтения с устройства. |
|
description string |
Имя/Описание учетных данных для чтения SNMP, которые будут использоваться для создания snmp_v2_read_credential. |
|
snmp_v2_write_credential dictionary |
Учетные данные SNMP v2, которые будут созданы и использованы для связи с устройством по протоколу SNMP в режиме чтения и записи. SNMP v2 также обеспечивает шифрование данных, но использует типы данных. |
|
community string |
Строка сообщества SNMP V2 для записи используется для извлечения данных и изменения конфигурации устройства. |
|
description string |
Имя/Описание учетных данных для записи SNMP, которые будут использоваться для создания snmp_v2_write_credential. |
|
snmp_v3_credential dictionary |
Учетные данные SNMP v3, которые будут созданы и использованы для связи с устройством по протоколу SNMP в режиме чтения и записи. SNMPv3 является наиболее защищенной версией SNMP, позволяющей пользователям полностью шифровать передаваемые данные, защищая нас от внешних злоумышленников. |
|
auth_password string |
Пароль аутентификации протокола SNMP v3, который будет использоваться. Должен иметь длину более 7 символов. Не требуется для режима snmp_mode NOAUTHNOPRIV. |
|
auth_type string |
Тип аутентификации протокола SNMP v3, который будет использоваться. SHA использует алгоритм безопасного хеширования (SHA) в качестве протокола аутентификации. MD5 использует Message Digest 5 (MD5) в качестве протокола аутентификации и не рекомендуется. Не требуется для режима snmp_mode NOAUTHNOPRIV. Варианты:
|
|
privacy_password string |
Пароль конфиденциальности протокола SNMP v3, который будет использоваться в режиме SNMP AUTHPRIV Не требуется для режимов snmp_mode AUTHNOPRIV и NOAUTHNOPRIV. |
|
privacy_type string |
Тип/протокол конфиденциальности протокола SNMP v3, который будет использоваться в режиме SNMP AUTHPRIV Не требуется для режимов snmp_mode AUTHNOPRIV и NOAUTHNOPRIV. Варианты:
|
|
snmp_mode string |
Режим SNMP, который определяет уровень шифрования нашей строки сообщества. Режим AUTHPRIV использует как аутентификацию, так и шифрование. Режим AUTHNOPRIV использует аутентификацию, но не шифрование. Режим NOAUTHNOPRIV не использует ни аутентификацию, ни шифрование. Варианты:
|
|
username string |
Имя пользователя протокола SNMP v3, которое будет использоваться. |
|
discovery_type string / required |
Определяет метод обнаружения устройств. Вот доступные варианты. - SINGLE обнаруживает одно устройство с использованием одного IP-адреса. - RANGE обнаруживает несколько устройств в одном диапазоне IP-адресов. - MULTI RANGE обнаруживает устройства в нескольких диапазонах IP-адресов. - CDP использует протокол Cisco Discovery Protocol для обнаружения устройств в последующих уровнях заданного IP-адреса. - LLDP использует протокол Link Layer Discovery Protocol для обнаружения устройств в последующих уровнях указанного IP-адреса. - CIDR обнаруживает устройства на основе фильтрации подсети с использованием межсетевого маршрутизации без классов. Варианты:
|
|
global_credentials dictionary добавлено в cisco.dnac 6.12.0 |
Набор различных типов учетных данных, включая CLI, SNMP, HTTP и NETCONF, которые пользователь предварительно настроил в разделе «Учетные данные устройства» центра Cisco Catalyst. Если пользователь не передает никаких глобальных учетных данных в playbook, то по умолчанию мы будем использовать все глобальные учетные данные, присутствующие в центре Cisco Catalyst каждого типа, для выполнения обнаружения. (Допускается максимум 5). |
|
cli_credentials_list list / elements=dictionary |
Принимает список глобальных учетных данных CLI для использования в обнаружении устройств. Рекомендуется создавать учетные данные устройства как с уникальным именем пользователя, так и с четким описанием. |
|
description string |
Имя учетных данных CLI, обязательно при использовании глобальных учетных данных CLI. |
|
username string |
Имя пользователя, необходимое для аутентификации CLI и обязательно при использовании глобальных учетных данных CLI. |
|
http_read_credential_list list / elements=dictionary |
Список глобальных учетных данных для чтения HTTP, которые будут использоваться в процессе обнаружения устройств. Рекомендуется создавать учетные данные устройства с уникальным именем пользователя и понятным описанием для удобной идентификации. |
|
description string |
Имя учетных данных для чтения HTTP, обязательно при использовании глобальных учетных данных HTTP. |
|
username string |
Имя пользователя для проверки подлинности чтения HTTP, обязательно при использовании глобальных учетных данных HTTP. |
|
http_write_credential_list list / elements=dictionary |
Список глобальных учетных данных для записи HTTP, которые будут использоваться в процессе обнаружения устройств. Рекомендуется создавать учетные данные устройства с уникальным именем пользователя и понятным описанием для удобной идентификации. |
|
description string |
Имя учетных данных для записи HTTP, обязательно при использовании глобальных учетных данных HTTP. |
|
username string |
Имя пользователя для проверки подлинности записи HTTP, обязательно при использовании глобальных учетных данных HTTP. |
|
net_conf_port_list list / elements=dictionary |
Список глобальных портов Netconf, которые будут использоваться во время обнаружения устройств. Рекомендуется создавать учетные данные устройства с уникальным описанием. |
|
description string |
Имя учетных данных порта Netconf, обязательно при использовании глобального порта Netconf. |
|
snmp_v2_read_credential_list list / elements=dictionary |
Список глобальных учетных данных для чтения SNMP V2, которые будут использоваться во время обнаружения устройств. Рекомендуется создавать учетные данные устройства с понятным описанием для удобной идентификации. |
|
description string |
Имя учетных данных для чтения SNMP, обязательно при использовании глобальных учетных данных SNMP. |
|
snmp_v2_write_credential_list list / elements=dictionary |
Список глобальных учетных данных для записи SNMP V2, которые будут использоваться во время обнаружения устройств. Рекомендуется создавать учетные данные устройства с понятным описанием для удобной идентификации. |
|
description string |
Имя учетных данных для записи SNMP, обязательно при использовании глобальных учетных данных SNMP. |
|
snmp_v3_credential_list list / elements=dictionary |
Список глобальных учетных данных SNMP V3, которые будут использоваться во время обнаружения устройств, предоставляя режимы чтения и записи. Рекомендуется создавать учетные данные устройства с уникальным именем пользователя и понятным описанием для удобной идентификации. |
|
description string |
Имя учетных данных SNMP V3, обязательно при использовании глобальных учетных данных SNMP. |
|
username string |
Имя пользователя для проверки подлинности SNMP V3, обязательно при использовании глобальных учетных данных SNMP. |
|
ip_address_list list / elements=string / required |
Список IP-адресов, которые необходимо обнаружить. Для обнаружения на основе CDP/LLDP/SINGLE необходимо передать список с одним элементом, например - 10.197.156.22. Для обнаружения на основе CIDR необходимо передать список с одним элементом, например - 10.197.156.22/22. Для обнаружения на основе RANGE необходимо передать список с одним элементом и диапазоном, например - 10.197.156.1-10.197.156.100. Для обнаружения на основе MULTI RANGE необходимо передать список с несколькими элементами, например - 10.197.156.1-10.197.156.100, а в следующей строке - 10.197.157.1-10.197.157.100. Допускается максимум 8 диапазонов IP-адресов. |
|
ip_filter_list list / elements=string |
Список IP-адресов, которые необходимо исключить из переданных IP-адресов. |
|
lldp_level integer |
Общее количество уровней в методе обнаружения lldp По умолчанию: |
|
preferred_mgmt_ip_method string |
Предпочтительный метод управления IP (None/UseLoopBack) По умолчанию: |
|
protocol_order string |
Определяет порядок попыток подключения к устройствам. Доступные варианты: - “telnet” — будут использоваться только подключения telnet. - “ssh, telnet” — сначала будет использоваться SSH (Secure Shell), а затем telnet, если SSH не удастся. По умолчанию: |
|
records_to_return integer |
Количество записей, возвращаемых для заголовка при получении глобальных учетных данных v2. По умолчанию: |
|
retry integer |
Количество попыток установления соединения с устройством. |
|
start_index integer |
Начальный индекс для заголовка при получении учетных данных SNMP v2. По умолчанию: |
|
timeout integer |
Время ожидания ответа устройства в секундах. |
|
use_global_credentials boolean |
Определяет, использовать ли при обнаружении устройств предварительно настроенные глобальные учетные данные. Установка в True использует предопределенные глобальные учетные данные для задач обнаружения. Это значение по умолчанию. Установка в False требует предоставления учетных данных, специфичных для устройства, для обнаружения, так как глобальные учетные данные будут проигнорированы. Доступные значения:
|
config_verify boolean | Установите в True для проверки конфигурации Cisco Catalyst Center после применения конфигурации в книге. Доступные значения:
|
dnac_api_task_timeout integer | Определяет таймаут в секундах для API-запросов получения деталей задачи. Если детали задачи не получены в течение этого периода, процесс завершится, и будет зарегистрировано уведомление о таймауте. По умолчанию: |
dnac_debug boolean | Указывает, включено ли отладка в SDK Cisco Catalyst Center. Доступные значения:
|
dnac_host string / обязательно | Имя хоста Cisco Catalyst Center. |
dnac_log boolean | Флаг для включения/отключения ведения журнала выполнения книги. Когда true и dnac_log_file_path предоставлен, - Создается файл журнала в месте выполнения с указанным именем. Когда true и dnac_log_file_path не предоставлен, - Создается файл журнала в месте выполнения с именем ‘dnac.log’. Когда false, - Ведение журнала отключено. Если файл журнала не существует, - Он создается в режиме добавления или записи в зависимости от флага “dnac_log_append”. Если файл журнала существует, - Он перезаписывается или дополняется в зависимости от флага “dnac_log_append”. Доступные значения:
|
dnac_log_append boolean | Определяет режим файла. Установите в True для режима «добавление». Установите в False для режима «запись». Доступные значения:
|
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). - В сценариях совместного использования файла, без режима добавления, содержимое перезаписывается после каждой модульной операции. - Для общего файла журнала, установите режим добавления в False для первого модуля (для перезаписи); для последующих модулей установите режим добавления в True. По умолчанию: |
dnac_log_level string | Устанавливает порог уровня журнала. Сообщения с уровнем, равным или превышающим этот уровень, будут записаны в журнал. Уровни перечислены в порядке серьезности [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL указывает серьезные ошибки, останавливающие программу. Отображаются только сообщения CRITICAL. ERROR указывает проблемы, препятствующие выполнению функции. Отображаются сообщения ERROR и CRITICAL. WARNING указывает потенциальные будущие проблемы. Отображаются сообщения WARNING, ERROR, CRITICAL. INFO отслеживает нормальную работу. Отображаются сообщения INFO, WARNING, ERROR, CRITICAL. DEBUG предоставляет подробную диагностическую информацию. Отображаются все сообщения журнала. По умолчанию: |
dnac_password string | Пароль для аутентификации в Cisco Catalyst Center. |
dnac_port string | Указывает номер порта, связанный с Cisco Catalyst Center. По умолчанию: |
dnac_task_poll_interval integer | Указывает интервал в секундах между последовательными вызовами API для получения подробностей о задаче. По умолчанию: |
dnac_username aliases: user string | Имя пользователя для аутентификации в Cisco Catalyst Center. По умолчанию: |
dnac_verify boolean | Флаг для включения или отключения проверки сертификата SSL. Варианты:
|
dnac_version string | Указывает версию Cisco Catalyst Center, которую должен использовать SDK. По умолчанию: |
state string | Состояние Cisco Catalyst Center после завершения модуля. Варианты:
|
validate_response_schema boolean | Флаг для Cisco Catalyst Center SDK для включения проверки тел запросов по JSON-схеме. Варианты:
|
Примечания
Примечание
- Используемые методы SDK: discovery.Discovery.get_all_global_credentials_v2, discovery.Discovery.start_discovery, task.Task.get_task_by_id, discovery.Discovery.get_discoveries_by_range, discovery.Discovery.get_discovered_network_devices_by_discovery_id’, discovery.Discovery.delete_discovery_by_id discovery.Discovery.delete_all_discovery discovery.Discovery.get_count_of_all_discovery_jobs
- Используемые пути: get /dna/intent/api/v2/global-credential post /dna/intent/api/v1/discovery get /dna/intent/api/v1/task/{taskId} get /dna/intent/api/v1/discovery/{startIndex}/{recordsToReturn} get /dna/intent/api/v1/discovery/{id}/network-device delete /dna/intent/api/v1/discovery/{id} delete /dna/intent/api/v1/delete get /dna/intent/api/v1/discovery/count
- Параметр ‘global_cli_len’ удален в версии 6.12.0.
- Не поддерживает
check_mode - Плагин работает на узле управления и не использует плагины подключения ansible, вместо этого используется встроенный менеджер подключений из Cisco Catalyst Center SDK
- Параметры, начинающиеся с dnac_, используются Cisco Catalyst Center Python SDK для установления соединения
Примеры
- name: Execute discovery of devices with both global credentials and discovery specific credentials
cisco.dnac.discovery_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:
- discovery_name: Discovery with both global and job specific credentials
discovery_type: RANGE
ip_address_list:
- 201.1.1.1-201.1.1.100
ip_filter_list:
- 201.1.1.2
- 201.1.1.10
discovery_specific_credentials:
cli_credentials_list:
- username: cisco
password: Cisco123
enable_password: Cisco123
http_read_credential:
username: cisco
password: Cisco123
port: 443
secure: true
http_write_credential:
username: cisco
password: Cisco123
port: 443
secure: True
snmp_v2_read_credential:
description: snmp_v2-new
community: Cisco123
snmp_v2_write_credential:
description: snmp_v2-new
community: Cisco123
snmp_v3_credential:
username: v3Public2
snmp_mode: AUTHPRIV
auth_type: SHA
auth_password: Lablab123
privacy_type: AES256
privacy_password: Lablab123
net_conf_port: 750
global_credentials:
cli_credentials_list:
- description: ISE
username: cisco
- description: CLI1234
username: cli
http_read_credential_list:
- description: HTTP Read
username: HTTP_Read
http_write_credential_list:
- description: HTTP Write
username: HTTP_Write
snmp_v3_credential_list:
- description: snmpV3
username: snmpV3
snmp_v2_read_credential_list:
- description: snmpV2_read
snmp_v2_write_credential_list:
- description: snmpV2_write
net_conf_port_list:
- description: Old_one
start_index: 1
records_to_return: 100
protocol_order: ssh
retry: 5
timeout: 3
- name: Execute discovery of devices with discovery specific credentials only
cisco.dnac.discovery_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:
- discovery_name: Single with discovery specific credentials only
discovery_type: SINGLE
ip_address_list:
- 204.1.1.10
discovery_specific_credentials:
cli_credentials_list:
- username: cisco
password: Cisco123
enable_password: Cisco123
http_read_credential:
username: cisco
password: Cisco123
port: 443
secure: true
http_write_credential:
username: cisco
password: Cisco123
port: 443
secure: True
snmp_v2_read_credential:
description: snmp_v2-new
community: Cisco123
snmp_v2_write_credential:
description: snmp_v2-new
community: Cisco123
snmp_v3_credential:
username: v3Public2
snmp_mode: AUTHPRIV
auth_type: SHA
auth_password: Lablab123
privacy_type: AES256
privacy_password: Lablab123
net_conf_port: 750
use_global_credentials: False
start_index: 1
records_to_return: 100
protocol_order: ssh
retry: 5
timeout: 3
- name: Execute discovery of devices with global credentials only
cisco.dnac.discovery_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:
- discovery_name: CDP with global credentials only
discovery_type: CDP
ip_address_list:
- 204.1.1.1
cdp_level: 16
global_credentials:
cli_credentials_list:
- description: ISE
username: cisco
- description: CLI1234
username: cli
http_read_credential_list:
- description: HTTP Read
username: HTTP_Read
http_write_credential_list:
- description: HTTP Write
username: HTTP_Write
snmp_v3_credential_list:
- description: snmpV3
username: snmpV3
snmp_v2_read_credential_list:
- description: snmpV2_read
snmp_v2_write_credential_list:
- description: snmpV2_write
net_conf_port_list:
- description: Old_one
start_index: 1
records_to_return: 100
protocol_order: ssh
retry: 5
timeout: 3
- name: Execute discovery of devices with all the global credentials (max 5 allowed)
cisco.dnac.discovery_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:
- discovery_name: CIDR with all global credentials
discovery_type: CIDR
ip_address_list:
- 204.1.2.0/24
ip_filter_list:
- 204.1.2.10
preferred_mgmt_ip_method: None
start_index: 1
records_to_return: 100
protocol_order: telnet
retry: 10
timeout: 3
use_global_credentials: True
- name: Delete disovery by name
cisco.dnac.discovery_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:
- discovery_name: Single discovery
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
Ключ | Описание |
|---|---|
response_1 словарь | Словарь с ответом, возвращенным Cisco Catalyst Center Python SDK Возвращается: всегда Пример: |
response_2 список / элементы=строка | Список с ответом, возвращенным Cisco Catalyst Center Python SDK Возвращается: всегда Пример: |
response_3 словарь | Строка с ответом, возвращенным Cisco Catalyst Center Python SDK Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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/discovery_workflow_manager_module.html