cisco.catalystcenter.path_traces_result_info module -- Information module for Path Traces Result
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.path_traces_result_info.
New in cisco.catalystcenter 2.11.0
Synopsis
Get all Path Traces Result.
Returns result of a previously requested path trace by its ID.
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 |
|---|---|
Flag for Cisco Catalyst Center SDK to enable debugging. Choices: |
|
The Cisco Catalyst Center hostname. |
|
The Cisco Catalyst Center password to authenticate. |
|
The Cisco Catalyst Center port. Default: :ansible-option-default:`443` |
|
The Cisco Catalyst 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 Catalyst Center to use. Default: :ansible-option-default:`"3.1.6.0"` |
|
Additional headers. |
|
Id path parameter. Unique identifier for the path trace request to be retrieved. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
|
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`. |
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
check_modeThe 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 Path Trace RetrievesPreviousPathTraceResult
Complete reference of the RetrievesPreviousPathTraceResult API.
Examples
---
- 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|