cisco.dnac.tasks_info module – Information module for Tasks Info
Note
This module is part of the cisco.dnac collection (version 6.27.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.tasks_info.
New in cisco.dnac 6.15.0
Synopsis
This module represents an alias of the module tasks_v1_info
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.4.9
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
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 millisecond end time upto which task records need to be fetched. |
|
Additional headers. |
|
Id path parameter. The `id` of the task to retrieve. |
|
Limit query parameter. The number of records to show for this page;The minimum is 1, and the maximum is 500. |
|
Offset query parameter. The first record to show for this page; the first record is numbered 1. |
|
Order query parameter. Whether ascending or descending order should be used to sort the response. |
|
ParentId query parameter. Fetch tasks that have this parent Id. |
|
RootId query parameter. Fetch tasks that have this root Id. |
|
SortBy query parameter. A property within the response to sort by. |
|
StartTime query parameter. This is the epoch millisecond start time from which tasks need to be fetched. |
|
Status query parameter. Fetch tasks that have this status. Available values PENDING, FAILURE, SUCCESS. |
|
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_tasks_by_id_v1, task.Task.get_tasks_v1,
Paths used are get /dna/intent/api/v1/tasks, get /dna/intent/api/v1/tasks/{id},
It should be noted that this module is an alias of tasks_v1_info
Supports
check_modeThe 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 GetTasksByIDV1
Complete reference of the GetTasksByIDV1 API.
- Cisco DNA Center documentation for Task GetTasksV1
Complete reference of the GetTasksV1 API.
Examples
- 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
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: |