Модуль cisco.dnac.applications_health_info – Модуль информации о состоянии приложений

Примечание

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

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

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

Для использования в книге задач укажите: cisco.dnac.applications_health_info.

Новая в cisco.dnac 3.1.0

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

Обзор

Получение всех данных о состоянии приложений.
API намерений для получения списка приложений для определенного сайта, устройства или MAC-адреса устройства-клиента. Для сочетания конкретного приложения с сайтом и/или устройством API получает список проблем/устройств/точек конечного доступа.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
applicationHealth строка	Параметр запроса applicationHealth. Категория состояния приложения (POOR, FAIR или GOOD. Допускается использовать только с siteId).
applicationName строка	Параметр запроса applicationName. Название приложения, для которого требуется получить информацию.
deviceId строка	Параметр запроса deviceId. Значение UUID устройства Assurance (нельзя использовать вместе с siteId и clientMac).
dnac_debug логическое	Флаг для включения отладки в Cisco DNA Center SDK. Варианты: `false` ← (по умолчанию) `true`
dnac_host строка / обязательный	Имя хоста Cisco DNA Center.
dnac_password строка	Пароль Cisco DNA Center для аутентификации.
dnac_port целое число	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user строка	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify логическое	Флаг для включения или отключения проверки сертификата SSL. Варианты: `false` `true` ← (по умолчанию)
dnac_version строка	Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
endTime число с плавающей точкой	Параметр запроса endTime. Конечная метка времени в миллисекундах временного окна.
headers словарь	Дополнительные заголовки.
limit число с плавающей точкой	Параметр запроса limit. Максимальное количество записей приложения в возвращаемых данных 1, 1000 (допускается использовать только с siteId).
macAddress строка	Параметр запроса macAddress. MAC-адрес клиентского устройства (нельзя использовать вместе с siteId и deviceId).
offset число с плавающей точкой	Параметр запроса offset. Смещение первой записи приложения в возвращаемых данных (допускается использовать только с siteId).
siteId строка	Параметр запроса siteId. Значение UUID сайта Assurance (нельзя использовать вместе с deviceId и clientMac).
startTime число с плавающей точкой	Параметр запроса startTime. Начальная метка времени в миллисекундах временного окна.
validate_response_schema логическое	Флаг для включения проверки тел запросов Cisco DNA Center SDK на соответствие схеме JSON. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемый метод SDK — applications.Applications.applications,
Используемые пути — get /dna/intent/api/v1/application-health,
Поддерживает check_mode
Плагин работает на узле управления и не использует какие-либо плагины подключения Ansible, а вместо этого использует встроенный диспетчер подключений Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Get all Applications Health
  cisco.dnac.applications_health_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}}"
    siteId: string
    deviceId: string
    macAddress: string
    startTime: 0
    endTime: 0
    applicationHealth: string
    offset: 0
    limit: 0
    applicationName: string
  register: result

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

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

Ключ	Описание
dnac_response словарь	Словарь или список с ответом, возвращённым Cisco DNAC Python SDK Возвращается: всегда Пример: {"response": [{"application": "string", "applicationServerLatency": {}, "averageThroughput": 0, "businessRelevance": "string", "clientIp": "string", "clientMacAddress": "string", "clientName": "string", "clientNetworkLatency": {}, "deviceType": "string", "exporterFamily": "string", "exporterIpAddress": "string", "exporterName": "string", "exporterUUID": "string", "health": 0, "issueId": "string", "issueName": "string", "jitter": {}, "location": "string", "name": "string", "networkLatency": {}, "occurrences": 0, "operatingSystem": "string", "packetLossPercent": {}, "priority": "string", "rootCause": "string", "serverNetworkLatency": {}, "severity": "string", "summary": "string", "timestamp": 0, "trafficClass": "string", "usageBytes": 0}], "totalCount": 0, "version": "string"}

Ключ

Описание

dnac_response

словарь

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

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

Пример: {"response": [{"application": "string", "applicationServerLatency": {}, "averageThroughput": 0, "businessRelevance": "string", "clientIp": "string", "clientMacAddress": "string", "clientName": "string", "clientNetworkLatency": {}, "deviceType": "string", "exporterFamily": "string", "exporterIpAddress": "string", "exporterName": "string", "exporterUUID": "string", "health": 0, "issueId": "string", "issueName": "string", "jitter": {}, "location": "string", "name": "string", "networkLatency": {}, "occurrences": 0, "operatingSystem": "string", "packetLossPercent": {}, "priority": "string", "rootCause": "string", "serverNetworkLatency": {}, "severity": "string", "summary": "string", "timestamp": 0, "trafficClass": "string", "usageBytes": 0}], "totalCount": 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/applications_health_info_module.html