cisco.dnac.interfaces_query_count 模块 – 用于接口查询计数的资源模块

注意

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

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

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

要在 playbook 中使用它,请指定:cisco.dnac.interfaces_query_count

cisco.dnac 6.15.0 中的新功能

概要

  • 此模块表示模块 interfaces_query_count_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

列表 / 元素=字典

接口查询计数的过滤器。

filters

列表 / 元素=字符串

过滤器。

key

字符串

键。

logicalOperator

字符串

逻辑运算符。

operator

字符串

运算符。

value

字典

值。

page

字典

接口查询计数的页面。

limit

整数

限制。

offset

整数

偏移量。

sortBy

列表 / 元素=字典

接口查询计数的 sortBy。

name

字符串

名称。

order

字符串

顺序。

startTime

整数

开始时间。

validate_response_schema

布尔值

Cisco DNA Center SDK 的标志,用于启用针对 JSON 模式的请求主体验证。

选项

  • false

  • true ← (默认)

views

列表 / 元素=字符串

视图。

注意

注意

  • 使用的 SDK 方法是 devices.Devices.the_total_interfaces_count_across_the_network_devices_v1,

  • 使用的路径是 post /dna/data/api/v1/interfaces/query/count,

  • 应该注意的是,此模块是 interfaces_query_count_v1 的别名

  • 不支持 check_mode

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

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

另请参阅

另请参阅

有关设备 TheTotalInterfacesCountAcrossTheNetworkDevicesV1 的 Cisco DNA Center 文档

TheTotalInterfacesCountAcrossTheNetworkDevicesV1 API 的完整参考。

示例

- name: Create
  cisco.dnac.interfaces_query_count:
    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:
    - filters:
      - string
      key: string
      logicalOperator: string
      operator: string
      value: {}
    page:
      limit: 0
      offset: 0
      sortBy:
      - name: string
        order: string
    startTime: 0
    views:
    - string

返回值

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

描述

dnac_response

字典

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

返回值: 总是

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

作者

  • Rafael Campos (@racampos)