.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.thousand_eyes_test_results_info module -- Information module for Thousand Eyes Test Results ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.46.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.dnac.thousand_eyes_test_results_info`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.18.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.11.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-agentid: .. rst-class:: ansible-option-title **agentId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AgentId query parameter. Unique identifier of the ThousandEyes agent. Examples \`agentId=199345\` (filter for single agentId) \`agentId=1993458&agentId=499387\` (filter for multiple agentIds). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-attribute: .. rst-class:: ansible-option-title **attribute** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-endtime: .. rst-class:: ansible-option-title **endTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-limit: .. rst-class:: ansible-option-title **limit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Limit query parameter. Maximum number of records to return. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-networkdevicename: .. rst-class:: ansible-option-title **networkDeviceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
NetworkDeviceName query parameter. Name of the network device as per the inventory. This supports \`\*\` wildcard, and filtering is case-insensitve. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-offset: .. rst-class:: ansible-option-title **offset** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Offset query parameter. Specifies the starting point within all records returned by the API. It's one based offset. The starting value is 1. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-order: .. rst-class:: ansible-option-title **order** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Order query parameter. The sort order of the field ascending or descending. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-siteid: .. rst-class:: ansible-option-title **siteId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-sortby: .. rst-class:: ansible-option-title **sortBy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SortBy query parameter. Attribute name by which the results should be sorted. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-starttime: .. rst-class:: ansible-option-title **startTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`float` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-testid: .. rst-class:: ansible-option-title **testId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
TestId query parameter. Unique identifier of the ThousandEyes test. Examples \`testId=2043918\` (filter for single testId) \`testId=2043918&testId=129440\` (filter for multiple testIds). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-testname: .. rst-class:: ansible-option-title **testName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-testtype: .. rst-class:: ansible-option-title **testType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
TestType query parameter. Type of the ThousandEyes test. Please note that Catalyst Center supports only a subset of all possible ThousandEyes test types. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Applications RetrievesTheListOfThousandEyesTestResultsAlongWithRelatedMetrics `_ Complete reference of the RetrievesTheListOfThousandEyesTestResultsAlongWithRelatedMetrics API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.dnac.thousand_eyes_test_results_info_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco DNAC Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"page": {"count": 0, "limit": 0, "offset": 0, "sortBy": [{"name": "string", "order": "string"}]}, "response": [{"agentId": "string", "agentName": "string", "averageJitter": {}, "averageLatency": 0, "averageMos": {}, "averagePacketLoss": 0, "averagePdv": {}, "averageResponseTime": 0, "id": "string", "latestJitter": {}, "latestLatency": 0, "latestMos": {}, "latestPacketLoss": 0, "latestPdv": {}, "latestResponseTime": 0, "maxJitter": {}, "maxLatency": 0, "maxPacketLoss": 0, "maxPdv": {}, "maxResponseTime": 0, "minMos": {}, "networkDeviceName": "string", "networkDeviceType": "string", "sampleTime": 0, "siteId": "string", "siteName": "string", "testId": "string", "testInterval": 0, "testName": "string", "testTarget": "string", "testType": "string", "totalActiveAlerts": 0, "totalAlerts": 0, "totalErrorsSamplingTests": 0, "totalFailureSamplingTests": 0, "totalSamplingTests": 0}], "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors