cisco.dnac.assurance_events_query_count_v1 模块 – Assurance 事件查询计数 V1 资源模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

摘要

  • 管理资源 Assurance 事件查询计数 V1 的创建操作。

  • 用于获取给定复杂查询的保证事件计数的 API。请参考“API 支持文档”部分以了解支持哪些字段。有关 API 用法的详细信息，请参考 OpenAPI 规范文档 - https //github.com/cisco-en-programmability/catalyst- center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-AssuranceEvents-1.0.0-resolved.yaml。

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

deviceFamily

列表 / 元素=字符串

设备系列。

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

列表 / 元素=字典

Assurance 事件查询计数的过滤器。

key

字符串

键。

operator

字符串

操作符。

value

字符串

值。

headers

字典

附加头。

startTime

整数

开始时间。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 以启用根据 JSON 架构验证请求体的标志。

选项

  • false

  • true ← (默认)

备注

注意

  • 使用的 SDK 方法是 devices.Devices.count_the_number_of_events_with_filters_v1，

  • 使用的路径是 post /dna/data/api/v1/assuranceEvents/query/count，

  • 不支持 check_mode

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

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

另请参见

另请参见

Cisco DNA Center 设备 CountTheNumberOfEventsWithFiltersV1 文档

CountTheNumberOfEventsWithFiltersV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.assurance_events_query_count_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}}"
    deviceFamily:
    - string
    endTime: 0
    filters:
    - key: string
      operator: string
      value: string
    headers: '{{my_headers | from_json}}'
    startTime: 0

返回值

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

键

描述

dnac_response

字典

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

返回：始终

示例： {"response": {"count": 0}, "version": "string"}

作者

  • Rafael Campos (@racampos)