cisco.dnac.client_enrichment_details_info модуль — Модуль информации для деталей обогащения клиента

Примечание

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

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

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

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

В cisco.dnac с версии 3.1.0

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

Описание

Получение всех деталей обогащения клиента.
Обогащает контекст конечного пользователя заданной сети с идентификатором пользователя сети или MAC-адресом устройства конечного пользователя данными о пользователе, устройствах, к которым подключен пользователь, и проблемах гарантии, от которых страдает пользователь.

Примечание

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

Требования

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

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	Дополнительные заголовки.
validate_response_schema boolean	Флаг для Cisco DNA Center SDK для включения проверки тел запросов на соответствие JSON-схеме. Варианты: `false` `true` ← (по умолчанию)

Примечания

Примечание

Используемые методы SDK — clients.Clients.get_client_enrichment_details,
Используемые пути — get /dna/intent/api/v1/client-enrichment-details,
Поддерживает check_mode
Плагин работает на контрольном узле и не использует плагины подключения ansible, а вместо этого использует встроенный менеджер подключения из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

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

Примеры

- name: Get all Client Enrichment Details
  cisco.dnac.client_enrichment_details_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}}"
  register: result

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

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

Ключ	Описание
dnac_response list / elements=dictionary	Словарь или список с ответом, возвращаемым Cisco DNAC Python SDK Возвращаемое значение: всегда Пример: "[\n {\n \"userDetails\": {\n \"id\": \"string\",\n \"connectionStatus\": \"string\",\n \"hostType\": \"string\",\n \"userId\": \"string\",\n \"hostName\": {},\n \"hostOs\": {},\n \"hostVersion\": {},\n \"subType\": {},\n \"lastUpdated\": 0,\n \"healthScore\": [\n {\n \"healthType\": \"string\",\n \"reason\": \"string\",\n \"score\": 0\n }\n ],\n \"hostMac\": \"string\",\n \"hostIpV4\": \"string\",\n \"hostIpV6\": [\n {}\n ],\n \"authType\": {},\n \"vlanId\": \"string\",\n \"ssid\": {},\n \"location\": {},\n \"clientConnection\": \"string\",\n \"connectedDevice\": [\n {}\n ],\n \"issueCount\": 0,\n \"rssi\": {},\n \"snr\": {},\n \"dataRate\": {},\n \"port\": {}\n },\n \"connectedDevice\": [\n {\n \"deviceDetails\": {\n \"family\": \"string\",\n \"type\": \"string\",\n \"location\": {},\n \"errorCode\": \"string\",\n \"macAddress\": \"string\",\n \"role\": \"string\",\n \"apManagerInterfaceIp\": \"string\",\n \"associatedWlcIp\": \"string\",\n \"bootDateTime\": {},\n \"collectionStatus\": \"string\",\n \"interfaceCount\": {},\n \"lineCardCount\": {},\n \"lineCardId\": {},\n \"managementIpAddress\": \"string\",\n \"memorySize\": \"string\",\n \"platformId\": \"string\",\n \"reachabilityFailureReason\": \"string\",\n \"reachabilityStatus\": \"string\",\n \"snmpContact\": \"string\",\n \"snmpLocation\": \"string\",\n \"tunnelUdpPort\": \"string\",\n \"waasDeviceMode\": {},\n \"series\": \"string\",\n \"inventoryStatusDetail\": \"string\",\n \"collectionInterval\": \"string\",\n \"serialNumber\": \"string\",\n \"softwareVersion\": \"string\",\n \"roleSource\": \"string\",\n \"hostname\": \"string\",\n \"upTime\": \"string\",\n \"lastUpdateTime\": 0,\n \"errorDescription\": {},\n \"locationName\": {},\n \"tagCount\": \"string\",\n \"lastUpdated\": \"string\",\n \"instanceUuid\": \"string\",\n \"id\": \"string\",\n \"neighborTopology\": [\n {\n \"nodes\": [\n {\n \"role\": \"string\",\n \"name\": \"string\",\n \"id\": \"string\",\n \"description\": \"string\",\n \"deviceType\": {},\n \"platformId\": {},\n \"family\": {},\n \"ip\": {},\n \"softwareVersion\": {},\n \"userId\": {},\n \"nodeType\": {},\n \"radioFrequency\": {},\n \"clients\": 0,\n \"count\": {},\n \"healthScore\": {},\n \"level\": 0,\n \"fabricGroup\": {}\n }\n ],\n \"links\": [\n {\n \"source\": \"string\",\n \"linkStatus\": \"string\",\n \"label\": [\n {}\n ],\n \"target\": \"string\",\n \"id\": {},\n \"portUtilization\": {}\n }\n ]\n }\n ],\n \"cisco360view\": \"string\"\n }\n }\n ],\n \"issueDetails\": {\n \"issue\": [\n {\n \"issueId\": \"string\",\n \"issueSource\": \"string\",\n \"issueCategory\": \"string\",\n \"issueName\": \"string\",\n \"issueDescription\": \"string\",\n \"issueEntity\": \"string\",\n \"issueEntityValue\": \"string\",\n \"issueSeverity\": \"string\",\n \"issuePriority\": \"string\",\n \"issueSummary\": \"string\",\n \"issueTimestamp\": 0,\n \"suggestedActions\": [\n {\n \"message\": \"string\",\n \"steps\": [\n {}\n ]\n }\n ],\n \"impactedHosts\": [\n {\n \"hostType\": \"string\",\n \"hostName\": \"string\",\n \"hostOs\": \"string\",\n \"ssid\": \"string\",\n \"connectedInterface\": \"string\",\n \"macAddress\": \"string\",\n \"failedAttempts\": 0,\n \"location\": {\n \"siteId\": \"string\",\n \"siteType\": \"string\",\n \"area\": \"string\",\n \"building\": \"string\",\n \"floor\": {},\n \"apsImpacted\": [\n {}\n ]\n },\n \"timestamp\": 0\n }\n ]\n }\n ]\n }\n }\n]\n"

Ключ

Описание

dnac_response

list / elements=dictionary

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

Возвращаемое значение: всегда

Пример: "[\n {\n \"userDetails\": {\n \"id\": \"string\",\n \"connectionStatus\": \"string\",\n \"hostType\": \"string\",\n \"userId\": \"string\",\n \"hostName\": {},\n \"hostOs\": {},\n \"hostVersion\": {},\n \"subType\": {},\n \"lastUpdated\": 0,\n \"healthScore\": [\n {\n \"healthType\": \"string\",\n \"reason\": \"string\",\n \"score\": 0\n }\n ],\n \"hostMac\": \"string\",\n \"hostIpV4\": \"string\",\n \"hostIpV6\": [\n {}\n ],\n \"authType\": {},\n \"vlanId\": \"string\",\n \"ssid\": {},\n \"location\": {},\n \"clientConnection\": \"string\",\n \"connectedDevice\": [\n {}\n ],\n \"issueCount\": 0,\n \"rssi\": {},\n \"snr\": {},\n \"dataRate\": {},\n \"port\": {}\n },\n \"connectedDevice\": [\n {\n \"deviceDetails\": {\n \"family\": \"string\",\n \"type\": \"string\",\n \"location\": {},\n \"errorCode\": \"string\",\n \"macAddress\": \"string\",\n \"role\": \"string\",\n \"apManagerInterfaceIp\": \"string\",\n \"associatedWlcIp\": \"string\",\n \"bootDateTime\": {},\n \"collectionStatus\": \"string\",\n \"interfaceCount\": {},\n \"lineCardCount\": {},\n \"lineCardId\": {},\n \"managementIpAddress\": \"string\",\n \"memorySize\": \"string\",\n \"platformId\": \"string\",\n \"reachabilityFailureReason\": \"string\",\n \"reachabilityStatus\": \"string\",\n \"snmpContact\": \"string\",\n \"snmpLocation\": \"string\",\n \"tunnelUdpPort\": \"string\",\n \"waasDeviceMode\": {},\n \"series\": \"string\",\n \"inventoryStatusDetail\": \"string\",\n \"collectionInterval\": \"string\",\n \"serialNumber\": \"string\",\n \"softwareVersion\": \"string\",\n \"roleSource\": \"string\",\n \"hostname\": \"string\",\n \"upTime\": \"string\",\n \"lastUpdateTime\": 0,\n \"errorDescription\": {},\n \"locationName\": {},\n \"tagCount\": \"string\",\n \"lastUpdated\": \"string\",\n \"instanceUuid\": \"string\",\n \"id\": \"string\",\n \"neighborTopology\": [\n {\n \"nodes\": [\n {\n \"role\": \"string\",\n \"name\": \"string\",\n \"id\": \"string\",\n \"description\": \"string\",\n \"deviceType\": {},\n \"platformId\": {},\n \"family\": {},\n \"ip\": {},\n \"softwareVersion\": {},\n \"userId\": {},\n \"nodeType\": {},\n \"radioFrequency\": {},\n \"clients\": 0,\n \"count\": {},\n \"healthScore\": {},\n \"level\": 0,\n \"fabricGroup\": {}\n }\n ],\n \"links\": [\n {\n \"source\": \"string\",\n \"linkStatus\": \"string\",\n \"label\": [\n {}\n ],\n \"target\": \"string\",\n \"id\": {},\n \"portUtilization\": {}\n }\n ]\n }\n ],\n \"cisco360view\": \"string\"\n }\n }\n ],\n \"issueDetails\": {\n \"issue\": [\n {\n \"issueId\": \"string\",\n \"issueSource\": \"string\",\n \"issueCategory\": \"string\",\n \"issueName\": \"string\",\n \"issueDescription\": \"string\",\n \"issueEntity\": \"string\",\n \"issueEntityValue\": \"string\",\n \"issueSeverity\": \"string\",\n \"issuePriority\": \"string\",\n \"issueSummary\": \"string\",\n \"issueTimestamp\": 0,\n \"suggestedActions\": [\n {\n \"message\": \"string\",\n \"steps\": [\n {}\n ]\n }\n ],\n \"impactedHosts\": [\n {\n \"hostType\": \"string\",\n \"hostName\": \"string\",\n \"hostOs\": \"string\",\n \"ssid\": \"string\",\n \"connectedInterface\": \"string\",\n \"macAddress\": \"string\",\n \"failedAttempts\": 0,\n \"location\": {\n \"siteId\": \"string\",\n \"siteType\": \"string\",\n \"area\": \"string\",\n \"building\": \"string\",\n \"floor\": {},\n \"apsImpacted\": [\n {}\n ]\n },\n \"timestamp\": 0\n }\n ]\n }\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/client_enrichment_details_info_module.html