cisco.catalystcenter.path_traces_count_info module -- Information module for Path Traces Count

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_count_info.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Get all Path Traces Count.

  • Returns the count of path traces that match the specified filter 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

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

destinationIpAddress

string

DestinationIpAddress query parameter. Destination IP address used in the path trace. Format can be IPv4 (e.g., 192.168.1.1) or IPv6.

destinationMacAddress

string

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

float

DestinationPort query parameter. Destination port used in the path trace. Valid range is 1-65535.

greaterThanCreateTime

float

GreaterThanCreateTime query parameter. Retrieves analyses requested after this time. Value is in epoch milliseconds.

headers

dictionary

Additional headers.

lastUpdateTime

float

LastUpdateTime query parameter. Retrieves analyses that were last updated at this time. Value is in epoch milliseconds.

lessThanCreateTime

float

LessThanCreateTime query parameter. Retrieves analyses requested before this time. Value is in epoch milliseconds.

periodicRefresh

boolean

PeriodicRefresh query parameter. Indicates whether the analysis is periodically refreshed. | false | Analysis is performed once |.

Choices:

protocol

string

Protocol query parameter. Protocol used in the path trace. | UDP | User Datagram Protocol |.

sourceIpAddress

string

SourceIpAddress query parameter. Source IP address used in the path trace. Format can be IPv4 (e.g., 192.168.1.1) or IPv6.

sourceMacAddress

string

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

float

SourcePort query parameter. Source port used in the path trace. Valid range is 1-65535.

status

string

Status query parameter. Status of the path trace. | SCHEDULED | Path trace is scheduled to run | | PENDING | Path trace is pending execution | | COMPLETED | Path trace has completed |.

validate_response_schema

boolean

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_count_of_path_traces_matching_filter_criteria,

  • Paths used are get /dna/intent/api/v1/pathTraces/count,

  • Supports 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)

See Also

See also

Cisco Catalyst Center documentation for Path Trace RetrievesTheCountOfPathTracesMatchingFilterCriteria

Complete reference of the RetrievesTheCountOfPathTracesMatchingFilterCriteria API.

Examples

---
- name: Get all Path Traces Count
  cisco.catalystcenter.path_traces_count_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
  register: result

Return Values

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

Key

Description

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {"count": 0}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)