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

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

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

要求

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

  • dnacentersdk >= 2.4.9

  • python >= 3.5

参数

参数

注释

data

string

数据查询参数。获取包含此数据的任务。

dnac_debug

boolean

Cisco DNA Center SDK 的标志，用于启用调试。

选项

  • false ← (默认)

  • true

dnac_host

string / 必需

Cisco DNA Center 主机名。

dnac_password

string

用于身份验证的 Cisco DNA Center 密码。

dnac_port

integer

Cisco DNA Center 端口。

默认值： 443

dnac_username

别名：user

string

用于身份验证的 Cisco DNA Center 用户名。

默认值： "admin"

dnac_verify

boolean

用于启用或禁用 SSL 证书验证的标志。

选项

  • false

  • true ← (默认)

dnac_version

string

通知 SDK 要使用的 Cisco DNA Center 版本。

默认值： "2.3.7.6"

endTime

string

EndTime 查询参数。这是需要获取审计记录的纪元结束时间。

errorCode

string

ErrorCode 查询参数。获取具有此错误代码的任务。

failureReason

string

FailureReason 查询参数。获取包含此失败原因的任务。

headers

dictionary

附加标头。

isError

string

IsError 查询参数。获取以成功或失败结束的任务。有效值为 true、false。

parentId

string

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

progress

string

Progress 查询参数。获取包含此进度的任务。

serviceType

string

ServiceType 查询参数。获取具有此服务类型的任务。

startTime

string

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

username

string

Username 查询参数。获取具有此用户名的任务。

validate_response_schema

boolean

Cisco DNA Center SDK 的标志，用于启用针对 JSON 模式验证请求正文。

选项

  • false

  • true ← (默认)

注释

注意

  • 使用的 SDK 方法是 task.Task.get_task_count_v1,

  • 使用的路径是 get /dna/intent/api/v1/task/count,

  • 应该注意的是，此模块是 task_count_v1_info 的别名

  • 支持 check_mode

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

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

另请参阅

另请参阅

有关任务 GetTaskCountV1 的 Cisco DNA Center 文档

GetTaskCountV1 API 的完整参考。

示例

- name: Get all Task Count Info
  cisco.dnac.task_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: string
    endTime: string
    data: string
    errorCode: string
    serviceType: string
    username: string
    progress: string
    isError: string
    failureReason: string
    parentId: string
  register: result

返回值

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

键

描述

dnac_response

dictionary

带有 Cisco DNAC Python SDK 返回的响应的字典或列表

返回：始终

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

作者

  • Rafael Campos (@racampos)