cisco.dnac.network_devices_summary_analytics 模块 – 网络设备摘要分析的资源模块

注意

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

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

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

要在 Playbook 中使用它，请指定：cisco.dnac.network_devices_summary_analytics。

cisco.dnac 6.15.0 中的新增功能

概要 

此模块表示模块 network_devices_summary_analytics_v1 的别名

注意

此模块具有相应的操作插件。

要求 

执行此模块的主机需要满足以下要求。

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 列表 / 元素=字符串	分组依据。
page 字典	网络设备摘要分析的页面。
limit 整数	限制。
offset 整数	偏移量。
sortBy 列表 / 元素=字典	网络设备摘要分析的排序方式。
name 字符串	名称。
order 字符串	顺序。
startTime 整数	开始时间。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 以启用针对 JSON 模式验证请求体的标志。选项 `false` `true` ←（默认）

备注 

注意

使用的 SDK 方法是 devices.Devices.gets_the_summary_analytics_data_related_to_network_devices_v1，
使用的路径是 post /dna/data/api/v1/networkDevices/summaryAnalytics，
应该注意的是，此模块是 network_devices_summary_analytics_v1 的别名
不支持 check_mode
该插件在控制节点上运行，不使用任何 ansible 连接插件，而是使用来自 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

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

示例 

- name: Create
  cisco.dnac.network_devices_summary_analytics:
    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: string
    groupBy:
    - string
    page:
      limit: 0
      offset: 0
      sortBy:
      - name: string
        order: string
    startTime: 0

返回值 

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

键

描述

dnac_response

字典

一个字典或列表，包含 Cisco DNAC Python SDK 返回的响应

返回： 总是

示例： {"page": [{"count": 0, "limit": 0, "offset": 0, "sortBy": [{"name": "string", "order": "string"}]}], "response": {"aggregateAttributes": [{}], "attributes": [{}], "groups": [{"aggregateAttributes": [{"function": "string", "name": "string", "value": 0}], "attributes": [{"name": "string", "value": "string"}], "id": "string"}]}}

作者

Rafael Campos (@racampos)