cisco.catalystcenter.path_traces_info module -- Information module for 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.path_traces_info.
New in cisco.catalystcenter 2.11.0
Synopsis
Get all Path Traces.
Get Path Traces by id.
Returns a summary of a specific path trace by its ID without the detailed path trace information.
Returns a summary of all path traces stored. Results can be filtered by specified parameters.
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"` |
|
DestinationIpAddress query parameter. Destination IP address used in the path trace. Format can be IPv4 (e.g., 192.168.1.1) or IPv6. |
|
DestinationMacAddress query parameter. Destination MAC address used in the path trace. Format should be XX XX XX XX XX XX (e.g., 00 1A 2B 3C 4D 5E). |
|
DestinationPort query parameter. Destination port used in the path trace. Valid range is 1-65535. |
|
GreaterThanCreateTime query parameter. Retrieves analyses requested after this time. Value is in epoch milliseconds. |
|
Additional headers. |
|
Id path parameter. Unique identifier for the path trace request summary to be retrieved. |
|
LastUpdateTime query parameter. Retrieves analyses that were last updated at this time. Value is in epoch milliseconds. |
|
LessThanCreateTime query parameter. Retrieves analyses requested before this time. Value is in epoch milliseconds. |
|
Limit query parameter. Maximum number of resources to return in the response. Use for pagination. |
|
Offset query parameter. Starting index of resources to be returned (1-based). Use for pagination. |
|
Order query parameter. Sorting order for the returned results. | Value | Description | | ----- | ----------- | | asc | Ascending order | | desc | Descending order |. |
|
PeriodicRefresh query parameter. Indicates whether the analysis is periodically refreshed. | Value | Description | | ----- | ----------- | | true | Analysis is refreshed every 30 seconds | | false | Analysis is performed once |. Choices: |
|
Protocol query parameter. Protocol used in the path trace. | Value | Description | | ----- | ----------- | | TCP | Transmission Control Protocol | | UDP | User Datagram Protocol |. |
|
SortBy query parameter. Field to sort the results by. Common values include createTime, status, sourceIpAddress, destinationIpAddress. |
|
SourceIpAddress query parameter. Source IP address used in the path trace. Format can be IPv4 (e.g., 192.168.1.1) or IPv6. |
|
SourceMacAddress query parameter. Source MAC address used in the path trace. Format should be XX XX XX XX XX XX (e.g., 00 1A 2B 3C 4D 5E). |
|
SourcePort query parameter. Source port used in the path trace. Valid range is 1-65535. |
|
Status query parameter. Status of the path trace. | Value | Description | | ----- | ----------- | | SUCCESS | Path trace completed successfully | | INPROGRESS | Path trace is currently running | | FAILED | Path trace failed to complete | | SCHEDULED | Path trace is scheduled to run | | PENDING | Path trace is pending execution | | COMPLETED | Path trace has completed |. |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
SDK Method used are path_trace.PathTrace.retrieves_the_summary_of_a_specific_path_trace, path_trace.PathTrace.retrieves_the_summary_of_all_previous_path_traces,
Paths used are get /dna/intent/api/v1/pathTraces, get /dna/intent/api/v1/pathTraces/{id},
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 RetrievesTheSummaryOfASpecificPathTrace
Complete reference of the RetrievesTheSummaryOfASpecificPathTrace API.
- Cisco Catalyst Center documentation for Path Trace RetrievesTheSummaryOfAllPreviousPathTraces
Complete reference of the RetrievesTheSummaryOfAllPreviousPathTraces API.
Examples
---
- name: Get all Path Traces
cisco.catalystcenter.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}}"
periodicRefresh: true
sourceIpAddress: 10.1.15.10
sourceMacAddress: 00:1A:2B:3C:4D:5E
destinationIpAddress: 10.1.25.10
destinationMacAddress: AA:BB:CC:DD:EE:FF
sourcePort: 443
destinationPort: 8080
greaterThanCreateTime: 1625097600000
lessThanCreateTime: 1627776000000
protocol: TCP
status: SUCCESS
lastUpdateTime: 1625184000000
limit: 50
offset: 1
order: desc
sortBy: createTime
register: result
- name: Get Path Traces by id
cisco.catalystcenter.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}}"
id: fad5db1e-8c2a-4bf8-94a5-1fa498c4d651
register: result
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always |