cisco.dnac.task_v1_info 模块 – 任务 V1 信息模块
注意
此模块是 cisco.dnac 集合 (版本 6.25.0) 的一部分。
如果您使用的是 ansible 包，则可能已经安装了此集合。它不包含在 ansible-core 中。要检查它是否已安装，请运行 ansible-galaxy collection list。
要安装它，请使用：ansible-galaxy collection install cisco.dnac。您需要其他要求才能使用此模块，请参阅 要求 以了解详细信息。
要在 playbook 中使用它，请指定：cisco.dnac.task_v1_info。
cisco.dnac 3.1.0 中的新增功能
概要
获取所有任务 V1。
按 ID 获取任务 V1。
返回指定 ID 的任务。
根据筛选条件返回任务。
注意
此模块具有相应的 操作插件。
要求
执行此模块的主机需要以下要求。
dnacentersdk >= 2.4.9
python >= 3.5
参数
参数 |
注释 |
|---|---|
数据查询参数。获取包含此数据的任务。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用调试。 选项
|
|
Cisco DNA Center 主机名。 |
|
用于身份验证的 Cisco DNA Center 密码。 |
|
Cisco DNA Center 端口。 默认值： |
|
用于身份验证的 Cisco DNA Center 用户名。 默认值： |
|
启用或禁用 SSL 证书验证的标志。 选项
|
|
告知 SDK 使用哪个版本的 Cisco DNA Center。 默认值： |
|
EndTime 查询参数。这是需要获取审核记录的纪元结束时间。 |
|
ErrorCode 查询参数。获取具有此错误代码的任务。 |
|
FailureReason 查询参数。获取包含此失败原因的任务。 |
|
附加标头。 |
|
IsError 查询参数。获取成功或失败的任务。有效值 true、false。 |
|
Limit 查询参数。 |
|
Offset 查询参数。 |
|
Order 查询参数。排序顺序 - asc 或 dsc。 |
|
ParentId 查询参数。获取具有此父 ID 的任务。 |
|
Progress 查询参数。获取包含此进度的任务。 |
|
ServiceType 查询参数。获取具有此服务类型的任务。 |
|
SortBy 查询参数。按此字段排序结果。 |
|
StartTime 查询参数。这是需要从中获取任务的纪元开始时间。 |
|
TaskId 路径参数。任务的 UUID。 |
|
Username 查询参数。获取具有此用户名 的任务。 |
|
用于 Cisco DNA Center SDK 的标志，用于启用根据 JSON 模式验证请求正文。 选项
|
备注
注意
使用的 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}，
支持
check_mode插件在控制节点上运行，不使用任何 Ansible 连接插件，而是使用 Cisco DNAC SDK 中的嵌入式连接管理器
以 dnac_ 开头的参数由 Cisco DNAC Python SDK 用于建立连接
另请参阅
另请参阅
- 有关任务 GetTaskByIdV1 的 Cisco DNA Center 文档
GetTaskByIdV1 API 的完整参考。
- 有关任务 GetTasksOperationalTasksV1 的 Cisco DNA Center 文档
GetTasksOperationalTasksV1 API 的完整参考。
示例
- name: Get all Task V1
cisco.dnac.task_v1_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 V1 by id
cisco.dnac.task_v1_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
返回值
常用的返回值已在 此处 记录，以下是此模块特有的字段
键 |
描述 |
|---|---|
包含 Cisco DNAC Python SDK 返回的响应的字典或列表 返回： 始终 示例： |