cisco.dnac.thousand_eyes_test_results_count_info module -- Information module for Thousand Eyes Test Results Count

Note

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

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

New in cisco.dnac 6.18.0

Synopsis

  • Get all Thousand Eyes Test Results Count. - > Retrieves the total count of ThousandEyes test results for the given filters. If `startTime` and `endTime` are not provided, the API defaults to the last 24 hours. For detailed information about the usage of the API, please refer to the Open API specification document - https //github.com/cisco-en-programmability/catalyst- center-api-specs/blob/main/Assurance/CE_Cat_Center_Org-thousandEyesTestResults-1.0.0-resolved.yaml.

Note

This module has a corresponding action plugin.

Requirements

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

  • dnacentersdk >= 2.11.0

  • python >= 3.12

Parameters

Parameter

Comments

agentId

string

AgentId query parameter. Unique identifier of the ThousandEyes agent. Examples `agentId=199345` (filter for single agentId) `agentId=1993458&agentId=499387` (filter for multiple agentIds).

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:`"3.1.6.0"`

endTime

float

EndTime query parameter. End time to which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.

headers

dictionary

Additional headers.

networkDeviceName

string

NetworkDeviceName query parameter. Name of the network device as per the inventory. This supports `*` wildcard, and filtering is case-insensitve.

siteId

string

SiteId query parameter. The site UUID without the top level hierarchy. `siteId` must be a site UUID of a building. The list of buildings can be fetched using API `GET /dna/intent/api/v1/sites?type=building`. Examples `siteId=buildingUuid` (single siteId requested) `siteId=buildingUuid1&siteId=buildingUuid2` (multiple siteId requested).

startTime

float

StartTime query parameter. Start time from which API queries the data set related to the resource. It must be specified in UNIX epochtime in milliseconds. Value is inclusive.

testId

string

TestId query parameter. Unique identifier of the ThousandEyes test. Examples `testId=2043918` (filter for single testId) `testId=2043918&testId=129440` (filter for multiple testIds).

testName

string

TestName query parameter. Name of the ThousandEyes test. This supports `*` wildcard, and filtering is case-insensitve. Examples `testName=Cisco Webex` (exact match) `testName=Microsoft*` (starts with given string).

testType

string

TestType query parameter. Type of the ThousandEyes test. Please note that Catalyst Center supports only a subset of all possible ThousandEyes test types.

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 applications.Applications.retrieves_the_total_count_of_thousand_eyes_test_results,

  • Paths used are get /dna/data/api/v1/thousandEyesTestResults/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 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 Applications RetrievesTheTotalCountOfThousandEyesTestResults

Complete reference of the RetrievesTheTotalCountOfThousandEyesTestResults API.

Examples

---
- name: Get all Thousand Eyes Test Results Count
  cisco.dnac.thousand_eyes_test_results_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: "{{my_headers | from_json}}"
    siteId: string
    startTime: 0
    endTime: 0
    testId: string
    testName: string
    testType: string
    agentId: string
    networkDeviceName: 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": {"count": 0}, "version": "string"}`

Authors

  • Rafael Campos (@racampos)