cisco.dnac.clients_summary_analytics_v1 模块 – 用于客户端摘要分析 V1 的资源模块

注意

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

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

要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要进一步的要求才能使用此模块，请参阅要求了解详细信息。

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

cisco.dnac 6.15.0 中的新增功能

概要 

管理资源客户端摘要分析 V1 的创建操作。
检索与客户端相关的摘要分析数据，同时应用复杂的过滤、聚合函数和分组。此 API 有助于获取有关客户端性能和状态的综合见解。有关 API 使用的详细信息，请参阅开放 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

参数 

参数	注释
aggregateAttributes 列表 / 元素=字典	客户端摘要分析的 aggregateAttributes。
function 字符串	函数。
name 字符串	名称。
attributes 列表 / 元素=字符串	属性。
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"`
endTime 整数	结束时间。
filters 列表 / 元素=字典	客户端摘要分析的过滤器。
key 字符串	键。
operator 字符串	运算符。
value 整数	值。
groupBy 列表 / 元素=字符串	分组依据。
headers 字典	其他标头。
page 字典	客户端摘要分析的页面。
cursor 字符串	光标。
limit 整数	限制。
sortBy 列表 / 元素=字典	客户端摘要分析的排序依据。
name 字符串	名称。
order 字符串	顺序。
startTime 整数	开始时间。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，以启用针对 JSON 架构验证请求正文。选择 `false` `true` ← (默认)

注释 

注意

使用的 SDK 方法是 clients.Clients.retrieves_summary_analytics_data_related_to_clients_v1，
使用的路径是 post /dna/data/api/v1/clients/summaryAnalytics，
不支持 check_mode
该插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

有关客户端 RetrievesSummaryAnalyticsDataRelatedToClientsV1 的 Cisco DNA Center 文档: RetrievesSummaryAnalyticsDataRelatedToClientsV1 API 的完整参考。

示例 

- name: Create
  cisco.dnac.clients_summary_analytics_v1:
    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}}"
    aggregateAttributes:
    - function: string
      name: string
    attributes:
    - string
    endTime: 0
    filters:
    - key: string
      operator: string
      value: 0
    groupBy:
    - string
    headers: '{{my_headers | from_json}}'
    page:
      cursor: string
      limit: 0
      sortBy:
      - name: string
        order: string
    startTime: 0

返回值 

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

键	描述
dnac_response 字典	由 Cisco DNAC Python SDK 返回的字典或列表响应返回: 总是示例: `{"page": {"count": 0, "cursor": "string", "limit": 0, "sortBy": [{"name": "string", "order": "string"}]}, "response": {"groups": [{"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": 0}], "id": "string"}]}, "version": "string"}`

作者

Rafael Campos (@racampos)