cisco.catalystcenter.task_count_v1_info module -- Information module for Task Count V1

Note

This module is part of the cisco.catalystcenter collection (version 2.1.4).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.task_count_v1_info.

New in cisco.catalystcenter 3.1.0

Synopsis

  • Get all Task Count V1.

  • Returns Task count.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 2.3.7.9

  • python >= 3.5

Parameters

Parameter

Comments

_api_port

integer

The Cisco CATALYST Center port.

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

_debug

boolean

Flag for Cisco CATALYST Center SDK to enable debugging.

Choices:

_host

string / required

The Cisco CATALYST Center hostname.

_password

string

The Cisco CATALYST Center password to authenticate.

_username

aliases: user

string

The Cisco CATALYST Center username to authenticate.

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

_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

_version

string

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

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

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.

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

Flag for Cisco CATALYST Center SDK to enable the validation of request bodies against a JSON schema.

Choices:

Notes

Note

  • SDK Method used are task.Task.get_task_count_v1,

  • Paths used are get /dna/intent/api/v1/task/count,

  • 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 CATALYST SDK

  • The parameters starting with catalystCenter_ are used by the Cisco CATALYST Python SDK to establish the connection

See Also

See also

Cisco DNA Center documentation for Task GetTaskCountV1

Complete reference of the GetTaskCountV1 API.

Examples

- name: Get all Task Count V1
  cisco.catalystcenter.task_count_v1_info:
    _host: "{{ _host }}"
    _username: "{{ _username }}"
    _password: "{{ _password }}"
    _verify: "{{ _verify }}"
    _api_port: "{{ _api_port }}"
    _version: "{{ _version }}"
    _debug: "{{ _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
  register: result

Return Values

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

Key

Description

catalystcenter_response

dictionary

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

Returned: always

Sample: :ansible-rv-sample-value:`{"response": 0, "version": "string"}`

Authors

  • Rafael Campos (@racampos)