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

Примечание

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

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

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

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

Новое в cisco.dnac 3.1.0

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

Описание

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

Примечание

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

Требования

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

dnacentersdk >= 2.7.2
python >= 3.5

Параметры

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

Примечания

Примечание

Используемые методы SDK — users.Users.get_user_enrichment_details,
Используемые пути — get /dna/intent/api/v1/user-enrichment-details,
Поддерживает check_mode
Плагин выполняется на контрольном узле и не использует никаких плагинов подключения Ansible, а вместо этого использует встроенный менеджер подключений из Cisco DNAC SDK
Параметры, начинающиеся с dnac_, используются Cisco DNAC Python SDK для установления подключения

См. также

Документация Cisco DNA Center для пользователей GetUserEnrichmentDetails: Полное описание API GetUserEnrichmentDetails.

Примеры

- name: Get all User Enrichment Details
  cisco.dnac.user_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 список / элементы=словарь	Словарь или список с ответом, возвращаемым Cisco DNAC Python SDK Возвращается: всегда Пример: "[\n {\n \"userDetails\": {\n \"id\": \"string\",\n \"connectionStatus\": \"string\",\n \"hostType\": \"string\",\n \"userId\": {},\n \"hostName\": {},\n \"hostOs\": {},\n \"hostVersion\": {},\n \"subType\": \"string\",\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 \"frequency\": {},\n \"channel\": {},\n \"apGroup\": {},\n \"location\": {},\n \"clientConnection\": \"string\",\n \"connectedDevice\": [\n {}\n ],\n \"issueCount\": 0,\n \"rssi\": {},\n \"avgRssi\": {},\n \"snr\": {},\n \"avgSnr\": {},\n \"dataRate\": {},\n \"txBytes\": {},\n \"rxBytes\": {},\n \"dnsSuccess\": {},\n \"dnsFailure\": {},\n \"onboarding\": {\n \"averageRunDuration\": {},\n \"maxRunDuration\": {},\n \"averageAssocDuration\": {},\n \"maxAssocDuration\": {},\n \"averageAuthDuration\": {},\n \"maxAuthDuration\": {},\n \"averageDhcpDuration\": {},\n \"maxDhcpDuration\": {},\n \"aaaServerIp\": {},\n \"dhcpServerIp\": {}\n },\n \"onboardingTime\": {},\n \"port\": {}\n },\n \"connectedDevice\": [\n {\n \"deviceDetails\": {\n \"family\": \"string\",\n \"type\": \"string\",\n \"location\": {},\n \"errorCode\": {},\n \"macAddress\": \"string\",\n \"role\": \"string\",\n \"apManagerInterfaceIp\": \"string\",\n \"associatedWlcIp\": \"string\",\n \"bootDateTime\": \"string\",\n \"collectionStatus\": \"string\",\n \"interfaceCount\": \"string\",\n \"lineCardCount\": \"string\",\n \"lineCardId\": \"string\",\n \"managementIpAddress\": \"string\",\n \"memorySize\": \"string\",\n \"platformId\": \"string\",\n \"reachabilityFailureReason\": \"string\",\n \"reachabilityStatus\": \"string\",\n \"snmpContact\": \"string\",\n \"snmpLocation\": \"string\",\n \"tunnelUdpPort\": {},\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 \"errorCode\": 0,\n \"message\": \"string\",\n \"detail\": \"string\"\n }\n ]\n }\n }\n ]\n }\n]\n"

Ключ

Описание

dnac_response

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

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

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

Пример: "[\n {\n \"userDetails\": {\n \"id\": \"string\",\n \"connectionStatus\": \"string\",\n \"hostType\": \"string\",\n \"userId\": {},\n \"hostName\": {},\n \"hostOs\": {},\n \"hostVersion\": {},\n \"subType\": \"string\",\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 \"frequency\": {},\n \"channel\": {},\n \"apGroup\": {},\n \"location\": {},\n \"clientConnection\": \"string\",\n \"connectedDevice\": [\n {}\n ],\n \"issueCount\": 0,\n \"rssi\": {},\n \"avgRssi\": {},\n \"snr\": {},\n \"avgSnr\": {},\n \"dataRate\": {},\n \"txBytes\": {},\n \"rxBytes\": {},\n \"dnsSuccess\": {},\n \"dnsFailure\": {},\n \"onboarding\": {\n \"averageRunDuration\": {},\n \"maxRunDuration\": {},\n \"averageAssocDuration\": {},\n \"maxAssocDuration\": {},\n \"averageAuthDuration\": {},\n \"maxAuthDuration\": {},\n \"averageDhcpDuration\": {},\n \"maxDhcpDuration\": {},\n \"aaaServerIp\": {},\n \"dhcpServerIp\": {}\n },\n \"onboardingTime\": {},\n \"port\": {}\n },\n \"connectedDevice\": [\n {\n \"deviceDetails\": {\n \"family\": \"string\",\n \"type\": \"string\",\n \"location\": {},\n \"errorCode\": {},\n \"macAddress\": \"string\",\n \"role\": \"string\",\n \"apManagerInterfaceIp\": \"string\",\n \"associatedWlcIp\": \"string\",\n \"bootDateTime\": \"string\",\n \"collectionStatus\": \"string\",\n \"interfaceCount\": \"string\",\n \"lineCardCount\": \"string\",\n \"lineCardId\": \"string\",\n \"managementIpAddress\": \"string\",\n \"memorySize\": \"string\",\n \"platformId\": \"string\",\n \"reachabilityFailureReason\": \"string\",\n \"reachabilityStatus\": \"string\",\n \"snmpContact\": \"string\",\n \"snmpLocation\": \"string\",\n \"tunnelUdpPort\": {},\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 \"errorCode\": 0,\n \"message\": \"string\",\n \"detail\": \"string\"\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/user_enrichment_details_info_module.html