cisco.dnac.task_info 模块 – 任务信息信息模块

注意

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

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

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

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

cisco.dnac 3.1.0 中的新增功能

概要

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

注意

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

要求

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

• dnacentersdk >= 2.4.9

• python >= 3.5

参数

参数	注释
data 字符串	数据查询参数。获取包含此数据的任务。
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 查询参数。这是需要获取审计记录的纪元结束时间。
errorCode 字符串	ErrorCode 查询参数。获取具有此错误代码的任务。
failureReason 字符串	FailureReason 查询参数。获取包含此失败原因的任务。
headers 字典	其他标头。
isError 字符串	IsError 查询参数。获取以成功或失败结束的任务。有效值为 true、false。
limit 整数	Limit 查询参数。
offset 整数	Offset 查询参数。
order 字符串	Order 查询参数。排序顺序 - asc 或 dsc。
parentId 字符串	ParentId 查询参数。获取具有此父 ID 的任务。
progress 字符串	Progress 查询参数。获取包含此进度的任务。
serviceType 字符串	ServiceType 查询参数。获取具有此服务类型的任务。
sortBy 字符串	SortBy 查询参数。按此字段对结果进行排序。
startTime 字符串	StartTime 查询参数。这是需要获取任务的纪元开始时间。
taskId 字符串	TaskId 路径参数。任务的 UUID。
username 字符串	Username 查询参数。获取具有此用户名的任务。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 启用针对 JSON 模式验证请求正文的标志。 选择 false true ← (默认)

备注

注意

• 使用的 SDK 方法为 task.Task.get_task_by_id_v1、task.Task.get_tasks_operational_tasks_v1,

• 使用的路径为 get /dna/intent/api/v1/task、get /dna/intent/api/v1/task/{taskId},

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

• 支持 check_mode

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

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

另请参阅

另请参阅

有关 Task GetTaskByIdV1 的 Cisco DNA Center 文档

GetTaskByIdV1 API 的完整参考。

有关 Task GetTasksOperationalTasksV1 的 Cisco DNA Center 文档

GetTasksOperationalTasksV1 API 的完整参考。

示例

- name: Get all Task Info
  cisco.dnac.task_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
    offset: 0
    limit: 0
    sortBy: string
    order: string
  register: result

- name: Get Task Info by id
  cisco.dnac.task_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}}"
    taskId: string
  register: result

返回值

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

键

描述

dnac_response 字典

一个字典或列表，其中包含 Cisco DNAC Python SDK 返回的响应 返回值：始终 示例: {"response": {"additionalStatusURL": "string", "data": "string", "endTime": 0, "errorCode": "string", "errorKey": "string", "failureReason": "string", "id": "string", "instanceTenantId": "string", "isError": true, "lastUpdate": 0, "operationIdList": ["string"], "parentId": "string", "progress": "string", "rootId": "string", "serviceType": "string", "startTime": 0, "username": "string", "version": 0}, "version": "string"}

作者

• Rafael Campos (@racampos)

集合链接

• 问题跟踪器
• 仓库 (源代码)