cisco.dnac.client_enrichment_details_info 模块 – 客户端丰富详细信息信息模块

注意

此模块是 cisco.dnac 集合 (版本 6.25.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 中的新增功能

概要 

此模块代表模块 client_enrichment_details_v1_info 的别名。

注意

此模块具有相应的 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 方法是 clients.Clients.get_client_enrichment_details_v1，
使用的路径是 get /dna/intent/api/v1/client-enrichment-details，
需要注意的是，此模块是 client_enrichment_details_v1_info 的别名。
支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器。
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接。

另请参阅 

另请参阅

Cisco DNA Center 文档，了解 Clients GetClientEnrichmentDetailsV1。: 完整的 GetClientEnrichmentDetailsV1 API 参考。

示例 

- name: Get all Client Enrichment Details Info
  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

列表 / 元素=字典

包含 Cisco DNAC Python SDK 返回的响应的字典或列表。

返回： 始终

Sample: "[\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)