cisco.dnac.assurance_issue_workflow_manager module – Resource module for managing assurance global profile settings and issue resolution in Cisco Catalyst Center
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_issue_workflow_manager
.
New in cisco.dnac 6.31.0
Synopsis
This module allows the management of assurance global profile settings and issues in Cisco Catalyst Center.
It supports creating, updating, and deleting configurations for issue settings and issue resolution functionalities.
This module interacts with Cisco Catalyst Center’s Assurance settings to configure thresholds, rules, KPIs, and more for issue settings and issue resolution.
The functionality for updating ‘Global and Customized Settings’, including custom profiles site assignment, is currently unavailable due to an API/SDK upgrade. It will be accessible under the ‘Network Assurance Profile Workflow Manager’ once the updated API is released
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.8.6
python >= 3.9
Parameters
Parameter |
Comments |
---|---|
A list of settings and parameters to be applied. It consists of different sub-configurations for managing assurance settings such as issue settings, health score, ICAP settings, issue resolution, and command execution. |
|
Allow to resolve, ignore, or execute commands based on the issue settings assurance in Cisco Catalyst Center. |
|
A filter to select issues based on the device name that is associated with the issue (e.g., `NY-EN-9300.cisco.local`). |
|
A filter to select issues that ended at or before this date and time. The format is “YYYY-MM-DD HH:MM:SS”. |
|
Specifies how long to ignore the issue. The value is a string with a numeric value followed by a time unit suffix. Supported units: - ‘h’ for hours (e.g., ‘1h’ for 1 hour, ‘24h’ for 24 hours). - ‘d’ for days (e.g., ‘3d’ for 3 days, ‘30d’ for 30 days). The range is from ‘1h’ to ‘30d’. The default value is ‘24h’. This parameter is available from Cisco Catalyst Center version 2.3.7.10 onwards. Example valid values: ‘1h’, ‘3d’, ‘24h’. Example invalid values: ‘24’, ‘3days’, ‘h3’, ‘0h’, ‘31d’, ‘2.5h’. Default: |
|
The name of the issue to be processed (either resolved, ignored, or command executed). This field is required when creating or updating an issue. |
|
Defines the action to be taken on the issue. Possible values: resolution: Resolves the issue. ignore: Ignores the issue. command_execution: Executes commands to address the issue. |
|
A filter to select issues based on their status. Acceptable values are: ACTIVE: The issue is currently open. RESOLVED: The issue has been resolved. IGNORED: The issue has been ignored. type: str required: false |
|
A filter to select issues based on the MAC address of the device associated with the issue. |
|
A filter to select issues based on the network device’s IP address associated with the issue. |
|
A filter to select issues based on their priority. Acceptable values are: - P1 (Highest Priority) - P2 - P3 - P4 (Lowest Priority) type: str required: false |
|
A filter to select issues based on the site location hierarchy. The format is “Global/Region/Location/Building”, where each level is separated by a slash. |
|
A filter to select issues that started at or after this date and time. The format is “YYYY-MM-DD HH:MM:SS”. |
|
Manages system issue settings for assurance in Cisco Catalyst Center. |
|
Provides a detailed explanation of the system issue setting, including the specific threshold fields that require updates for the defined issue names. This field is essential for understanding which parameters need adjustment to align with the current system configurations and alerting criteria. |
|
Specifies the type of device to which the issue configuration applies. For example, choices: - ROUTER - SWITCH_AND_HUB - UNIFIED_AP - WIRELESS_CLIENT - WIRED_CLIENT - WIRELESS_CONTROLLER - THIRD_PARTY_DEVICE - APPLICATION - SENSOR |
|
A boolean value that determines whether the issue is enabled or disabled. Accepts “true” or “false”. Choices:
|
|
The name of the system issue setting, used to identify the configuration in the system. Required when creating or updating an issue setting. |
|
Specifies the priority level of the issue. Choices:
|
|
A boolean value indicating whether the system issue should be synchronized to the health threshold. Accepts “true” or “false”. Choices:
|
|
The threshold value that triggers the issue. This is usually specified as a percentage or a numerical value depending on the nature of the issue. For example, for the issue “Wireless client exhibiting sticky behavior,” the threshold could be a maximum RSSI value (e.g., -70 dBm). Similarly, for a “WLC Memory High Utilization”, a threshold like 90% can be used. - **Percentage-based thresholds**: Must not exceed 100%. - **dBm (decibel-milliwatts) thresholds**: Must not exceed 0 dBm, meaning it should be a negative value. |
|
Configures user-defined issue settings for assurance in Cisco Catalyst Center. Allows defining issue names, descriptions, severity, priority, and rules governing network issues. |
|
A brief explanation of the issue for clarity in reports and dashboards. |
|
Enables or disables the issue setting. Choices:
|
|
Boolean value to specify if notifications for this issue setting should be enabled. Choices:
|
|
The name of the issue setting, used for identification in the system. Required when creating a new setting or updating an existing one. |
|
The previous name of the issue setting (used when updating an existing issue setting). |
|
Specifies the priority of the issue. Choices:
|
|
A set of rules that define the parameters for triggering the issue. Includes severity, facility, mnemonic, pattern, occurrences, and duration. |
|
The duration, in minutes, for which the issue pattern must persist to be considered valid. |
|
The facility type that the rule applies to. Choices:
|
|
A system-generated identifier or label representing the issue. Choices:
|
|
The number of times the issue pattern must occur before triggering the issue. |
|
A pattern or regular expression defining the issue detection criteria. |
|
Specifies the severity level of the issue. The severity value can be an integer (0 to 6) or its corresponding string representation. Choices:
|
|
Set to `true` to enable configuration verification on Cisco Catalyst Center after applying the playbook config. This will ensure that the system validates the configuration state after the change is applied. 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: |
|
Specifies the desired state for the configuration. If `merged`, the module will create or update the configuration, adding new settings or modifying existing ones. If `deleted`, it will remove the specified settings. Choices:
|
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Methods used are issues.AssuranceSettings.get_all_the_custom_issue_definitions_based_on_the_given_filters issues.AssuranceSettings.creates_a_new_user_defined_issue_definitions issues.AssuranceSettings.deletes_an_existing_custom_issue_definition issues.AssuranceSettings.resolve_the_given_lists_of_issues issues.AssuranceSettings.ignore_the_given_list_of_issues issues.AssuranceSettings.execute_suggested_action_commands
Paths used are POST /dna/intent/api/api/v1/customIssueDefinitions POST /dna/intent/api/v1/assuranceIssues/resolve POST /dna/intent/api/v1/execute-suggested-actions-commands POST /dna/intent/api/v1/assuranceIssues/ignore POST /dna/intent/api/v1/flow-analysis/${flowAnalysisId} POST /dna/intent/api/v1/flow-analysis PUT /dna/intent/api/v1/systemIssueDefinitions/${id} DELETE /dna/intent/api/v1/flow-analysis/{flowAnalysisId} DELETE /dna/intent/api/v1/customIssueDefinitions/{id}
Does not support
check_mode
The 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: Create issue settings
cisco.dnac.assurance_issue_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_user_defined_issue_settings:
- name: High CPU Usage Alert
description: Triggers an alert when
CPU usage exceeds threshold
rules:
- severity: Warning
facility: redundancy
mnemonic: peer monitor event
pattern: issue test
occurrences: 1
duration_in_minutes: 2
is_enabled: false
priority: P1
is_notification_enabled: false
- name: update issue settings
cisco.dnac.assurance_issue_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_user_defined_issue_settings:
- prev_name: High CPU Usage Alert
name: Excessive CPU Utilization Alert
description: testing
rules:
- severity: "2"
facility: redundancy
mnemonic: peer monitor event
pattern: issue test
occurrences: 1
duration_in_minutes: 2
is_enabled: false
priority: P1
is_notification_enabled: false
- name: Delete issue settings
cisco.dnac.assurance_issue_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_level: DEBUG
dnac_log: true
state: deleted
config_verify: true
config:
- assurance_user_defined_issue_settings:
- name: High CPU Usage Alert
- hosts: dnac_servers
vars_files:
- credentials.yml
gather_facts: false
connection: local
tasks:
- name: Update System issue
cisco.dnac.assurance_issue_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_system_issue_settings:
- name: "Assurance telemetry status is
poor"
description: RF Noise (5GHz)
device_type: WIRED_CLIENT
synchronize_to_health_threshold: true
priority: P1
issue_enabled: false
threshold_value: -10
- hosts: dnac_servers
vars_files:
- credentials.yml
gather_facts: false
connection: local
tasks:
- name: Resolving Issues
cisco.dnac.assurance_issue_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_issue:
- issue_name: Fabric BGP session status
is down with Peer Device # required field
issue_process_type: resolution # required field
start_datetime: "2024-12-11 16:00:00" # optional field
end_datetime: "2024-12-11 18:30:00" # optional field
site_hierarchy: Global/USA/San Jose/BLDG23 # optional field
device_name: NY-EN-9300.cisco.local # optional field
priority: P4 # optional field
issue_status: ACTIVE # optional field
mac_address: e4:38:7e:42:bc:40 # optional field
network_device_ip_address: 204.1.2.4 # optional field
- name: Ignoring issues
cisco.dnac.assurance_issue_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_issue:
- issue_name: Fabric BGP session status
is down with Peer Device # required field
issue_process_type: ignore # required field
ignore_duration: 4h
start_datetime: "2024-12-11 16:00:00" # optional field
end_datetime: "2024-12-11 18:30:00" # optional field
site_hierarchy: Global/USA/San Jose/BLDG23 # optional field
device_name: NY-EN-9300.cisco.local # optional field
priority: P4 # optional field
issue_status: ACTIVE # optional field
mac_address: e4:38:7e:42:bc:40 # optional field
network_device_ip_address: 204.1.2.4 # optional field
- name: Execute suggested commands
cisco.dnac.assurance_issue_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_issue:
- issue_name: Fabric BGP session status
is down with Peer Device # required field
issue_process_type: command_execution # required field
start_datetime: "2024-12-11 16:00:00" # optional field
end_datetime: "2024-12-11 18:30:00" # optional field
site_hierarchy: Global/USA/San Jose/BLDG23 # optional field
device_name: NY-EN-9300.cisco.local # optional field
priority: P4 # optional field
issue_status: ACTIVE # optional field
mac_address: e4:38:7e:42:bc:40 # optional field
network_device_ip_address: 204.1.2.4 # optional field
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The response object containing execution details of suggested action commands. Returned: always Sample: |
|
Details of the response returned by the assurance settings create API. Returned: always Sample: |
|
The response after ignoring issues in Cisco Catalyst Center. Returned: always Sample: |
|
The response after resolving issues in Cisco Catalyst Center. Returned: always Sample: |
|
Details of the response returned by the assurance settings update API. Returned: always Sample: |
|
The response object containing detailed information about the issue or configuration. Returned: always Sample: |