cisco.dnac.task_count_info – Information module for Task Count

Note

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

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

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

New in version 3.1.0: of cisco.dnac

Synopsis

• Get all Task Count.

Note

This module has a corresponding action plugin.

Requirements

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

• dnacentersdk >= 2.3.1

• python >= 3.5

Parameters

Parameter	Choices/Defaults	Comments
data string		Data query parameter. Fetch tasks that contains this data.
dnac_debug boolean	Choices: no ← yes	Flag for Cisco DNA Center SDK to enable debugging.
dnac_host string / required		The Cisco DNA Center hostname.
dnac_password string		The Cisco DNA Center password to authenticate.
dnac_port string	Default: 443	The Cisco DNA Center port.
dnac_username string	Default: "admin"	The Cisco DNA Center username to authenticate. aliases: user
dnac_verify boolean	Choices: no yes ←	Flag to enable or disable SSL certificate verification.
dnac_version string	Default: "2.2.2.3"	Informs the SDK which version of Cisco DNA Center to use.
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.
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.
startTime string		StartTime query parameter. This is the epoch start time from which tasks need to be fetched.
username string		Username query parameter. Fetch tasks with this username.
validate_response_schema boolean	Choices: no yes ←	Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.

Notes

Note

• Supports check_mode

See Also

See also

Task Count reference

Complete reference of the Task Count object model.

Examples

- name: Get all Task Count
  cisco.dnac.task_count_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
  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": 0, "version": "string" }

Authors

• Rafael Campos (@racampos)