cisco.dnac.task_info – Information module for Task

Note

This plugin is part of the cisco.dnac collection (version 3.1.2).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.task_info.

New in version 1.0.0: of cisco.dnac

Synopsis

• Get all Task.

• Get Task by id.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
data string		Data query parameter. Fetch tasks that contains this data.
endTime string		EndTime query parameter. This is the epoch end time upto which audit records need to be fetched.
errorCode string		ErrorCode query parameter. Fetch tasks that have this error code.
failureReason string		FailureReason query parameter. Fetch tasks that contains this failure reason.
headers dictionary		Additional headers.
isError string		IsError query parameter. Fetch tasks ended as success or failure. Valid values true, false.
limit string		Limit query parameter.
offset string		Offset query parameter.
order string		Order query parameter. Sort order - asc or dsc.
parentId string		ParentId query parameter. Fetch tasks that have this parent Id.
progress string		Progress query parameter. Fetch tasks that contains this progress.
serviceType string		ServiceType query parameter. Fetch tasks with this service type.
sortBy string		SortBy query parameter. Sort results by this field.
startTime string		StartTime query parameter. This is the epoch start time from which tasks need to be fetched.
taskId string		TaskId path parameter. UUID of the Task.
username string		Username query parameter. Fetch tasks with this username.

See Also

See also

Task reference

Complete reference of the Task object model.

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:
      custom: value
    startTime: string
    endTime: string
    data: string
    errorCode: string
    serviceType: string
    username: string
    progress: string
    isError: string
    failureReason: string
    parentId: string
    offset: string
    limit: string
    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:
      custom: value
    taskId: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
dnac_response dictionary	always	A dictionary or list with the response returned by the Cisco DNAC Python SDK Sample: { "response": { "additionalStatusURL": "string", "data": "string", "endTime": "string", "errorCode": "string", "errorKey": "string", "failureReason": "string", "id": "string", "instanceTenantId": "string", "isError": true, "lastUpdate": "string", "operationIdList": {}, "parentId": "string", "progress": "string", "rootId": "string", "serviceType": "string", "startTime": "string", "username": "string", "version": 0 }, "version": "string" }

Authors

• Rafael Campos (@racampos)