Модуль cisco.dnac.discovery_summary_info – Модуль информации для сводки обнаружения

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

Описание
Требования
Параметры
Примечания
См. также
Примеры
Значения возврата

Описание

Получить все сводки обнаружения.
Возвращает устройства, обнаруженные в заданном обнаружении на основе заданных фильтров. Идентификатор обнаружения можно получить с помощью API «Получить обнаружения по диапазону».

Примечание

У этого модуля есть соответствующий плагин действий.

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
cliStatus list / elements=string	Параметр запроса CliStatus. Статус CLI для IP-адреса во время выполнения задания. Доступные значения: «SUCCESS», «FAILURE», «NOT-PROVIDED» и «NOT-VALIDATED».
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Варианты: `false` ← (default) `true`
dnac_host string / required	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username aliases: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (default)
dnac_version string	Информирует SDK о версии Cisco DNA Center, которую необходимо использовать. По умолчанию: `"2.3.7.6"`
headers dictionary	Дополнительные заголовки.
httpStatus list / elements=string	Параметр запроса HttpStatus. HTTP-статус для IP-адреса во время выполнения задания. Доступные значения: «SUCCESS», «FAILURE», «NOT-PROVIDED» и «NOT-VALIDATED».
id string	Параметр пути Id. Идентификатор обнаружения.
ipAddress list / elements=string	Параметр запроса IpAddress. IP-адрес устройства.
netconfStatus list / elements=string	Параметр запроса NetconfStatus. Статус NETCONF для IP-адреса во время выполнения задания. Доступные значения: «SUCCESS», «FAILURE», «NOT-PROVIDED» и «NOT-VALIDATED».
pingStatus list / elements=string	Параметр запроса PingStatus. Статус ping для IP-адреса во время выполнения задания. Доступные значения: «SUCCESS», «FAILURE», «NOT-PROVIDED» и «NOT-VALIDATED».
snmpStatus list / elements=string	Параметр запроса SnmpStatus. Статус SNMP для IP-адреса во время выполнения задания. Доступные значения: «SUCCESS», «FAILURE», «NOT-PROVIDED» и «NOT-VALIDATED».
sortBy string	Параметр запроса SortBy. Сортировка по полю. Доступные значения: pingStatus, cliStatus, snmpStatus, httpStatus и netconfStatus.
sortOrder string	Параметр запроса SortOrder. Порядок сортировки на основе sortBy. Доступные значения: «asc» и «des».
taskId string	Параметр запроса TaskId.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие схеме JSON. Варианты: `false` `true` ← (default)

Примечания

Примечание

Используемые методы SDK: discovery.Discovery.get_network_devices_from_discovery,
Используемые пути: get /dna/intent/api/v1/discovery/{id}/summary,
Поддерживает check_mode
Плагин работает на узле управления и не использует плагины подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления соединения

См. также

Документация Cisco DNA Center для Discovery GetNetworkDevicesFromDiscovery: Полная справка по API GetNetworkDevicesFromDiscovery.

Примеры

- name: Get all Discovery Summary
  cisco.dnac.discovery_summary_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    taskId: string
    sortBy: string
    sortOrder: string
    ipAddress: []
    pingStatus: []
    snmpStatus: []
    cliStatus: []
    netconfStatus: []
    httpStatus: []
    id: string
  register: result

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

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

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

Авторы

Rafael Campos (@racampos)

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

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