cisco.dnac.tasks_count_info 模块 – 任务计数信息信息模块

注意

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

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

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

要在剧本中使用它,请指定:cisco.dnac.tasks_count_info

cisco.dnac 6.15.0 中的新增功能

概要

  • 此模块表示模块 tasks_count_v1_info 的别名

注意

此模块具有相应的 action 插件

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

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

整数

EndTime 查询参数。这是需要获取任务记录的纪元毫秒结束时间。

headers

字典

附加标头。

parentId

字符串

ParentId 查询参数。获取具有此父 ID 的任务。

rootId

字符串

RootId 查询参数。获取具有此根 ID 的任务。

startTime

整数

StartTime 查询参数。这是需要从中获取任务的纪元毫秒开始时间。

status

字符串

Status 查询参数。获取具有此状态的任务。可用值 PENDING、FAILURE、SUCCESS。

validate_response_schema

布尔值

用于 Cisco DNA Center SDK 的标志,用于根据 JSON 模式启用请求正文的验证。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法为 task.Task.get_tasks_count_v1,

  • 使用的路径为 get /dna/intent/api/v1/tasks/count,

  • 需要注意的是,此模块是 tasks_count_v1_info 的别名

  • 支持 check_mode

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

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

另请参阅

另请参阅

Cisco DNA Center 关于 Task GetTasksCountV1 的文档

GetTasksCountV1 API 的完整参考。

示例

- name: Get all Tasks Count Info
  cisco.dnac.tasks_count_info:
    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}}"
    headers: "{{my_headers | from_json}}"
    startTime: 0
    endTime: 0
    parentId: string
    rootId: string
    status: string
  register: result

返回值

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

描述

dnac_response

字典

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

返回:始终

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

作者

  • Rafael Campos (@racampos)