cisco.dnac.thousand_eyes_test_results_info module -- Information module for Thousand Eyes Test Results
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_info.
New in cisco.dnac 6.18.0
Synopsis
Get all Thousand Eyes Test Results. - > Retrieves the list of ThousandEyes test results along with related metrics. If `startTime` and `endTime` are not provided, the API defaults to the last 24 hours.
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 query parameter. Unique identifier of the ThousandEyes agent. Examples `agentId=199345` (filter for single agentId) `agentId=1993458&agentId=499387` (filter for multiple agentIds). |
|
Attribute query parameter. List of attributes related to resource that can be requested to only be part of the response along with the required attributes. Examples `attribute=testName` (single attribute requested) `attribute=testId&attribute=testName&attribute=averageLatency` (multiple attributes requested). For valid attributes, verify the documentation. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices: |
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: :ansible-option-default:`443` |
|
The Cisco DNA Center username to authenticate. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Informs the SDK which version of Cisco DNA Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
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. |
|
Additional headers. |
|
Limit query parameter. Maximum number of records to return. |
|
NetworkDeviceName query parameter. Name of the network device as per the inventory. This supports `*` wildcard, and filtering is case-insensitve. |
|
Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1. |
|
Order query parameter. The sort order of the field ascending or descending. |
|
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). |
|
SortBy query parameter. Attribute name by which the results should be sorted. |
|
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 query parameter. Unique identifier of the ThousandEyes test. Examples `testId=2043918` (filter for single testId) `testId=2043918&testId=129440` (filter for multiple testIds). |
|
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 query parameter. Type of the ThousandEyes test. Please note that Catalyst Center supports only a subset of all possible ThousandEyes test types. |
|
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_list_of_thousand_eyes_test_results_along_with_related_metrics,
Paths used are get /dna/data/api/v1/thousandEyesTestResults,
Supports
check_modeThe 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 RetrievesTheListOfThousandEyesTestResultsAlongWithRelatedMetrics
Complete reference of the RetrievesTheListOfThousandEyesTestResultsAlongWithRelatedMetrics API.
Examples
---
- name: Get all Thousand Eyes Test Results
cisco.dnac.thousand_eyes_test_results_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
attribute: string
limit: 0
offset: 0
sortBy: string
order: string
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|