.. 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.catalystcenter.path_traces_result_info_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.path_traces_result_info module -- Information module for Path Traces Result ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.12.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. 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.catalystcenter.path_traces_result_info`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.11.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Get all Path Traces Result. - Returns result of a previously requested path trace by its ID. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.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.catalystcenter.path_traces_result_info_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst 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.catalystcenter.path_traces_result_info_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst 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.catalystcenter.path_traces_result_info_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. 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.catalystcenter.path_traces_result_info_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst 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.catalystcenter.path_traces_result_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.catalystcenter.path_traces_result_info_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. Unique identifier for the path trace request to be retrieved. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_result_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 Catalyst 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
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_result_info_module__parameter-view: .. rst-class:: ansible-option-title **view** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
View query parameter. Specifies which detailed information to include in the response. | Value | Description | Fields | | ----- | ----------- | ------ | | acl | Include Access Control List (ACL) information | aclStatus, aclName, aclResult, aclRules | | qos | Include Quality of Service (QoS) information |dropRate, numBytes, numPackets, offeredRate, queueBandwidthInBps, queueDepth, queueNoBufferDrops, queueTotalDrops | | flexConnect | Include FlexConnect information for wireless access points | dataSwitching, authentication, wirelessLanControllerId, ingressAclAnalysis, egressAclAnalysis, wirelessLanControllerName | | accuracyList | Include accuracy assessment information | List of accuracy(percentage), reason(reason for decrease in accuracy) computed using Netflow | | deviceStatistics | Include CPU and memory statistics for devices | cpuStatistics - fiveMinUsageInPercentage. FiveSecsUsageInPercentage, oneMinUsageInPercentage, refreshedAt; memoryStatistics - memoryUsed, totalMemory, refreshedAt | | performanceMonitorStatistics | Include performance monitoring statistics | packetCount, byteRate, packetLoss, packetLossPercentage, rtpJitterMean, rtpJitterMin, rtpJitterMax, ipv4DSCP, ipv4TTL, inputInterface, outputInterface, refreshedAt, sourceIpAddress, destIpAddress, protocol, sourcePort, destPort, packetBytes | | interfaceStatistics | Include interface statistics information | adminStatus, inputPackets, inputQueueDrops, inputQueueMaxDepth, inputQueueCount, inputQueueFlushes, inputRateInBps, operationalStatus, outputDrop, outputPackets, outputQueueCount, outputQueueDepth, outputRateInBps, refreshedAt | If no view is specified, only the default fields are returned. Multiple views can be specified as exploded query parameters. E.g. \`view=qos&view=acl\`. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are path\_trace.PathTrace.retrieves\_previous\_path\_trace\_result, - Paths used are get /dna/intent/api/v1/pathTraces/{id}/result, - Supports \ :literal:`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) .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Path Trace RetrievesPreviousPathTraceResult `_ Complete reference of the RetrievesPreviousPathTraceResult API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Get all Path Traces Result cisco.catalystcenter.path_traces_result_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}}" view: ['acl', 'deviceStatistics'] id: 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.catalystcenter.path_traces_result_info_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_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 Catalyst Center 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:`{"response": {"aclStatus": {"aclTraceCalculation": "string", "aclTraceCalculationFailureReason": "string"}, "controlPath": true, "createTime": 0, "destinationIpAddress": "string", "destinationPort": "string", "failureReason": "string", "id": "string", "inclusions": ["string"], "lastUpdateTime": 0, "networkElementsInfo": [{"accuracyList": [{"percent": 0, "reason": "string"}], "aclStatus": {"aclTraceCalculation": "string", "aclTraceCalculationFailureReason": "string"}, "deviceStatistics": {"cpuStatistics": {"fiveMinUsageInPercentage": 0, "fiveSecsUsageInPercentage": 0, "oneMinUsageInPercentage": 0, "refreshedAt": 0}, "memoryStatistics": {"memoryUsage": 0, "refreshedAt": 0, "totalMemory": 0}}, "deviceStatsCollection": "string", "deviceStatsCollectionFailureReason": "string", "egressInterface": {"physicalInterface": {"aclName": "string", "aclResult": "string", "aclRules": {"matchingAclRules": [{"ace": "string", "matchingPorts": [{"ports": [{"destPorts": ["string"], "sourcePorts": ["string"]}], "protocol": "string"}], "result": "string"}]}, "id": "string", "interfaceStatistics": {"adminStatus": "string", "inputPackets": 0, "inputQueueCount": 0, "inputQueueDrops": 0, "inputQueueFlushes": 0, "inputQueueMaxDepth": 0, "inputRateInBps": 0, "operationalStatus": "string", "outputDrop": 0, "outputPackets": 0, "outputQueueCount": 0, "outputQueueDepth": 0, "outputRateInBps": 0, "refreshedAt": 0}, "interfaceStatsCollection": "string", "interfaceStatsCollectionFailureReason": "string", "name": "string", "pathOverlayInfo": [{"controlPlane": "string", "dataPacketEncapsulation": "string", "destinationIpAddress": "string", "destinationPort": "string", "protocol": "string", "sourceIpAddress": "string", "sourcePort": "string", "vxlanInfo": {"dscp": "string", "vnid": "string"}}], "qos": {"collectionFailureReason": "string", "statistics": [{"classMapName": "string", "dropRate": 0, "numBytes": 0, "numPackets": 0, "offeredRate": 0, "queueBandwidthInBps": "string", "queueDepth": 0, "queueNoBufferDrops": 0, "queueTotalDrops": 0, "refreshedAt": 0}], "statsCollection": "string"}, "usedVlan": "string", "vrfName": "string"}, "virtualInterface": [{"aclName": "string", "aclResult": "string", "aclRules": {"matchingAclRules": [{"ace": "string", "matchingPorts": [{"ports": [{"destPorts": ["string"], "sourcePorts": ["string"]}], "protocol": "string"}], "result": "string"}]}, "id": "string", "interfaceStatistics": {"adminStatus": "string", "inputPackets": 0, "inputQueueCount": 0, "inputQueueDrops": 0, "inputQueueFlushes": 0, "inputQueueMaxDepth": 0, "inputRateInBps": 0, "operationalStatus": "string", "outputDrop": 0, "outputPackets": 0, "outputQueueCount": 0, "outputQueueDepth": 0, "outputRateInBps": 0, "refreshedAt": 0}, "interfaceStatsCollection": "string", "interfaceStatsCollectionFailureReason": "string", "name": "string", "pathOverlayInfo": [{"controlPlane": "string", "dataPacketEncapsulation": "string", "destinationIpAddress": "string", "destinationPort": "string", "protocol": "string", "sourceIpAddress": "string", "sourcePort": "string", "vxlanInfo": {"dscp": "string", "vnid": "string"}}], "qos": {"collectionFailureReason": "string", "statistics": [{"classMapName": "string", "dropRate": 0, "numBytes": 0, "numPackets": 0, "offeredRate": 0, "queueBandwidthInBps": "string", "queueDepth": 0, "queueNoBufferDrops": 0, "queueTotalDrops": 0, "refreshedAt": 0}], "statsCollection": "string"}, "usedVlan": "string", "vrfName": "string"}]}, "flexConnect": {"authentication": "string", "dataSwitching": "string", "egressAclName": "string", "egressAclResult": "string", "egressAclRules": {"matchingAclRules": [{"ace": "string", "matchingPorts": [{"ports": [{"destPorts": ["string"], "sourcePorts": ["string"]}], "protocol": "string"}], "result": "string"}]}, "ingressAclName": "string", "ingressAclResult": "string", "ingressAclRules": {"matchingAclRules": [{"ace": "string", "matchingPorts": [{"ports": [{"destPorts": ["string"], "sourcePorts": ["string"]}], "protocol": "string"}], "result": "string"}]}, "wirelessLanControllerId": "string", "wirelessLanControllerName": "string"}, "id": "string", "ingressInterface": {"physicalInterface": {"aclName": "string", "aclResult": "string", "aclRules": {"matchingAclRules": [{"ace": "string", "matchingPorts": [{"ports": [{"destPorts": ["string"], "sourcePorts": ["string"]}], "protocol": "string"}], "result": "string"}]}, "id": "string", "interfaceStatistics": {"adminStatus": "string", "inputPackets": 0, "inputQueueCount": 0, "inputQueueDrops": 0, "inputQueueFlushes": 0, "inputQueueMaxDepth": 0, "inputRateInBps": 0, "operationalStatus": "string", "outputDrop": 0, "outputPackets": 0, "outputQueueCount": 0, "outputQueueDepth": 0, "outputRateInBps": 0, "refreshedAt": 0}, "interfaceStatsCollection": "string", "interfaceStatsCollectionFailureReason": "string", "name": "string", "pathOverlayInfo": [{"controlPlane": "string", "dataPacketEncapsulation": "string", "destinationIpAddress": "string", "destinationPort": "string", "protocol": "string", "sourceIpAddress": "string", "sourcePort": "string", "vxlanInfo": {"dscp": "string", "vnid": "string"}}], "qos": {"collectionFailureReason": "string", "statistics": [{"classMapName": "string", "dropRate": 0, "numBytes": 0, "numPackets": 0, "offeredRate": 0, "queueBandwidthInBps": "string", "queueDepth": 0, "queueNoBufferDrops": 0, "queueTotalDrops": 0, "refreshedAt": 0}], "statsCollection": "string"}, "usedVlan": "string", "vrfName": "string"}, "virtualInterface": [{"aclName": "string", "aclResult": "string", "aclRules": {"matchingAclRules": [{"ace": "string", "matchingPorts": [{"ports": [{"destPorts": ["string"], "sourcePorts": ["string"]}], "protocol": "string"}], "result": "string"}]}, "id": "string", "interfaceStatistics": {"adminStatus": "string", "inputPackets": 0, "inputQueueCount": 0, "inputQueueDrops": 0, "inputQueueFlushes": 0, "inputQueueMaxDepth": 0, "inputRateInBps": 0, "operationalStatus": "string", "outputDrop": 0, "outputPackets": 0, "outputQueueCount": 0, "outputQueueDepth": 0, "outputRateInBps": 0, "refreshedAt": 0}, "interfaceStatsCollection": "string", "interfaceStatsCollectionFailureReason": "string", "name": "string", "pathOverlayInfo": [{"controlPlane": "string", "dataPacketEncapsulation": "string", "destinationIpAddress": "string", "destinationPort": "string", "protocol": "string", "sourceIpAddress": "string", "sourcePort": "string", "vxlanInfo": {"dscp": "string", "vnid": "string"}}], "qos": {"collectionFailureReason": "string", "statistics": [{"classMapName": "string", "dropRate": 0, "numBytes": 0, "numPackets": 0, "offeredRate": 0, "queueBandwidthInBps": "string", "queueDepth": 0, "queueNoBufferDrops": 0, "queueTotalDrops": 0, "refreshedAt": 0}], "statsCollection": "string"}, "usedVlan": "string", "vrfName": "string"}]}, "ipAddress": "string", "linkInformationSource": "string", "macAddress": "string", "name": "string", "performanceMonitorCollection": "string", "performanceMonitorCollectionFailureReason": "string", "performanceMonitorStatistics": [{"byteRate": 0, "destinationIpAddress": "string", "destinationPort": "string", "inputInterface": "string", "ipv4DSCP": "string", "ipv4TTL": 0, "outputInterface": "string", "packetBytes": 0, "packetCount": 0, "packetLoss": 0, "packetLossPercentage": 0, "protocol": "string", "refreshedAt": 0, "rtpJitterMax": 0, "rtpJitterMean": 0, "rtpJitterMin": 0, "sourceIpAddress": "string", "sourcePort": "string"}], "role": "string", "ssid": "string", "tunnels": ["string"], "type": "string", "wlanId": "string"}], "periodicRefresh": true, "previousPathTraceId": "string", "properties": ["string"], "protocol": "string", "sourceIpAddress": "string", "sourcePort": "string", "status": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors