| Server IP : 85.214.239.14 / Your IP : 3.136.22.145 Web Server : Apache/2.4.62 (Debian) System : Linux h2886529.stratoserver.net 4.9.0 #1 SMP Tue Jan 9 19:45:01 MSK 2024 x86_64 User : www-data ( 33) PHP Version : 7.4.18 Disable Function : pcntl_alarm,pcntl_fork,pcntl_waitpid,pcntl_wait,pcntl_wifexited,pcntl_wifstopped,pcntl_wifsignaled,pcntl_wifcontinued,pcntl_wexitstatus,pcntl_wtermsig,pcntl_wstopsig,pcntl_signal,pcntl_signal_get_handler,pcntl_signal_dispatch,pcntl_get_last_error,pcntl_strerror,pcntl_sigprocmask,pcntl_sigwaitinfo,pcntl_sigtimedwait,pcntl_exec,pcntl_getpriority,pcntl_setpriority,pcntl_async_signals,pcntl_unshare, MySQL : OFF | cURL : OFF | WGET : ON | Perl : ON | Python : ON | Sudo : ON | Pkexec : OFF Directory : /usr/lib/python3/dist-packages/ansible_collections/cisco/dnac/plugins/modules/ |
Upload File : |
#!/usr/bin/python
# -*- coding: utf-8 -*-
# Copyright (c) 2021, Cisco Systems
# GNU General Public License v3.0+ (see LICENSE or https://www.gnu.org/licenses/gpl-3.0.txt)
DOCUMENTATION = r"""
---
module: path_trace_info
short_description: Information module for Path Trace
description:
- Get all Path Trace.
- Get Path Trace by id.
- Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.
- Returns result of a previously requested flow analysis by its Flow Analysis id.
version_added: '3.1.0'
extends_documentation_fragment:
- cisco.dnac.module_info
author: Rafael Campos (@racampos)
options:
headers:
description: Additional headers.
type: dict
periodicRefresh:
description:
- PeriodicRefresh query parameter. Is analysis periodically refreshed?.
type: bool
sourceIP:
description:
- SourceIP query parameter. Source IP address.
type: str
destIP:
description:
- DestIP query parameter. Destination IP adress.
type: str
sourcePort:
description:
- SourcePort query parameter. Source port.
type: str
destPort:
description:
- DestPort query parameter. Destination port.
type: str
gtCreateTime:
description:
- GtCreateTime query parameter. Analyses requested after this time.
type: str
ltCreateTime:
description:
- LtCreateTime query parameter. Analyses requested before this time.
type: str
protocol:
description:
- Protocol query parameter.
type: str
status:
description:
- Status query parameter.
type: str
taskId:
description:
- TaskId query parameter. Task ID.
type: str
lastUpdateTime:
description:
- LastUpdateTime query parameter. Last update time.
type: str
limit:
description:
- Limit query parameter. Number of resources returned.
type: int
offset:
description:
- Offset query parameter. Start index of resources returned (1-based).
type: int
order:
description:
- Order query parameter. Order by this field.
type: str
sortBy:
description:
- SortBy query parameter. Sort by this field.
type: str
flowAnalysisId:
description:
- FlowAnalysisId path parameter. Flow analysis request id.
type: str
requirements:
- dnacentersdk >= 2.5.5
- python >= 3.5
seealso:
- name: Cisco DNA Center documentation for Path Trace RetrievesPreviousPathtrace
description: Complete reference of the RetrievesPreviousPathtrace API.
link: https://developer.cisco.com/docs/dna-center/#!retrieves-previous-pathtrace
- name: Cisco DNA Center documentation for Path Trace RetrivesAllPreviousPathtracesSummary
description: Complete reference of the RetrivesAllPreviousPathtracesSummary API.
link: https://developer.cisco.com/docs/dna-center/#!retrives-all-previous-pathtraces-summary
notes:
- SDK Method used are
path_trace.PathTrace.retrieves_previous_pathtrace,
path_trace.PathTrace.retrives_all_previous_pathtraces_summary,
- Paths used are
get /dna/intent/api/v1/flow-analysis,
get /dna/intent/api/v1/flow-analysis/{flowAnalysisId},
"""
EXAMPLES = r"""
- name: Get all Path Trace
cisco.dnac.path_trace_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}}"
periodicRefresh: True
sourceIP: string
destIP: string
sourcePort: string
destPort: string
gtCreateTime: string
ltCreateTime: string
protocol: string
status: string
taskId: string
lastUpdateTime: string
limit: 0
offset: 0
order: string
sortBy: string
register: result
- name: Get Path Trace by id
cisco.dnac.path_trace_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}}"
flowAnalysisId: string
register: result
"""
RETURN = r"""
dnac_response:
description: A dictionary or list with the response returned by the Cisco DNAC Python SDK
returned: always
type: dict
sample: >
{
"response": {
"detailedStatus": {
"aclTraceCalculation": "string",
"aclTraceCalculationFailureReason": "string"
},
"lastUpdate": "string",
"networkElements": [
{
"accuracyList": [
{
"percent": 0,
"reason": "string"
}
],
"detailedStatus": {
"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",
"egressPhysicalInterface": {
"aclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"id": "string",
"interfaceStatistics": {
"adminStatus": "string",
"inputPackets": 0,
"inputQueueCount": 0,
"inputQueueDrops": 0,
"inputQueueFlushes": 0,
"inputQueueMaxDepth": 0,
"inputRatebps": 0,
"operationalStatus": "string",
"outputDrop": 0,
"outputPackets": 0,
"outputQueueCount": 0,
"outputQueueDepth": 0,
"outputRatebps": 0,
"refreshedAt": 0
},
"interfaceStatsCollection": "string",
"interfaceStatsCollectionFailureReason": "string",
"name": "string",
"pathOverlayInfo": [
{
"controlPlane": "string",
"dataPacketEncapsulation": "string",
"destIp": "string",
"destPort": "string",
"protocol": "string",
"sourceIp": "string",
"sourcePort": "string",
"vxlanInfo": {
"dscp": "string",
"vnid": "string"
}
}
],
"qosStatistics": [
{
"classMapName": "string",
"dropRate": 0,
"numBytes": 0,
"numPackets": 0,
"offeredRate": 0,
"queueBandwidthbps": "string",
"queueDepth": 0,
"queueNoBufferDrops": 0,
"queueTotalDrops": 0,
"refreshedAt": 0
}
],
"qosStatsCollection": "string",
"qosStatsCollectionFailureReason": "string",
"usedVlan": "string",
"vrfName": "string"
},
"egressVirtualInterface": {
"aclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"id": "string",
"interfaceStatistics": {
"adminStatus": "string",
"inputPackets": 0,
"inputQueueCount": 0,
"inputQueueDrops": 0,
"inputQueueFlushes": 0,
"inputQueueMaxDepth": 0,
"inputRatebps": 0,
"operationalStatus": "string",
"outputDrop": 0,
"outputPackets": 0,
"outputQueueCount": 0,
"outputQueueDepth": 0,
"outputRatebps": 0,
"refreshedAt": 0
},
"interfaceStatsCollection": "string",
"interfaceStatsCollectionFailureReason": "string",
"name": "string",
"pathOverlayInfo": [
{
"controlPlane": "string",
"dataPacketEncapsulation": "string",
"destIp": "string",
"destPort": "string",
"protocol": "string",
"sourceIp": "string",
"sourcePort": "string",
"vxlanInfo": {
"dscp": "string",
"vnid": "string"
}
}
],
"qosStatistics": [
{
"classMapName": "string",
"dropRate": 0,
"numBytes": 0,
"numPackets": 0,
"offeredRate": 0,
"queueBandwidthbps": "string",
"queueDepth": 0,
"queueNoBufferDrops": 0,
"queueTotalDrops": 0,
"refreshedAt": 0
}
],
"qosStatsCollection": "string",
"qosStatsCollectionFailureReason": "string",
"usedVlan": "string",
"vrfName": "string"
},
"flexConnect": {
"authentication": "string",
"dataSwitching": "string",
"egressAclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"ingressAclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"wirelessLanControllerId": "string",
"wirelessLanControllerName": "string"
},
"id": "string",
"ingressPhysicalInterface": {
"aclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"id": "string",
"interfaceStatistics": {
"adminStatus": "string",
"inputPackets": 0,
"inputQueueCount": 0,
"inputQueueDrops": 0,
"inputQueueFlushes": 0,
"inputQueueMaxDepth": 0,
"inputRatebps": 0,
"operationalStatus": "string",
"outputDrop": 0,
"outputPackets": 0,
"outputQueueCount": 0,
"outputQueueDepth": 0,
"outputRatebps": 0,
"refreshedAt": 0
},
"interfaceStatsCollection": "string",
"interfaceStatsCollectionFailureReason": "string",
"name": "string",
"pathOverlayInfo": [
{
"controlPlane": "string",
"dataPacketEncapsulation": "string",
"destIp": "string",
"destPort": "string",
"protocol": "string",
"sourceIp": "string",
"sourcePort": "string",
"vxlanInfo": {
"dscp": "string",
"vnid": "string"
}
}
],
"qosStatistics": [
{
"classMapName": "string",
"dropRate": 0,
"numBytes": 0,
"numPackets": 0,
"offeredRate": 0,
"queueBandwidthbps": "string",
"queueDepth": 0,
"queueNoBufferDrops": 0,
"queueTotalDrops": 0,
"refreshedAt": 0
}
],
"qosStatsCollection": "string",
"qosStatsCollectionFailureReason": "string",
"usedVlan": "string",
"vrfName": "string"
},
"ingressVirtualInterface": {
"aclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"id": "string",
"interfaceStatistics": {
"adminStatus": "string",
"inputPackets": 0,
"inputQueueCount": 0,
"inputQueueDrops": 0,
"inputQueueFlushes": 0,
"inputQueueMaxDepth": 0,
"inputRatebps": 0,
"operationalStatus": "string",
"outputDrop": 0,
"outputPackets": 0,
"outputQueueCount": 0,
"outputQueueDepth": 0,
"outputRatebps": 0,
"refreshedAt": 0
},
"interfaceStatsCollection": "string",
"interfaceStatsCollectionFailureReason": "string",
"name": "string",
"pathOverlayInfo": [
{
"controlPlane": "string",
"dataPacketEncapsulation": "string",
"destIp": "string",
"destPort": "string",
"protocol": "string",
"sourceIp": "string",
"sourcePort": "string",
"vxlanInfo": {
"dscp": "string",
"vnid": "string"
}
}
],
"qosStatistics": [
{
"classMapName": "string",
"dropRate": 0,
"numBytes": 0,
"numPackets": 0,
"offeredRate": 0,
"queueBandwidthbps": "string",
"queueDepth": 0,
"queueNoBufferDrops": 0,
"queueTotalDrops": 0,
"refreshedAt": 0
}
],
"qosStatsCollection": "string",
"qosStatsCollectionFailureReason": "string",
"usedVlan": "string",
"vrfName": "string"
},
"ip": "string",
"linkInformationSource": "string",
"name": "string",
"perfMonCollection": "string",
"perfMonCollectionFailureReason": "string",
"perfMonStatistics": [
{
"byteRate": 0,
"destIpAddress": "string",
"destPort": "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"
}
],
"networkElementsInfo": [
{
"accuracyList": [
{
"percent": 0,
"reason": "string"
}
],
"detailedStatus": {
"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": {
"aclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"id": "string",
"interfaceStatistics": {
"adminStatus": "string",
"inputPackets": 0,
"inputQueueCount": 0,
"inputQueueDrops": 0,
"inputQueueFlushes": 0,
"inputQueueMaxDepth": 0,
"inputRatebps": 0,
"operationalStatus": "string",
"outputDrop": 0,
"outputPackets": 0,
"outputQueueCount": 0,
"outputQueueDepth": 0,
"outputRatebps": 0,
"refreshedAt": 0
},
"interfaceStatsCollection": "string",
"interfaceStatsCollectionFailureReason": "string",
"name": "string",
"pathOverlayInfo": [
{
"controlPlane": "string",
"dataPacketEncapsulation": "string",
"destIp": "string",
"destPort": "string",
"protocol": "string",
"sourceIp": "string",
"sourcePort": "string",
"vxlanInfo": {
"dscp": "string",
"vnid": "string"
}
}
],
"qosStatistics": [
{
"classMapName": "string",
"dropRate": 0,
"numBytes": 0,
"numPackets": 0,
"offeredRate": 0,
"queueBandwidthbps": "string",
"queueDepth": 0,
"queueNoBufferDrops": 0,
"queueTotalDrops": 0,
"refreshedAt": 0
}
],
"qosStatsCollection": "string",
"qosStatsCollectionFailureReason": "string",
"usedVlan": "string",
"vrfName": "string"
},
"virtualInterface": [
{
"aclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"id": "string",
"interfaceStatistics": {
"adminStatus": "string",
"inputPackets": 0,
"inputQueueCount": 0,
"inputQueueDrops": 0,
"inputQueueFlushes": 0,
"inputQueueMaxDepth": 0,
"inputRatebps": 0,
"operationalStatus": "string",
"outputDrop": 0,
"outputPackets": 0,
"outputQueueCount": 0,
"outputQueueDepth": 0,
"outputRatebps": 0,
"refreshedAt": 0
},
"interfaceStatsCollection": "string",
"interfaceStatsCollectionFailureReason": "string",
"name": "string",
"pathOverlayInfo": [
{
"controlPlane": "string",
"dataPacketEncapsulation": "string",
"destIp": "string",
"destPort": "string",
"protocol": "string",
"sourceIp": "string",
"sourcePort": "string",
"vxlanInfo": {
"dscp": "string",
"vnid": "string"
}
}
],
"qosStatistics": [
{
"classMapName": "string",
"dropRate": 0,
"numBytes": 0,
"numPackets": 0,
"offeredRate": 0,
"queueBandwidthbps": "string",
"queueDepth": 0,
"queueNoBufferDrops": 0,
"queueTotalDrops": 0,
"refreshedAt": 0
}
],
"qosStatsCollection": "string",
"qosStatsCollectionFailureReason": "string",
"usedVlan": "string",
"vrfName": "string"
}
]
},
"flexConnect": {
"authentication": "string",
"dataSwitching": "string",
"egressAclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"ingressAclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"wirelessLanControllerId": "string",
"wirelessLanControllerName": "string"
},
"id": "string",
"ingressInterface": {
"physicalInterface": {
"aclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"id": "string",
"interfaceStatistics": {
"adminStatus": "string",
"inputPackets": 0,
"inputQueueCount": 0,
"inputQueueDrops": 0,
"inputQueueFlushes": 0,
"inputQueueMaxDepth": 0,
"inputRatebps": 0,
"operationalStatus": "string",
"outputDrop": 0,
"outputPackets": 0,
"outputQueueCount": 0,
"outputQueueDepth": 0,
"outputRatebps": 0,
"refreshedAt": 0
},
"interfaceStatsCollection": "string",
"interfaceStatsCollectionFailureReason": "string",
"name": "string",
"pathOverlayInfo": [
{
"controlPlane": "string",
"dataPacketEncapsulation": "string",
"destIp": "string",
"destPort": "string",
"protocol": "string",
"sourceIp": "string",
"sourcePort": "string",
"vxlanInfo": {
"dscp": "string",
"vnid": "string"
}
}
],
"qosStatistics": [
{
"classMapName": "string",
"dropRate": 0,
"numBytes": 0,
"numPackets": 0,
"offeredRate": 0,
"queueBandwidthbps": "string",
"queueDepth": 0,
"queueNoBufferDrops": 0,
"queueTotalDrops": 0,
"refreshedAt": 0
}
],
"qosStatsCollection": "string",
"qosStatsCollectionFailureReason": "string",
"usedVlan": "string",
"vrfName": "string"
},
"virtualInterface": [
{
"aclAnalysis": {
"aclName": "string",
"matchingAces": [
{
"ace": "string",
"matchingPorts": [
{
"ports": [
{
"destPorts": [
"string"
],
"sourcePorts": [
"string"
]
}
],
"protocol": "string"
}
],
"result": "string"
}
],
"result": "string"
},
"id": "string",
"interfaceStatistics": {
"adminStatus": "string",
"inputPackets": 0,
"inputQueueCount": 0,
"inputQueueDrops": 0,
"inputQueueFlushes": 0,
"inputQueueMaxDepth": 0,
"inputRatebps": 0,
"operationalStatus": "string",
"outputDrop": 0,
"outputPackets": 0,
"outputQueueCount": 0,
"outputQueueDepth": 0,
"outputRatebps": 0,
"refreshedAt": 0
},
"interfaceStatsCollection": "string",
"interfaceStatsCollectionFailureReason": "string",
"name": "string",
"pathOverlayInfo": [
{
"controlPlane": "string",
"dataPacketEncapsulation": "string",
"destIp": "string",
"destPort": "string",
"protocol": "string",
"sourceIp": "string",
"sourcePort": "string",
"vxlanInfo": {
"dscp": "string",
"vnid": "string"
}
}
],
"qosStatistics": [
{
"classMapName": "string",
"dropRate": 0,
"numBytes": 0,
"numPackets": 0,
"offeredRate": 0,
"queueBandwidthbps": "string",
"queueDepth": 0,
"queueNoBufferDrops": 0,
"queueTotalDrops": 0,
"refreshedAt": 0
}
],
"qosStatsCollection": "string",
"qosStatsCollectionFailureReason": "string",
"usedVlan": "string",
"vrfName": "string"
}
]
},
"ip": "string",
"linkInformationSource": "string",
"name": "string",
"perfMonCollection": "string",
"perfMonCollectionFailureReason": "string",
"perfMonitorStatistics": [
{
"byteRate": 0,
"destIpAddress": "string",
"destPort": "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"
}
],
"properties": [
"string"
],
"request": {
"controlPath": true,
"createTime": 0,
"destIP": "string",
"destPort": "string",
"failureReason": "string",
"id": "string",
"inclusions": [
"string"
],
"lastUpdateTime": 0,
"periodicRefresh": true,
"protocol": "string",
"sourceIP": "string",
"sourcePort": "string",
"status": "string"
}
},
"version": "string"
}
"""