cisco.dnac.clients_trend_analytics_id_v1 模块 – 客户趋势分析 ID V1 资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要 

管理资源“客户趋势分析 ID V1”的创建操作。
通过应用复杂的过滤器、聚合函数和分组来检索特定客户端的时间序列信息。数据将根据指定趋势时间间隔进行分组。有关 API 用法的详细信息，请参考 OpenAPI 规范文档 - 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 列表 / 元素=字典	客户趋势分析 ID 的 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 列表 / 元素=字典	客户趋势分析 ID 的过滤器。
key 字符串	键。
operator 字符串	操作符。
value 整数	值。
groupBy 列表 / 元素=字符串	分组依据。
headers 字典	附加的头部。
id 字符串	ID 路径参数。ID 是客户端 MAC 地址。它可以用以下几种表示法之一指定：01 23 45 67 89 AB 或 01-23-45-67-89-AB 或 0123.4567.89AB，且不区分大小写。
page 字典	客户趋势分析 ID 的页码。
cursor 字符串	游标。
limit 整数	限制。
timeSortOrder 字符串	时间排序。
startTime 整数	开始时间。
trendInterval 字符串	趋势间隔。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)

备注 

注意

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

另请参见 

另请参见

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

示例 

- name: Create
  cisco.dnac.clients_trend_analytics_id_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}}'
    id: string
    page:
      cursor: string
      limit: 0
      timeSortOrder: string
    startTime: 0
    trendInterval: string

返回值 

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

键	描述
dnac_response 字典	Cisco DNAC Python SDK返回的响应字典或列表返回值：始终返回示例： `{"page": {"count": 0, "cursor": "string", "limit": 0, "timeSortOrder": "string"}, "response": [{"groups": [{"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": 0}], "id": "string"}], "timestamp": 0}], "version": "string"}`

作者

Rafael Campos (@racampos)