cisco.dnac.client_detail_info 模块 – 用于客户端详细信息的 Information 模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要满足其他要求才能使用此模块，请参阅 要求 以了解详细信息。

要在 playbook 中使用它，请指定：cisco.dnac.client_detail_info。

cisco.dnac 3.1.0 中的新功能

概要

• 此模块表示模块 client_detail_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 字典	其他标头。
macAddress 字符串	MacAddress 查询参数。客户端的 MAC 地址。
timestamp 浮点数	Timestamp 查询参数。需要客户端运行状况数据时的 Epoch 时间（以毫秒为单位）。
validate_response_schema 布尔值	Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求正文。 选项 false true ← （默认）

注意

注意

• 使用的 SDK 方法为 clients.Clients.get_client_detail_v1，

• 使用的路径为 get /dna/intent/api/v1/client-detail，

• 应该注意的是，此模块是 client_detail_v1_info 的别名

• 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 文档，用于 Clients GetClientDetailV1

GetClientDetailV1 API 的完整参考。

示例

- name: Get all Client Detail Info
  cisco.dnac.client_detail_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}}"
    macAddress: string
    timestamp: 0
  register: result

返回值

常见返回值在此处记录 这里，以下是此模块特有的字段

键

描述

dnac_response 字典

一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应 返回值： 始终 示例: {"connectionInfo": {"band": "字符串", "channel": "字符串", "channelWidth": "字符串", "hostType": "字符串", "nwDeviceMac": "字符串", "nwDeviceName": "字符串", "protocol": "字符串", "spatialStream": "字符串", "timestamp": 0, "uapsd": "字符串", "wmm": "字符串"}, "detail": {"aaaServerEAPLatency": 0, "aaaServerFailedTransaction": 0, "aaaServerIp": "字符串", "aaaServerLatency": 0, "aaaServerMABLatency": 0, "aaaServerSuccessTransaction": 0, "aaaServerTransaction": 0, "apGroup": "字符串", "authType": "字符串", "avgRssi": "字符串", "avgSnr": "字符串", "bridgeVMMode": "字符串", "channel": "字符串", "clientConnection": "字符串", "clientType": "字符串", "connectedDevice": [{"band": "字符串", "id": "字符串", "ip address": "字符串", "mac": "字符串", "mgmtIp": "字符串", "mode": "字符串", "name": "字符串", "type": "字符串"}], "connectedUpn": "字符串", "connectedUpnId": "字符串", "connectedUpnOwner": "字符串", "connectionStatus": "字符串", "countryCode": "字符串", "dataRate": "字符串", "deviceForm": "字符串", "deviceVendor": "字符串", "dhcpDeclineIp": "字符串", "dhcpNakIp": "字符串", "dhcpServerDOLatency": 0, "dhcpServerFailedTransaction": 0, "dhcpServerIp": "字符串", "dhcpServerLatency": 0, "dhcpServerRALatency": 0, "dhcpServerSuccessTransaction": 0, "dhcpServerTransaction": 0, "dnsRequest": "字符串", "dnsResponse": "字符串", "dot11Protocol": "字符串", "dot11ProtocolCapability": "字符串", "duid": "字符串", "firmwareVersion": "字符串", "frequency": "字符串", "healthScore": [{"healthType": "字符串", "reason": "字符串", "score": 0}], "hostIpV4": "字符串", "hostIpV6": ["字符串"], "hostMac": "字符串", "hostName": "字符串", "hostOs": "字符串", "hostType": "字符串", "hostVersion": "字符串", "hwModel": "字符串", "id": "字符串", "identifier": "字符串", "intelCapable": true, "iosCapable": true, "isGuestUPNEndpoint": true, "issueCount": 0, "l2VirtualNetwork": "字符串", "l3VirtualNetwork": "字符串", "lastUpdated": 0, "latencyBe": 0, "latencyBg": 0, "latencyVideo": 0, "latencyVoice": 0, "linkSpeed": 0, "linkThreshold": "字符串", "location": "字符串", "maxRoamingDuration": "字符串", "modelName": "字符串", "onboarding": {"aaaRootcauseList": ["字符串"], "aaaServerIp": "字符串", "assocDoneTime": 0, "assocRootcauseList": ["字符串"], "authDoneTime": 0, "averageAssocDuration": "字符串", "averageAuthDuration": "字符串", "averageDhcpDuration": "字符串", "averageRunDuration": "字符串", "dhcpDoneTime": 0, "dhcpRootcauseList": ["字符串"], "dhcpServerIp": "字符串", "latestRootCauseList": ["字符串"], "maxAssocDuration": "字符串", "maxAuthDuration": "字符串", "maxDhcpDuration": "字符串", "maxRunDuration": "字符串", "otherRootcauseList": ["字符串"]}, "onboardingTime": 0, "port": "字符串", "portDescription": "字符串", "powerType": "字符串", "privateMac": true, "remoteEndDuplexMode": "字符串", "rssi": "字符串", "rssiIsInclude": "字符串", "rssiThreshold": "字符串", "rxBytes": "字符串", "rxLinkError": 0, "rxRate": 0, "rxRetryPct": "字符串", "salesCode": "字符串", "sessionDuration": "字符串", "sgt": "字符串", "slotId": 0, "snr": "字符串", "snrIsInclude": "字符串", "snrThreshold": "字符串", "ssid": "字符串", "subType": "字符串", "tracked": "字符串", "trustDetails": "字符串", "trustScore": "字符串", "txBytes": "字符串", "txLinkError": 0, "txRate": 0, "upnId": "字符串", "upnName": "字符串", "upnOwner": "字符串", "usage": 0, "userId": "字符串", "versionTime": 0, "vlanId": 0, "vnid": 0, "wlcName": "字符串", "wlcUuid": "字符串"}, "topology": {"links": [{"apRadioAdminStatus": "字符串", "apRadioOperStatus": "字符串", "id": "字符串", "interfaceDetails": [{"adminStatus": "字符串", "clientMacAddress": "字符串", "connectedDeviceIntName": "字符串", "duplex": "字符串", "portMode": "字符串"}], "label": ["字符串"], "linkStatus": "字符串", "portUtilization": 0, "source": "字符串", "sourceAdminStatus": "字符串", "sourceDuplexInfo": "字符串", "sourceInterfaceName": "字符串", "sourceLinkStatus": "字符串", "sourcePortMode": "字符串", "sourcePortVLANInfo": "字符串", "target": "字符串", "targetAdminStatus": "字符串", "targetDuplexInfo": "字符串", "targetInterfaceName": "字符串", "targetLinkStatus": "字符串", "targetPortMode": "字符串", "targetPortVLANInfo": "字符串"}], "nodes": [{"clients": 0, "connectedDevice": "字符串", "count": 0, "description": "字符串", "deviceType": "字符串", "fabricGroup": "字符串", "fabricRole": ["字符串"], "family": "字符串", "healthScore": 0, "id": "字符串", "ip": "字符串", "ipv6": ["字符串"], "level": 0, "name": "字符串", "nodeType": "字符串", "platformId": "字符串", "radioFrequency": "字符串", "role": "字符串", "softwareVersion": "字符串", "stackType": "字符串", "userId": "字符串"}]}}

作者

• Rafael Campos (@racampos)

集合链接

• 问题跟踪器
• 仓库（源代码）