cisco.dnac.user_enrichment_details_v1_info 模块 – 用户增强详细信息 V1 信息模块

注意

此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。

如果您使用的是 ansible 包,则可能已安装此集合。它不包含在 ansible-core 中。要检查它是否已安装,请运行 ansible-galaxy collection list

要安装它,请使用: ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块,有关详细信息,请参见 要求

要在 playbook 中使用它,请指定: cisco.dnac.user_enrichment_details_v1_info

cisco.dnac 3.1.0 中的新增功能

概要

  • 获取所有用户增强详细信息 V1。

  • 使用网络用户 ID 或最终用户的设备 MAC 地址来丰富给定的网络最终用户上下文,其中包含有关用户以及用户连接到的设备的详细信息。

注意

此模块具有相应的 action 插件

要求

执行此模块的主机需要以下要求。

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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"

headers

字典

附加标头。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于启用根据 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 users.Users.get_user_enrichment_details_v1,

  • 使用的路径是 get /dna/intent/api/v1/user-enrichment-details,

  • 支持 check_mode

  • 插件在控制节点上运行,不使用任何 Ansible 连接插件,而是使用 Cisco DNAC SDK 中的嵌入式连接管理器

  • 以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅

另请参阅

Cisco DNA Center 文档,了解 Users GetUserEnrichmentDetailsV1

GetUserEnrichmentDetailsV1 API 的完整参考。

示例

- name: Get all User Enrichment Details V1
  cisco.dnac.user_enrichment_details_v1_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\": \"字符串\",\n      \"connectionStatus\": \"字符串\",\n      \"hostType\": \"字符串\",\n      \"userId\": {},\n      \"hostName\": {},\n      \"hostOs\": {},\n      \"hostVersion\": {},\n      \"subType\": \"字符串\",\n      \"lastUpdated\": 0,\n      \"healthScore\": [\n        {\n          \"healthType\": \"字符串\",\n          \"reason\": \"字符串\",\n          \"score\": 0\n        }\n      ],\n      \"hostMac\": \"字符串\",\n      \"hostIpV4\": \"字符串\",\n      \"hostIpV6\": [\n        {}\n      ],\n      \"authType\": {},\n      \"vlanId\": \"字符串\",\n      \"ssid\": {},\n      \"frequency\": {},\n      \"channel\": {},\n      \"apGroup\": {},\n      \"location\": {},\n      \"clientConnection\": \"字符串\",\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\": \"字符串\",\n          \"type\": \"字符串\",\n          \"location\": {},\n          \"errorCode\": {},\n          \"macAddress\": \"字符串\",\n          \"role\": \"字符串\",\n          \"apManagerInterfaceIp\": \"字符串\",\n          \"associatedWlcIp\": \"字符串\",\n          \"bootDateTime\": \"字符串\",\n          \"collectionStatus\": \"字符串\",\n          \"interfaceCount\": \"字符串\",\n          \"lineCardCount\": \"字符串\",\n          \"lineCardId\": \"字符串\",\n          \"managementIpAddress\": \"字符串\",\n          \"memorySize\": \"字符串\",\n          \"platformId\": \"字符串\",\n          \"reachabilityFailureReason\": \"字符串\",\n          \"reachabilityStatus\": \"字符串\",\n          \"snmpContact\": \"字符串\",\n          \"snmpLocation\": \"字符串\",\n          \"tunnelUdpPort\": {},\n          \"waasDeviceMode\": {},\n          \"series\": \"字符串\",\n          \"inventoryStatusDetail\": \"字符串\",\n          \"collectionInterval\": \"字符串\",\n          \"serialNumber\": \"字符串\",\n          \"softwareVersion\": \"字符串\",\n          \"roleSource\": \"字符串\",\n          \"hostname\": \"字符串\",\n          \"upTime\": \"字符串\",\n          \"lastUpdateTime\": 0,\n          \"errorDescription\": {},\n          \"locationName\": {},\n          \"tagCount\": \"字符串\",\n          \"lastUpdated\": \"字符串\",\n          \"instanceUuid\": \"字符串\",\n          \"id\": \"字符串\",\n          \"neighborTopology\": [\n            {\n              \"errorCode\": 0,\n              \"message\": \"字符串\",\n              \"detail\": \"字符串\"\n            }\n          ]\n        }\n      }\n    ]\n  }\n]\n"

作者

  • Rafael Campos (@racampos)