cisco.dnac.client_detail_v1_info 模块 – 客户端详细信息 V1 信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

• 获取所有客户端详细信息 V1。

• 返回在任何给定时间点通过 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 字典	附加头。
macAddress 字符串	MacAddress 查询参数。客户端的 MAC 地址。
timestamp 浮点数	Timestamp 查询参数。需要客户端健康数据时的纪元时间（以毫秒为单位）。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项 false true ← (默认)

备注

注意

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

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

• 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 的客户端 GetClientDetailV1 文档

完整的 GetClientDetailV1 API 参考。

示例

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

返回值

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

键

描述

dnac_response 字典

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

作者

• Rafael Campos (@racampos)

资源链接

• 问题追踪器
• 代码仓库