cisco.dnac.path_trace_info – Information module for Path Trace

Note

This plugin is part of the cisco.dnac collection (version 3.1.2).

To install it use: ansible-galaxy collection install cisco.dnac.

To use it in a playbook, specify: cisco.dnac.path_trace_info.

New in version 1.0.0: of cisco.dnac

Synopsis

  • Get all Path Trace.

  • Get Path Trace by id.

Note

This module has a corresponding action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • dnacentersdk

Parameters

Parameter Choices/Defaults Comments
destIP
string
DestIP query parameter. Destination IP adress.
destPort
string
DestPort query parameter. Destination port.
flowAnalysisId
string
FlowAnalysisId path parameter. Flow analysis request id.
gtCreateTime
string
GtCreateTime query parameter. Analyses requested after this time.
headers
dictionary
Additional headers.
lastUpdateTime
string
LastUpdateTime query parameter. Last update time.
limit
string
Limit query parameter. Number of resources returned.
ltCreateTime
string
LtCreateTime query parameter. Analyses requested before this time.
offset
string
Offset query parameter. Start index of resources returned (1-based).
order
string
Order query parameter. Order by this field.
periodicRefresh
boolean
    Choices:
  • no
  • yes
PeriodicRefresh query parameter. Is analysis periodically refreshed?.
protocol
string
Protocol query parameter.
sortBy
string
SortBy query parameter. Sort by this field.
sourceIP
string
SourceIP query parameter. Source IP address.
sourcePort
string
SourcePort query parameter. Source port.
status
string
Status query parameter.
taskId
string
TaskId query parameter. Task ID.

See Also

See also

Path Trace reference

Complete reference of the Path Trace object model.

Examples

- 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:
      custom: value
    periodicRefresh: True
    sourceIP: string
    destIP: string
    sourcePort: string
    destPort: string
    gtCreateTime: string
    ltCreateTime: string
    protocol: string
    status: string
    taskId: string
    lastUpdateTime: string
    limit: string
    offset: string
    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:
      custom: value
    flowAnalysisId: string
  register: result

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
dnac_response
dictionary
always
A dictionary or list with the response returned by the Cisco DNAC Python SDK

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" }


Authors

  • Rafael Campos (@racampos)