cisco.dnac.tasks_info 模块 – 任务信息信息模块

注意

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

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

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

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

cisco.dnac 6.15.0 中的新增功能

概要 

此模块表示模块 tasks_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 字典	附加标头。
id 字符串	Id 路径参数。要检索的任务的 `id`。
limit 整数	Limit 查询参数。此页要显示的记录数。
offset 整数	Offset 查询参数。此页要显示的第一条记录；第一条记录编号为 1。
order 字符串	Order 查询参数。应使用升序还是降序对响应进行排序。
parentId 字符串	ParentId 查询参数。获取具有此父 ID 的任务。
rootId 字符串	RootId 查询参数。获取具有此根 ID 的任务。
sortBy 字符串	SortBy 查询参数。响应中要排序的属性。
startTime 整数	StartTime 查询参数。这是需要从其提取任务的纪元毫秒开始时间。
status 字符串	Status 查询参数。获取具有此状态的任务。可用值 PENDING、FAILURE、SUCCESS。
validate_response_schema 布尔值	用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。选项 `false` `true` ← (默认)

备注 

注意

使用的 SDK 方法为 task.Task.get_tasks_by_id_v1、task.Task.get_tasks_v1，
使用的路径为 get /dna/intent/api/v1/tasks、get /dna/intent/api/v1/tasks/{id}，
需要注意的是，此模块是 tasks_v1_info 的别名
支持 check_mode
插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接

另请参阅 

另请参阅

Cisco DNA Center 关于 Task GetTasksByIDV1 的文档: GetTasksByIDV1 API 的完整参考。
Cisco DNA Center 关于 Task GetTasksV1 的文档: GetTasksV1 API 的完整参考。

示例 

- name: Get all Tasks Info
  cisco.dnac.tasks_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}}"
    offset: 0
    limit: 0
    sortBy: string
    order: string
    startTime: 0
    endTime: 0
    parentId: string
    rootId: string
    status: string
  register: result

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

返回值 

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

键	描述
dnac_response 字典	Cisco DNAC Python SDK返回的响应的字典或列表返回值：始终示例： `{"response": {"endTime": 0, "id": "string", "parentId": "string", "resultLocation": "string", "rootId": "string", "startTime": 0, "status": "string", "updatedTime": 0}, "version": "string"}`

作者

Rafael Campos (@racampos)