cisco.catalystcenter.path_traces module -- Resource module for Path Traces

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.

New in cisco.catalystcenter 2.11.0

Synopsis

  • Manage operations create and delete of the resource Path Traces.

  • Initiates a new path trace with periodic refresh and stat collection options.

  • Deletes a path trace request 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

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

controlPath

boolean

Indicates whether to perform control path tracing. Control path traces follow routing table decisions rather than data path forwarding decisions. | Value | Description | | ----- | ----------- | | true | Trace control path | | false | Trace data path (default) |.

Choices:

destinationIpAddress

string

Destination IP address for the path trace. Format can be IPv4 (e.g., 192.168.1.1) or IPv6.

destinationMacAddress

string

Destination MAC address for the path trace. Format should be XX XX XX XX XX XX (e.g., 00 1A 2B 3C 4D 5E).

destinationPort

string

Destination port for the path trace. Must be between 1-65535.

id

string

Id path parameter. Unique identifier for the path trace request to be deleted.

inclusions

list / elements=string

Additional data to include in the path trace results. | Value | Description | | ----- | ----------- | | INTERFACE_STATS | Include interface statistics (throughput, utilization) | | QOS_STATS | Include Quality of Service statistics | | DEVICE_STATS | Include device statistics (CPU, memory) | | PERFORMANCE_STATS | Include performance statistics | | ACL_TRACE | Include Access Control List trace information |.

periodicRefresh

boolean

Indicates whether to periodically refresh the path trace. | Value | Description | | ----- | ----------- | | true | Refresh the path trace every 30 seconds | | false | Perform the path trace once (default) |.

Choices:

protocol

string

Network protocol to use for the path trace. | Value | Description | | ----- | ----------- | | TCP | Transmission Control Protocol | | UDP | User Datagram Protocol | | (blank) | Check both TCP and UDP |.

sourceIpAddress

string

Source IP address for the path trace. Format can be IPv4 (e.g., 192.168.1.1) or IPv6.

sourceMacAddress

string

Source MAC address for the path trace. Format should be XX XX XX XX XX XX (e.g., 00 1A 2B 3C 4D 5E).

sourcePort

string

Source port for the path trace. Must be between 1-65535.

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.deletes_path_trace_by_id, path_trace.PathTrace.initiate_a_new_path_trace,

  • Paths used are post /dna/intent/api/v1/pathTraces, delete /dna/intent/api/v1/pathTraces/{id},

  • Does not support 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 InitiateANewPathTrace

Complete reference of the InitiateANewPathTrace API.

Cisco Catalyst Center documentation for Path Trace DeletesPathTraceByID

Complete reference of the DeletesPathTraceByID API.

Examples

---
- name: Delete by id
  cisco.catalystcenter.path_traces:
    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}}"
    state: absent
    id: string
- name: Create
  cisco.catalystcenter.path_traces:
    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}}"
    state: present
    controlPath: true
    destinationIpAddress: string
    destinationMacAddress: string
    destinationPort: string
    inclusions:
      - string
    periodicRefresh: true
    protocol: string
    sourceIpAddress: string
    sourceMacAddress: string
    sourcePort: string

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": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)