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

Примечание

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

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

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

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

Новый в cisco.dnac 3.1.0

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

Описание

Получить все данные о состоянии сайта.
Возвращает общую информацию о состоянии всех сайтов.

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

Параметр	Комментарии
dnac_debug boolean	Флаг для Cisco DNA Center SDK для включения отладки. Выбираемые значения: `false` ← (по умолчанию) `true`
dnac_host string / обязательный	Имя хоста Cisco DNA Center.
dnac_password string	Пароль Cisco DNA Center для аутентификации.
dnac_port integer	Порт Cisco DNA Center. По умолчанию: `443`
dnac_username псевдонимы: user string	Имя пользователя Cisco DNA Center для аутентификации. По умолчанию: `"admin"`
dnac_verify boolean	Флаг для включения или выключения проверки сертификата SSL. Выбираемые значения: `false` `true` ← (по умолчанию)
dnac_version string	Указывает SDK, какую версию Cisco DNA Center использовать. По умолчанию: `"2.3.7.6"`
headers dictionary	Дополнительные заголовки.
... (rest of the table)	...

Примечания

Примечание

Используемые методы SDK: sites.Sites.get_site_health,
Используемые пути: get /dna/intent/api/v1/site-health,
Поддерживает check_mode
Плагин выполняется на узле управления и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center для Sites GetSiteHealth: Полное описание API GetSiteHealth.

Примеры

- name: Get all Site Health
  cisco.dnac.site_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}}"
    siteType: string
    offset: 0
    limit: 0
    timestamp: 0
  register: result

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

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

Ключ	Описание
dnac_response список / элементы=словарь	Словарь или список с ответом, возвращенным Cisco DNAC Python SDK Возвращается: всегда Пример: "[\n {\n \"siteName\": \"string\",\n \"siteId\": \"string\",\n \"parentSiteId\": \"string\",\n \"parentSiteName\": \"string\",\n \"siteType\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"healthyNetworkDevicePercentage\": 0,\n \"healthyClientsPercentage\": 0,\n \"clientHealthWired\": 0,\n \"clientHealthWireless\": 0,\n \"numberOfClients\": 0,\n \"numberOfNetworkDevice\": 0,\n \"networkHealthAverage\": 0,\n \"networkHealthAccess\": 0,\n \"networkHealthCore\": 0,\n \"networkHealthDistribution\": 0,\n \"networkHealthRouter\": 0,\n \"networkHealthWireless\": 0,\n \"networkHealthAP\": 0,\n \"networkHealthWLC\": 0,\n \"networkHealthSwitch\": 0,\n \"networkHealthOthers\": 0,\n \"numberOfWiredClients\": 0,\n \"numberOfWirelessClients\": 0,\n \"totalNumberOfConnectedWiredClients\": 0,\n \"totalNumberOfActiveWirelessClients\": 0,\n \"wiredGoodClients\": 0,\n \"wirelessGoodClients\": 0,\n \"overallGoodDevices\": 0,\n \"accessGoodCount\": 0,\n \"accessTotalCount\": 0,\n \"coreGoodCount\": 0,\n \"coreTotalCount\": 0,\n \"distributionGoodCount\": 0,\n \"distributionTotalCount\": 0,\n \"routerGoodCount\": 0,\n \"routerTotalCount\": 0,\n \"wirelessDeviceGoodCount\": 0,\n \"wirelessDeviceTotalCount\": 0,\n \"apDeviceGoodCount\": 0,\n \"apDeviceTotalCount\": 0,\n \"wlcDeviceGoodCount\": 0,\n \"wlcDeviceTotalCount\": 0,\n \"switchDeviceGoodCount\": 0,\n \"switchDeviceTotalCount\": 0,\n \"applicationHealth\": 0,\n \"applicationHealthInfo\": [\n {\n \"trafficClass\": \"string\",\n \"bytesCount\": 0,\n \"healthScore\": 0\n }\n ],\n \"applicationGoodCount\": 0,\n \"applicationTotalCount\": 0,\n \"applicationBytesTotalCount\": 0,\n \"dnacInfo\": {\n \"uuid\": \"string\",\n \"ip\": \"string\",\n \"status\": \"string\"\n },\n \"usage\": 0,\n \"applicationHealthStats\": {\n \"appTotalCount\": 0,\n \"businessRelevantAppCount\": {\n \"poor\": 0,\n \"fair\": 0,\n \"good\": 0\n },\n \"businessIrrelevantAppCount\": {\n \"poor\": 0,\n \"fair\": 0,\n \"good\": 0\n },\n \"defaultHealthAppCount\": {\n \"poor\": 0,\n \"fair\": 0,\n \"good\": 0\n }\n }\n }\n]\n"

Ключ

Описание

dnac_response

список / элементы=словарь

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

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

Пример: "[\n {\n \"siteName\": \"string\",\n \"siteId\": \"string\",\n \"parentSiteId\": \"string\",\n \"parentSiteName\": \"string\",\n \"siteType\": \"string\",\n \"latitude\": 0,\n \"longitude\": 0,\n \"healthyNetworkDevicePercentage\": 0,\n \"healthyClientsPercentage\": 0,\n \"clientHealthWired\": 0,\n \"clientHealthWireless\": 0,\n \"numberOfClients\": 0,\n \"numberOfNetworkDevice\": 0,\n \"networkHealthAverage\": 0,\n \"networkHealthAccess\": 0,\n \"networkHealthCore\": 0,\n \"networkHealthDistribution\": 0,\n \"networkHealthRouter\": 0,\n \"networkHealthWireless\": 0,\n \"networkHealthAP\": 0,\n \"networkHealthWLC\": 0,\n \"networkHealthSwitch\": 0,\n \"networkHealthOthers\": 0,\n \"numberOfWiredClients\": 0,\n \"numberOfWirelessClients\": 0,\n \"totalNumberOfConnectedWiredClients\": 0,\n \"totalNumberOfActiveWirelessClients\": 0,\n \"wiredGoodClients\": 0,\n \"wirelessGoodClients\": 0,\n \"overallGoodDevices\": 0,\n \"accessGoodCount\": 0,\n \"accessTotalCount\": 0,\n \"coreGoodCount\": 0,\n \"coreTotalCount\": 0,\n \"distributionGoodCount\": 0,\n \"distributionTotalCount\": 0,\n \"routerGoodCount\": 0,\n \"routerTotalCount\": 0,\n \"wirelessDeviceGoodCount\": 0,\n \"wirelessDeviceTotalCount\": 0,\n \"apDeviceGoodCount\": 0,\n \"apDeviceTotalCount\": 0,\n \"wlcDeviceGoodCount\": 0,\n \"wlcDeviceTotalCount\": 0,\n \"switchDeviceGoodCount\": 0,\n \"switchDeviceTotalCount\": 0,\n \"applicationHealth\": 0,\n \"applicationHealthInfo\": [\n {\n \"trafficClass\": \"string\",\n \"bytesCount\": 0,\n \"healthScore\": 0\n }\n ],\n \"applicationGoodCount\": 0,\n \"applicationTotalCount\": 0,\n \"applicationBytesTotalCount\": 0,\n \"dnacInfo\": {\n \"uuid\": \"string\",\n \"ip\": \"string\",\n \"status\": \"string\"\n },\n \"usage\": 0,\n \"applicationHealthStats\": {\n \"appTotalCount\": 0,\n \"businessRelevantAppCount\": {\n \"poor\": 0,\n \"fair\": 0,\n \"good\": 0\n },\n \"businessIrrelevantAppCount\": {\n \"poor\": 0,\n \"fair\": 0,\n \"good\": 0\n },\n \"defaultHealthAppCount\": {\n \"poor\": 0,\n \"fair\": 0,\n \"good\": 0\n }\n }\n }\n]\n"

Авторы

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/site_health_info_module.html