cisco.dnac.task_info module – Information module for Task
Note
This module is part of the cisco.dnac collection (version 6.18.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install cisco.dnac
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.task_info
.
New in cisco.dnac 3.1.0
Synopsis
Get all Task.
Get Task by id.
Returns a task by specified id.
Returns tasks based on filter criteria.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.7.2
python >= 3.5
Parameters
Parameter |
Comments |
---|---|
Data query parameter. Fetch tasks that contains this data. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
EndTime query parameter. This is the epoch end time upto which audit records need to be fetched. |
|
ErrorCode query parameter. Fetch tasks that have this error code. |
|
FailureReason query parameter. Fetch tasks that contains this failure reason. |
|
Additional headers. |
|
IsError query parameter. Fetch tasks ended as success or failure. Valid values true, false. |
|
Limit query parameter. |
|
Offset query parameter. |
|
Order query parameter. Sort order - asc or dsc. |
|
ParentId query parameter. Fetch tasks that have this parent Id. |
|
Progress query parameter. Fetch tasks that contains this progress. |
|
ServiceType query parameter. Fetch tasks with this service type. |
|
SortBy query parameter. Sort results by this field. |
|
StartTime query parameter. This is the epoch start time from which tasks need to be fetched. |
|
TaskId path parameter. UUID of the Task. |
|
Username query parameter. Fetch tasks with this username. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
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},
Supports
check_mode
The plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Task GetTaskById
Complete reference of the GetTaskById API.
- Cisco DNA Center documentation for Task GetTasks
Complete reference of the GetTasks API.
Examples
- 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 Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |