cisco / cisco.dnac / 6.13.3 / module / task_info Information module for Task | "added in version" 3.1.0 of cisco.dnac" Authors: Rafael Campos (@racampos) This plugin has a corresponding action plugin.cisco.dnac.task_info (6.13.3) — module
Install with ansible-galaxy collection install cisco.dnac:==6.13.3
collections: - name: cisco.dnac version: 6.13.3
Get all Task.
Get Task by id.
Returns a task by specified id.
Returns tasks based on filter criteria.
- 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
data: description: - Data query parameter. Fetch tasks that contains this data. type: str limit: description: - Limit query parameter. type: int order: description: - Order query parameter. Sort order - asc or dsc. type: str offset: description: - Offset query parameter. type: int sortBy: description: - SortBy query parameter. Sort results by this field. type: str taskId: description: - TaskId path parameter. UUID of the Task. type: str endTime: description: - EndTime query parameter. This is the epoch end time upto which audit records need to be fetched. type: str headers: description: Additional headers. type: dict isError: description: - IsError query parameter. Fetch tasks ended as success or failure. Valid values true, false. type: str parentId: description: - ParentId query parameter. Fetch tasks that have this parent Id. type: str progress: description: - Progress query parameter. Fetch tasks that contains this progress. type: str username: description: - Username query parameter. Fetch tasks with this username. type: str dnac_host: description: - The Cisco DNA Center hostname. required: true type: str dnac_port: default: 443 description: - The Cisco DNA Center port. type: int errorCode: description: - ErrorCode query parameter. Fetch tasks that have this error code. type: str startTime: description: - StartTime query parameter. This is the epoch start time from which tasks need to be fetched. type: str dnac_debug: default: false description: - Flag for Cisco DNA Center SDK to enable debugging. type: bool dnac_verify: default: true description: - Flag to enable or disable SSL certificate verification. type: bool serviceType: description: - ServiceType query parameter. Fetch tasks with this service type. type: str dnac_version: default: 2.3.5.3 description: - Informs the SDK which version of Cisco DNA Center to use. type: str dnac_password: description: - The Cisco DNA Center password to authenticate. type: str dnac_username: aliases: - user default: admin description: - The Cisco DNA Center username to authenticate. type: str failureReason: description: - FailureReason query parameter. Fetch tasks that contains this failure reason. type: str validate_response_schema: default: true description: - Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. type: bool
dnac_response: description: A dictionary or list with the response returned by the Cisco DNAC Python SDK returned: always sample: "{\n \"response\": {\n \"additionalStatusURL\": \"string\",\n \"\ data\": \"string\",\n \"endTime\": 0,\n \"errorCode\": \"string\",\n \ \ \"errorKey\": \"string\",\n \"failureReason\": \"string\",\n \"id\": \"\ string\",\n \"instanceTenantId\": \"string\",\n \"isError\": true,\n \ \ \"lastUpdate\": 0,\n \"operationIdList\": {},\n \"parentId\": \"string\"\ ,\n \"progress\": \"string\",\n \"rootId\": \"string\",\n \"serviceType\"\ : \"string\",\n \"startTime\": 0,\n \"username\": \"string\",\n \"version\"\ : 0\n },\n \"version\": \"string\"\n}\n" type: dict