cisco.dnac.task_v1_info module -- Information module for Task V1

Note

This module is part of the cisco.dnac collection (version 6.30.2).

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_v1_info.

New in cisco.dnac 3.1.0

Synopsis

  • Get all Task V1.

  • Get Task V1 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.4.9

  • python >= 3.5

Parameters

Parameter

Comments

data

string

Data query parameter. Fetch tasks that contains this data.

dnac_debug

boolean

Flag for Cisco DNA Center SDK to enable debugging.

Choices:

dnac_host

string / required

The Cisco DNA Center hostname.

dnac_password

string

The Cisco DNA Center password to authenticate.

dnac_port

integer

The Cisco DNA Center port.

Default: :ansible-option-default:`443`

dnac_username

aliases: user

string

The Cisco DNA Center username to authenticate.

Default: :ansible-option-default:`"admin"`

dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

dnac_version

string

Informs the SDK which version of Cisco DNA Center to use.

Default: :ansible-option-default:`"2.3.7.6"`

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

float

Limit query parameter. The number of records to show for this page;The minimum is 1, and the maximum is 500.

offset

float

Offset query parameter. The first record to show for this page; the first record is numbered 1.

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.

validate_response_schema

boolean

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_v1, task.Task.get_tasks_operational_tasks_v1,

  • 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 GetTaskByIdV1

Complete reference of the GetTaskByIdV1 API.

Cisco DNA Center documentation for Task GetTasksOperationalTasksV1

Complete reference of the GetTasksOperationalTasksV1 API.

Examples

- name: Get all Task V1
  cisco.dnac.task_v1_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 V1 by id
  cisco.dnac.task_v1_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

dnac_response

dictionary

A dictionary or list with the response returned by the Cisco DNAC Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"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"}`

Authors

  • Rafael Campos (@racampos)