cisco.dnac.path_trace – Resource module for Path Trace

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

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

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
controlPath boolean	Choices: no yes	ControlPath flag.
destIP string		Path Trace's destIP.
destPort string		Path Trace's destPort.
flowAnalysisId string		FlowAnalysisId path parameter. Flow analysis request id.
inclusions list / elements=string		Path Trace's inclusions.
periodicRefresh boolean	Choices: no yes	PeriodicRefresh flag.
protocol string		Path Trace's protocol.
sourceIP string		Path Trace's sourceIP.
sourcePort string		Path Trace's sourcePort.

See Also

See also

Path Trace reference

Complete reference of the Path Trace object model.

Examples

- name: Create
  cisco.dnac.path_trace:
    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}}"
    state: present
    controlPath: true
    destIP: string
    destPort: string
    inclusions:
    - string
    periodicRefresh: true
    protocol: string
    sourceIP: string
    sourcePort: string

- name: Delete by id
  cisco.dnac.path_trace:
    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}}"
    state: absent
    flowAnalysisId: string

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

Authors

• Rafael Campos (@racampos)