cisco.dnac.flow_analysis – Manage FlowAnalysis objects of PathTrace

Note

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

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

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

New in version 1.0.0: of cisco.dnac

Synopsis

• Returns a summary of all flow analyses stored. Results can be filtered by specified parameters.

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

• Returns result of a previously requested flow analysis by its Flow Analysis id.

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

• dnacentersdk

Parameters

Parameter	Choices/Defaults	Comments
controlPath boolean	Choices: no yes	FlowAnalysisRequest's controlPath.
dest_ip string		Destination IP address.
dest_port string		Destination port.
destIP string		FlowAnalysisRequest's destIP. Required for state create.
destPort string		FlowAnalysisRequest's destPort.
flow_analysis_id string / required		Flow analysis request id.
gt_create_time string		Analyses requested after this time.
inclusions list / elements=string		FlowAnalysisRequest's inclusions (list of strings).
last_update_time string		Last update time.
limit string		Number of resources returned.
lt_create_time string		Analyses requested before this time.
offset string		Start index of resources returned (1-based).
order string		Order by this field.
periodic_refresh boolean	Choices: no yes	Is analysis periodically refreshed?.
periodicRefresh boolean	Choices: no yes	FlowAnalysisRequest's periodicRefresh.
protocol string		Protocol query parameter. FlowAnalysisRequest's protocol.
sort_by string		Sort by this field.
source_ip string		Source IP address.
source_port string		Source port.
sourceIP string		FlowAnalysisRequest's sourceIP. Required for state create.
sourcePort string		FlowAnalysisRequest's sourcePort.
status string		Status query parameter.
task_id string		Task ID.

See Also

See also

cisco.dnac.plugins.module_utils.definitions.flow_analysis

The official documentation on the cisco.dnac.plugins.module_utils.definitions.flow_analysis module.

FlowAnalysis reference

Complete reference of the FlowAnalysis object model.

FlowAnalysis reference

SDK reference.

Examples

- name: retrives_all_previous_pathtraces_summary
  cisco.dnac.flow_analysis:
    state: query  # required
    dest_ip: SomeValue  # string
    dest_port: SomeValue  # string
    gt_create_time: SomeValue  # string
    last_update_time: SomeValue  # string
    limit: SomeValue  # string
    lt_create_time: SomeValue  # string
    offset: SomeValue  # string
    order: SomeValue  # string
    periodic_refresh: True  # boolean
    protocol: SomeValue  # string
    sort_by: SomeValue  # string
    source_ip: SomeValue  # string
    source_port: SomeValue  # string
    status: SomeValue  # string
    task_id: SomeValue  # string
  register: nm_retrives_all_previous_pathtraces_summary

- name: initiate_a_new_pathtrace
  cisco.dnac.flow_analysis:
    state: create  # required
    destIP: SomeValue  # string, required
    sourceIP: SomeValue  # string, required
    controlPath: True  # boolean
    destPort: SomeValue  # string
    inclusions:
    - SomeValue  # string
    periodicRefresh: True  # boolean
    protocol: SomeValue  # string
    sourcePort: SomeValue  # string

- name: retrieves_previous_pathtrace
  cisco.dnac.flow_analysis:
    state: query  # required
    flow_analysis_id: SomeValue  # string, required
  register: nm_retrieves_previous_pathtrace

- name: deletes_pathtrace_by_id
  cisco.dnac.flow_analysis:
    state: delete  # required
    flow_analysis_id: SomeValue  # string, required

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 with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: path_trace.deletes_pathtrace_by_id

Authors

• Rafael Campos (@racampos)