.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.path_traces_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.path_traces module -- Resource module for Path Traces ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.12.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.path_traces`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.11.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.path_traces_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-controlpath: .. rst-class:: ansible-option-title **controlPath** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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) |. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-destinationipaddress: .. rst-class:: ansible-option-title **destinationIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Destination IP address for the path trace. Format can be IPv4 (e.g., 192.168.1.1) or IPv6. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-destinationmacaddress: .. rst-class:: ansible-option-title **destinationMacAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Destination MAC address for the path trace. Format should be XX XX XX XX XX XX (e.g., 00 1A 2B 3C 4D 5E). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-destinationport: .. rst-class:: ansible-option-title **destinationPort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Destination port for the path trace. Must be between 1-65535. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Id path parameter. Unique identifier for the path trace request to be deleted. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-inclusions: .. rst-class:: ansible-option-title **inclusions** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
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 |. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-periodicrefresh: .. rst-class:: ansible-option-title **periodicRefresh** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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) |. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-protocol: .. rst-class:: ansible-option-title **protocol** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Network protocol to use for the path trace. | Value | Description | | ----- | ----------- | | TCP | Transmission Control Protocol | | UDP | User Datagram Protocol | | (blank) | Check both TCP and UDP |. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-sourceipaddress: .. rst-class:: ansible-option-title **sourceIpAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Source IP address for the path trace. Format can be IPv4 (e.g., 192.168.1.1) or IPv6. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-sourcemacaddress: .. rst-class:: ansible-option-title **sourceMacAddress** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Source MAC address for the path trace. Format should be XX XX XX XX XX XX (e.g., 00 1A 2B 3C 4D 5E). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-sourceport: .. rst-class:: ansible-option-title **sourcePort** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Source port for the path trace. Must be between 1-65535. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes 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 \ :literal:`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) .. Seealso See Also -------- .. seealso:: `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 Examples -------- .. code-block:: yaml+jinja --- - 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 .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.path_traces_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors