1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
|
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: task_info
short_description: Information module for Task
description:
- Get all Task.
- Get Task by id.
- Returns a task by specified id.
- Returns tasks based on filter criteria.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
startTime:
description:
- StartTime query parameter. This is the epoch start time from which tasks need to be fetched.
type: str
endTime:
description:
- EndTime query parameter. This is the epoch end time upto which audit records need to be fetched.
type: str
data:
description:
- Data query parameter. Fetch tasks that contains this data.
type: str
errorCode:
description:
- ErrorCode query parameter. Fetch tasks that have this error code.
type: str
serviceType:
description:
- ServiceType query parameter. Fetch tasks with this service type.
type: str
username:
description:
- Username query parameter. Fetch tasks with this username.
type: str
progress:
description:
- Progress query parameter. Fetch tasks that contains this progress.
type: str
isError:
description:
- IsError query parameter. Fetch tasks ended as success or failure. Valid values true, false.
type: str
failureReason:
description:
- FailureReason query parameter. Fetch tasks that contains this failure reason.
type: str
parentId:
description:
- ParentId query parameter. Fetch tasks that have this parent Id.
type: str
offset:
description:
- Offset query parameter.
type: int
limit:
description:
- Limit query parameter.
type: int
sortBy:
description:
- SortBy query parameter. Sort results by this field.
type: str
order:
description:
- Order query parameter. Sort order - asc or dsc.
type: str
taskId:
description:
- TaskId path parameter. UUID of the Task.
type: str
requirements:
- dnacentersdk >= 2.7.1
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Task GetTaskById
description: Complete reference of the GetTaskById API.
link: https://developer.cisco.com/docs/dna-center/#!get-task-by-id
- name: Cisco DNA Center documentation for Task GetTasks
description: Complete reference of the GetTasks API.
link: https://developer.cisco.com/docs/dna-center/#!get-tasks
notes:
- SDK Method used are
task.Task.get_task_by_id,
task.Task.get_tasks,
- Paths used are
get /dna/intent/api/v1/task,
get /dna/intent/api/v1/task/{taskId},
"""
EXAMPLES = r"""
- name: Get all Task
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 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
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"response": {
"additionalStatusURL": "string",
"data": "string",
"endTime": 0,
"errorCode": "string",
"errorKey": "string",
"failureReason": "string",
"id": "string",
"instanceTenantId": "string",
"isError": true,
"lastUpdate": 0,
"operationIdList": {},
"parentId": "string",
"progress": "string",
"rootId": "string",
"serviceType": "string",
"startTime": 0,
"username": "string",
"version": 0
},
"version": "string"
}
"""
|
