cisco.dnac.assurance_icap_settings_workflow_manager module – Configure and manage ICAP (Intelligent Capture) settings in Cisco Catalyst Center for network assurance.
Note
This module is part of the cisco.dnac collection (version 6.39.0).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install cisco.dnac.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: cisco.dnac.assurance_icap_settings_workflow_manager.
New in cisco.dnac 6.31.0
Synopsis
Automates the configuration and management of Intelligent Capture (ICAP) settings in Cisco Catalyst Center.
ICAP enables real-time packet capture and analysis for troubleshooting client and network device connectivity issues.
Supports capturing traffic based on parameters such as capture type, client MAC, AP, WLC, slot, OTA band, and channel.
Facilitates automated deployment and validation of ICAP configurations.
Supports downloading PCAP files for further analysis of captured network traffic.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.8.6
python >= 3.9
Parameters
Parameter |
Comments |
|---|---|
List of parameters required to configure, create, and deploy ICAP settings in Cisco Catalyst Center. |
|
Defines settings for downloading Intelligent Capture (ICAP) data. Used to configure the parameters for capturing client data during a specific timeframe. |
|
The Ap mac address of the AP for which the capture will be performed through. |
|
The type of ICAP session to be executed. Choices:
|
|
The MAC address of the client device for which the capture is being performed. |
|
The end date and time of the ICAP session in the format ‘YYYY-MM-DD HH:MM:SS’. (24-hour format, for example, ‘2025-07-21 18:07:49’ for 6:07:49 PM). |
|
The file system path where the captured data will be saved. |
|
The start date and time of the ICAP session in the format ‘YYYY-MM-DD HH:MM:SS’. (24-hour format, for example, ‘2025-07-21 17:42:58’ for 5:42:58 PM). |
|
Defines ICAP settings for capturing client and network device information. Used for onboarding, monitoring, and troubleshooting network connectivity issues. |
|
The name of the Access Point (AP) for the capture. |
|
The type of Intelligent Capture to be performed (e.g., onboarding). Choices:
|
|
The MAC address of the client device for which the capture is being performed. |
|
The duration of the Intelligent Capture session in minutes. |
|
Specifies the wireless frequency band for the ICAP capture. Ensure the selected band is valid for the region and device capabilities. Choices:
|
|
Wireless channel used for the ICAP capture (For example, 36, 40). Available channels depend on the selected `ota_band` and regulatory restrictions. |
|
Specifies the channel width in MHz for the ICAP capture (For example, 20, 40). Ensure compatibility with the selected `ota_band` and regulatory requirements. |
|
A short summary or metadata about the Intelligent Capture session, providing details such as purpose, expected outcomes, or session context. |
|
List of slot numbers for the capture session. |
|
The name of the Wireless LAN Controller (WLC) involved in the Intelligent Capture. |
|
Set to ‘true’ to verify the ICAP configuration on Cisco Catalyst Center after deployment. Choices:
|
|
Defines the timeout in seconds for API calls to retrieve task details. If the task details are not received within this period, the process will end, and a timeout notification will be logged. Default: |
|
Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. Choices:
|
|
The hostname of the Cisco Catalyst Center. |
|
Flag to enable/disable playbook execution logging. When true and dnac_log_file_path is provided, - Create the log file at the execution location with the specified name. When true and dnac_log_file_path is not provided, - Create the log file at the execution location with the name ‘dnac.log’. When false, - Logging is disabled. If the log file doesn’t exist, - It is created in append or write mode based on the “dnac_log_append” flag. If the log file exists, - It is overwritten or appended based on the “dnac_log_append” flag. Choices:
|
|
Determines the mode of the file. Set to True for ‘append’ mode. Set to False for ‘write’ mode. Choices:
|
|
Governs logging. Logs are recorded if dnac_log is True. If path is not specified, - When ‘dnac_log_append’ is True, ‘dnac.log’ is generated in the current Ansible directory; logs are appended. - When ‘dnac_log_append’ is False, ‘dnac.log’ is generated; logs are overwritten. If path is specified, - When ‘dnac_log_append’ is True, the file opens in append mode. - When ‘dnac_log_append’ is False, the file opens in write (w) mode. - In shared file scenarios, without append mode, content is overwritten after each module execution. - For a shared log file, set append to False for the 1st module (to overwrite); for subsequent modules, set append to True. Default: |
|
Sets the threshold for log level. Messages with a level equal to or higher than this will be logged. Levels are listed in order of severity [CRITICAL, ERROR, WARNING, INFO, DEBUG]. CRITICAL indicates serious errors halting the program. Displays only CRITICAL messages. ERROR indicates problems preventing a function. Displays ERROR and CRITICAL messages. WARNING indicates potential future issues. Displays WARNING, ERROR, CRITICAL messages. INFO tracks normal operation. Displays INFO, WARNING, ERROR, CRITICAL messages. DEBUG provides detailed diagnostic info. Displays all log messages. Default: |
|
The password for authentication at the Cisco Catalyst Center. |
|
Specifies the port number associated with the Cisco Catalyst Center. Default: |
|
Specifies the interval in seconds between successive calls to the API to retrieve task details. Default: |
|
The username for authentication at the Cisco Catalyst Center. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: |
|
The state of Cisco Catalyst Center after module completion. Choices:
|
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are sensors.AssuranceSettings.get_device_deployment_status, sensors.AssuranceSettings.creates_an_icap_configuration_intent_for_preview_approve, sensors.AssuranceSettings.discards_the_icap_configuration_intent_by_activity_id sensors.AssuranceSettings.deploys_the_i_cap_configuration_intent_by_activity_id sensors.AssuranceSettings.lists_i_cap_packet_capture_files_matching_specified_criteria sensors.AssuranceSettings.downloads_a_specific_i_cap_packet_capture_file
Paths used are GET /dna/intent/api/v1/icapSettings/deviceDeployments POST /dna/intent/api/icapSettings/configurationModels DELETE /dna/intent/api/v1/icapSettings/configurationModels/{previewActivityId} POST /dna/intent/api/v1/icapSettings/configurationModels/{previewActivityId}/deploy GET /dna/data/api/v1/icap/captureFiles GET /dna/data/api/v1/icap/captureFiles/${id}/download
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins instead embedded connection manager from Cisco Catalyst Center SDK
The parameters starting with dnac_ are used by the Cisco Catalyst Center Python SDK to establish the connection
Examples
---
- hosts: dnac_servers
vars_files:
- credentials.yml
gather_facts: false
connection: local
tasks:
- name: Configure ICAP on Cisco Catalyst Center
cisco.dnac.assurance_icap_settings_workflow_manager:
dnac_host: "{{ dnac_host }}"
dnac_port: "{{ dnac_port }}"
dnac_username: "{{ dnac_username }}"
dnac_password: "{{ dnac_password }}"
dnac_verify: "{{ dnac_verify }}"
dnac_debug: "{{ dnac_debug }}"
dnac_version: "{{ dnac_version }}"
dnac_log: true
dnac_log_level: debug
dnac_log_append: true
state: merged
config_verify: true
config:
- assurance_icap_settings:
- capture_type: ONBOARDING
preview_description: "ICAP onboarding
capture"
duration_in_mins: 30
client_mac: 50:91:E3:47:AC:9E # required field
wlc_name: NY-IAC-EWLC.cisco.local # required field
- capture_type: FULL
preview_description: "Full ICAP capture
for troubleshooting"
duration_in_mins: 30
client_mac: 50:91:E3:47:AC:9E # required field
wlc_name: NY-IAC-EWLC.cisco.local # required field
- hosts: dnac_servers
vars_files:
- credentials.yml
gather_facts: false
connection: local
tasks:
- name: Download ICAP on Cisco Catalyst Center
cisco.dnac.assurance_icap_settings_workflow_manager:
dnac_host: "{{ dnac_host }}"
dnac_port: "{{ dnac_port }}"
dnac_username: "{{ dnac_username }}"
dnac_password: "{{ dnac_password }}"
dnac_verify: "{{ dnac_verify }}"
dnac_debug: "{{ dnac_debug }}"
dnac_version: "{{ dnac_version }}"
dnac_log: true
dnac_log_level: debug
dnac_log_append: true
state: merged
config_verify: true
config:
- assurance_icap_download:
- capture_type: FULL
client_mac: 50:91:E3:47:AC:9E
start_time: "2025-03-05 11:56:00"
end_time: "2025-03-05 12:01:00"
file_path: /Users/senorpink/Documents
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: |