cisco.catalystcenter.thousand_eyes_test_results_trend_analytics_info module -- Information module for Thousand Eyes Test Results Trend Analytics

Note

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

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

New in cisco.catalystcenter 2.2.0

Synopsis

  • Get all Thousand Eyes Test Results Trend Analytics.

  • Get trend time series for ThousandEyes test results.

Note

This module has a corresponding action plugin.

Requirements

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

  • catalystcentersdk >= 3.2.3.0.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).

attribute

string

Attribute query parameter. List of attributes related to resource that can be requested to only be part of the response. Supported attributes are failurePercentage, averagePacketLoss, latestPacketLoss, maxPacketLoss, averageJitter, latestJitter, maxJitter, averageLatency, latestLatency, maxLatency Examples attribute=failurePercentage (single attribute requested) attribute=failurePercentage&attribute=maxLatency (multiple attribute requested).

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

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

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

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

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

Informs the SDK which version of Cisco Catalyst 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.

limit

integer

Limit query parameter. Maximum number of records to return.

networkDeviceName

string

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

offset

integer

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

string

Order query parameter. The sort order of the field ascending or descending.

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.

trendInterval

string

TrendInterval query parameter. The time interval to aggregate the metrics. Available values 5MIN, 30MIN, 1HR, 3HR Recommendation |Time duration |Recommended \`trendInterval\`| |--------------|---------------------------| |Up to 6 hr | \`5MIN\` | |6 hr to 2 days| `1HR` | |More than 2 days| `3HR` |.

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

  • Paths used are get /dna/data/api/v1/thousandEyesTestResults/trendAnalytics,

  • Supports check_mode

  • The plugin runs on the control node and does not use any ansible connection plugins,

  • but instead uses the embedded connection manager from Cisco CATALYST SDK

  • Requires Python >= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range)

See Also

See also

Cisco Catalyst Center documentation for Applications TheTrendAnalyticsDataForThousandEyesTestResultsInTheSpecifiedTimeRange

Complete reference of the TheTrendAnalyticsDataForThousandEyesTestResultsInTheSpecifiedTimeRange API.

Examples

---
- name: Get all Thousand Eyes Test Results Trend Analytics
  cisco.catalystcenter.thousand_eyes_test_results_trend_analytics_info:
    catalystcenter_host: "{{catalystcenter_host}}"
    catalystcenter_username: "{{catalystcenter_username}}"
    catalystcenter_password: "{{catalystcenter_password}}"
    catalystcenter_verify: "{{catalystcenter_verify}}"
    catalystcenter_port: "{{catalystcenter_port}}"
    catalystcenter_version: "{{catalystcenter_version}}"
    catalystcenter_debug: "{{catalystcenter_debug}}"
    headers: "{{my_headers | from_json}}"
    siteId: string
    startTime: 0
    endTime: 0
    trendInterval: string
    attribute: string
    testId: string
    testName: string
    testType: string
    agentId: string
    networkDeviceName: string
    limit: 100
    offset: 1
    order: 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 Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"page": {"count": 0, "limit": 0, "offset": 0, "timeSortOrder": "string"}, "response": [{"attributes": [{"name": "string", "value": 0}], "timestamp": 0}], "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)