cisco.catalystcenter.thousand_eyes_test_results_path_traces_info module -- Information module for Thousand Eyes Test Results Path Traces

Note

This module is part of the cisco.catalystcenter collection (version 2.12.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_path_traces_info.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all Thousand Eyes Test Results Path Traces.

  • Retrieves the list of path traces for the given ThousandEyes test result.

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

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

clientMacAddress

string

ClientMacAddress query parameter. Optional client MAC address. If this is provided the the path trace would start from the given client, otherwise the path trace starts from the switch where ThousanEyes agent is running.

headers

dictionary

Additional headers.

id

string

Id path parameter. Unique identifier of the test result.

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.retrieves_the_list_of_path_traces_for_the_given_thousand_eyes_test_result,

  • Paths used are get /dna/data/api/v1/thousandEyesTestResults/{id}/pathTraces,

  • 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 RetrievesTheListOfPathTracesForTheGivenThousandEyesTestResult

Complete reference of the RetrievesTheListOfPathTracesForTheGivenThousandEyesTestResult API.

Examples

---
- name: Get all Thousand Eyes Test Results Path Traces
  cisco.catalystcenter.thousand_eyes_test_results_path_traces_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}}"
    clientMacAddress: string
    id: 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:`{"appLink": "string", "response": [{"hops": [{"healthScore": 0, "identifier": "string", "index": 0, "ipAddress": "string", "jitter": 0, "location": "string", "name": "string", "network": "string", "responseTime": 0, "traceTerminated": true, "type": "string", "wlcId": "string"}], "id": "string"}], "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)