cisco.catalystcenter.path_trace module -- Resource module for Path Trace

Note

This module is part of the cisco.catalystcenter collection (version 2.2.1).

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

New in cisco.catalystcenter 3.1.0

Synopsis

• Manage operations create and delete of the resource Path Trace. - > Initiates a new flow analysis with periodic refresh and stat collection options. Returns a request id and a task id to get results and follow progress.

• Deletes a flow analysis 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.1.3.0.0

• python >= 3.5

Parameters

Parameter	Comments
catc_api_port integer	The Cisco Catalyst Center port. Default: :ansible-option-default:`443`
catc_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
catc_host string / required	The Cisco Catalyst Center hostname.
catc_password string	The Cisco Catalyst Center password to authenticate.
catc_username string	The Cisco Catalyst Center username to authenticate. Default: :ansible-option-default:`"admin"`
catc_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
catc_version string	Informs the SDK which version of Cisco Catalyst Center to use. Default: :ansible-option-default:`"2.3.7.6"`
controlPath boolean	Control path tracing. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
destIP string	Destination IP address.
destPort string	Destination Port, range 1-65535.
flowAnalysisId string	FlowAnalysisId path parameter. Flow analysis request id.
inclusions list / elements=string	Subset of {INTERFACE-STATS, QOS-STATS, DEVICE-STATS, PERFORMANCE-STATS, ACL-TRACE}.
periodicRefresh boolean	Periodic refresh of path for every 30 sec. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
protocol string	Protocol - one of TCP, UDP - checks both when left blank.
sourceIP string	Source IP address.
sourcePort string	Source Port, range 1-65535.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)

Notes

Note

• SDK Method used are path_trace.PathTrace.deletes_pathtrace_by_id, path_trace.PathTrace.initiate_a_new_pathtrace,

• Paths used are post /dna/intent/api/v1/flow-analysis, delete /dna/intent/api/v1/flow-analysis/{flowAnalysisId},

• 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

See Also

See also

Cisco DNA Center documentation for Path Trace InitiateANewPathtrace

Complete reference of the InitiateANewPathtrace API.

Cisco DNA Center documentation for Path Trace DeletesPathtraceById

Complete reference of the DeletesPathtraceById API.

Examples

---
- name: Create
  cisco.catalystcenter.path_trace:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: present
    controlPath: true
    destIP: string
    destPort: string
    inclusions:
      - string
    periodicRefresh: true
    protocol: string
    sourceIP: string
    sourcePort: string
- name: Delete by id
  cisco.catalystcenter.path_trace:
    catc_host: "{{catc_host}}"
    catc_username: "{{catc_username}}"
    catc_password: "{{catc_password}}"
    catc_verify: "{{catc_verify}}"
    catc_api_port: "{{catc_api_port}}"
    catc_version: "{{catc_version}}"
    catc_debug: "{{catc_debug}}"
    state: absent
    flowAnalysisId: string

Return Values

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

Key	Description
dnac_response dictionary	A dictionary or list with the response returned by the Cisco CATALYST Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"response": {"flowAnalysisId": "string", "taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Rafael Campos (@racampos)

Collection links

Issue Tracker Repository (Sources)