cisco.dnac.clients_v1_info 模块 – 客户端 V1 的信息模块
注意
此模块是 cisco.dnac 集合（版本 6.25.0）的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求了解详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.clients_v1_info。
cisco.dnac 6.15.0 中的新增功能
概要
获取所有客户端 V1。
按 ID 获取客户端 V1。
检索与 MAC 地址匹配的特定客户端信息。有关 API 使用的详细信息，请参阅 Open API 规范文档 - https //github.com/cisco-en-programmability/catalyst- center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-clients1-1.0.0-resolved.yaml。
检索客户端列表，同时提供基本过滤和排序功能。有关 API 使用的详细信息，请参阅 Open API 规范文档 - https //github.com/cisco-en-programmability/catalyst-center-api-specs/blob/main/Assurance/CE_Cat_Center_Org- clients1-1.0.0-resolved.yaml。
注意
此模块有一个对应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
属性查询参数。与资源相关的属性列表，可以请求该列表仅作为响应的一部分以及必需的属性。有关支持的属性列表，请参阅 ClientAttribute 模式。示例 `attribute=band`（请求单个属性）`attribute=band&attribute=ssid&attribute=overallScore`（请求多个属性）。 |
|
频段查询参数。客户端或接入点工作的 WiFi 频率频段。频段值以吉赫兹 (GHz) 表示。示例 `band=5GHZ`（请求单个频段）`band=2.4GHZ&band=6GHZ`（请求多个频段）。 |
|
ConnectedNetworkDeviceName 查询参数。客户端连接到的相邻网络设备的名称。此字段支持基于通配符 (`*`) 字符的搜索。如果该值包含 (`*`) 字符，请使用 /query API 进行正则表达式搜索。例如 `*ap-25*` 或 `ap-25*` 或 `*ap-25` 示例 `connectedNetworkDeviceName=ap-25`（请求单个 connectedNetworkDeviceName）`connectedNetworkDeviceName=ap-25&ap-34`（请求多个 connectedNetworkDeviceName）。 |
|
用于 Cisco DNA Center SDK 启用调试的标志。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
用于启用或禁用 SSL 证书验证的标志。 选项
|
|
通知 SDK 要使用的 Cisco DNA Center 版本。 默认值： |
|
EndTime 查询参数。API 查询与资源相关的数据集的结束时间。它必须以毫秒为单位的 UNIX 纪元时间指定。值是包含的。 |
|
其他标头。 |
|
Id 路径参数。Id 是客户端 MAC 地址。它可以以任何表示法约定指定，例如 01 23 45 67 89 AB 或 01-23-45-67-89-AB 或 0123.4567.89AB，并且不区分大小写。 |
|
Ipv4Address 查询参数。网络实体（网络设备或客户端）的 IPv4 地址。此字段支持基于通配符 (`*`) 字符的搜索。例如 `*1.1*` 或 `1.1*` 或 `*1.1` 示例 `ipv4Address=1.1.1.1`（请求单个 ipv4Address）`ipv4Address=1.1.1.1&ipv4Address=2.2.2.2`（请求多个 ipv4Address）。 |
|
Ipv6Address 查询参数。网络实体（网络设备或客户端）的 IPv6 地址。此字段支持基于通配符 (`*`) 字符的搜索。例如 `*2001 db8*` 或 `2001 db8*` 或 `*2001 db8` 示例 `ipv6Address=2001 db8 0 0 0 0 2 1`（请求单个 ipv6Address）`ipv6Address=2001 db8 0 0 0 0 2 1&ipv6Address=2001 db8 85a3 8d3 1319 8a2e 370 7348`（请求多个 ipv6Address）。 |
|
Limit 查询参数。要返回的最大记录数。 |
|
MacAddress 查询参数。网络设备或客户端的 macAddress。此字段支持基于通配符 (`*`) 字符的搜索。例如 `*AB AB AB*` 或 `AB AB AB*` 或 `*AB AB AB` 示例 `macAddress=AB AB AB CD CD CD`（请求单个 macAddress）`macAddress=AB AB AB CD CD DC&macAddress=AB AB AB CD CD FE`（请求多个 macAddress）。 |
|
Offset 查询参数。指定 API 返回的所有记录中的起始点。它是一个基于 1 的偏移量。起始值为 1。 |
|
Order 查询参数。字段的排序顺序（升序或降序）。 |
|
OsType 查询参数。客户端设备操作系统类型。此字段支持基于通配符 (`*`) 字符的搜索。如果该值包含 (`*`) 字符，请使用 /query API 进行正则表达式搜索。例如 `*iOS*` 或 `iOS*` 或 `*iOS` 示例 `osType=iOS`（请求单个 osType）`osType=iOS&osType=Android`（请求多个 osType）。 |
|
OsVersion 查询参数。客户端设备操作系统版本。此字段支持基于通配符 (`*`) 字符的搜索。如果该值包含 (`*`) 字符，请使用 /query API 进行正则表达式搜索。例如 `*14.3*` 或 `14.3*` 或 `*14.3` 示例 `osVersion=14.3`（请求单个 osVersion）`osVersion=14.3&osVersion=10.1`（请求多个 osVersion）。 |
|
SiteHierarchy 查询参数。站点树的完整分层细分，从全局站点名称开始，到特定站点名称结束。根站点名为“Global”（例如，“Global/AreaName/BuildingName/FloorName”）。此字段支持基于通配符 (`*`) 字符的搜索。如果该值包含 (`*`) 字符，请使用 /query API 进行正则表达式搜索。例如 `*BuildingName*` 或 `BuildingName*` 或 `*BuildingName` 示例 `siteHierarchy=Global/AreaName/BuildingName/FloorName`（请求单个 siteHierarchy）`siteHierarchy=Global/AreaName/BuildingName1/FloorName1&siteHierarchy=Global/AreaNa me/BuildingName1/FloorName2`（请求多个 siteHierarchy）。 |
|
SiteHierarchyId 查询参数。以 ID 形式完整展示站点树的层级结构，从全局站点 UUID 开始，到特定站点的 UUID 结束。（例如：“globalUuid/areaUuid/buildingUuid/floorUuid”）此字段支持基于通配符 (`*`) 的搜索。例如 `*buildingUuid*` 或 `buildingUuid*` 或 `*buildingUuid`。示例：`siteHierarchyId=globalUuid/areaUuid/buildingUuid/floorUuid`（请求单个 siteHierarchyId），`siteHierarchyId=globalUuid/areaUuid/buildingUuid1/floorUuid1&siteHierarchyId=glo balUuid/areaUuid/buildingUuid1/floorUuid2`（请求多个 siteHierarchyId）。 |
|
SiteId 查询参数。不包含顶层层级结构的站点 UUID。（例如：“floorUuid”）示例：`siteId=floorUuid`（请求单个 siteId），`siteId=floorUuid1&siteId=floorUuid2`（请求多个 siteId）。 |
|
SortBy 查询参数。用于排序的响应中的字段。 |
|
Ssid 查询参数。SSID 是客户端连接的无线网络的名称。它也被称为 WLAN ID - 无线局域网标识符。此字段支持基于通配符 (`*`) 的搜索。如果该值包含 (`*`) 字符，请使用 /query API 进行正则表达式搜索。例如 `*Alpha*` 或 `Alpha*` 或 `*Alpha`。示例：`ssid=Alpha`（请求单个 ssid），`ssid=Alpha&ssid=Guest`（请求多个 ssid）。 |
|
StartTime 查询参数。API 查询与资源相关的数据集的起始时间。必须以 UNIX 纪元时间（毫秒）指定。该值是包含在内的。如果未提供 `startTime`，API 将默认为当前时间。 |
|
Type 查询参数。客户端设备类型，指示客户端是通过有线还是无线媒介连接到网络的。 |
|
Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求主体。 选项
|
|
View 查询参数。与客户端相关的视图。有关支持的视图列表，请参考 ClientView 模式。示例：`view=Wireless`（请求单个视图），`view=WirelessHealth&view=WirelessTraffic`（请求多个视图）。 |
|
WlcName 查询参数。报告无线客户端的无线控制器名称。此字段支持基于通配符 (`*`) 的搜索。如果该值包含 (`*`) 字符，请使用 /query API 进行正则表达式搜索。例如 `*wlc-25*` 或 `wlc-25*` 或 `*wlc-25`。示例：`wlcName=wlc-25`（请求单个 wlcName），`wlcName=wlc-25&wlc-34`（请求多个 wlcName）。 |
注意
注意
使用的 SDK 方法是 clients.Clients.retrieves_specific_client_information_matching_the_macaddress_v1, clients.Clients.retrieves_the_list_of_clients_while_also_offering_basic_filtering_and_sorting_capabilities_v1,
使用的路径是 get /dna/data/api/v1/clients, get /dna/data/api/v1/clients/{id},
支持
check_mode该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中嵌入的连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- Cisco DNA Center 关于客户端 RetrievesSpecificClientInformationMatchingTheMACAddressV1 的文档
RetrievesSpecificClientInformationMatchingTheMACAddressV1 API 的完整参考。
- Cisco DNA Center 关于客户端 RetrievesTheListOfClientsWhileAlsoOfferingBasicFilteringAndSortingCapabilitiesV1 的文档
RetrievesTheListOfClientsWhileAlsoOfferingBasicFilteringAndSortingCapabilitiesV1 API 的完整参考。
示例
- name: Get all Clients V1
cisco.dnac.clients_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}}"
startTime: 0
endTime: 0
limit: 0
offset: 0
sortBy: string
order: string
type: string
osType: string
osVersion: string
siteHierarchy: string
siteHierarchyId: string
siteId: string
ipv4Address: string
ipv6Address: string
macAddress: string
wlcName: string
connectedNetworkDeviceName: string
ssid: string
band: string
view: string
attribute: string
register: result
- name: Get Clients V1 by id
cisco.dnac.clients_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}}"
startTime: 0
endTime: 0
view: string
attribute: string
id: string
register: result
返回值
常用返回值记录在此处，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回: 总是 示例: |