cisco.dnac.assurance_issue_playbook_config_generator module -- Generate YAML playbook for 'assurance_issue_workflow_manager' module.

Note

This module is part of the cisco.dnac collection (version 6.49.0).

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

New in cisco.dnac 6.45.0

Synopsis

• Generates YAML configurations compatible with the `assurance_issue_workflow_manager` module, reducing the effort required to manually create Ansible playbooks and enabling programmatic modifications.

• The YAML configurations generated represent the user-defined issue definitions configured on the Cisco Catalyst Center.

• Supports extraction of User-Defined Issue Definitions configurations.

Requirements

The below requirements are needed on the host that executes this module.

• dnacentersdk >= 2.10.10

• python >= 3.9

Parameters

Parameter	Comments
config dictionary	A dictionary of filters for generating YAML playbook compatible with the `assurance_issue_workflow_manager` module. Filters specify which components to include in the YAML configuration file. If config is provided, component_specific_filters is mandatory. If config is omitted, internal auto-discovery mode is used.
component_specific_filters dictionary / required	Filters to specify which assurance issue components and features to include in the YAML configuration file. Allows granular selection of specific components and their parameters.
assurance_user_defined_issue_settings list / elements=dictionary	User-defined issue settings to filter by issue name or enabled status.
is_enabled boolean	Filter by enabled status (true/false). Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
name string	User-defined issue name to filter by name.
components_list list / elements=string	List of components to include in the YAML configuration file. Valid values are ["assurance_user_defined_issue_settings"] If not specified, all supported components are included. Example ["assurance_user_defined_issue_settings"] Choices: :ansible-option-choices-entry:`"assurance\_user\_defined\_issue\_settings"`
dnac_api_task_timeout integer	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: :ansible-option-default:`1200`
dnac_debug boolean	Indicates whether debugging is enabled in the Cisco Catalyst Center SDK. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_host string / required	The hostname of the Cisco Catalyst Center.
dnac_log boolean	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: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
dnac_log_append boolean	Determines the mode of the file. Set to True for 'append' mode. Set to False for 'write' mode. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_log_file_path string	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: :ansible-option-default:`"dnac.log"`
dnac_log_level string	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: :ansible-option-default:`"WARNING"`
dnac_password string	The password for authentication at the Cisco Catalyst Center.
dnac_port string	Specifies the port number associated with the Cisco Catalyst Center. Default: :ansible-option-default:`"443"`
dnac_task_poll_interval integer	Specifies the interval in seconds between successive calls to the API to retrieve task details. Default: :ansible-option-default:`2`
dnac_username aliases: user string	The username for authentication at the Cisco Catalyst Center. Default: :ansible-option-default:`"admin"`
dnac_verify boolean	Flag to enable or disable SSL certificate verification. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
dnac_version string	Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: :ansible-option-default:`"2.2.3.3"`
file_mode string	Determines how the output YAML configuration file is written. Relevant only when file_path is provided. When set to overwrite, the file will be replaced with new content. When set to append, new content will be added to the existing file. Choices: :ansible-option-choices-entry-default:`"overwrite"` ← (default) :ansible-option-choices-entry:`"append"`
file_path string	Absolute or relative path for the output YAML configuration file. If not specified, a timestamped filename is auto-generated in the format assurance_issue_playbook_config_<YYYY-MM-DD_HH-MM-SS>.yml. Parent directories are created automatically if they do not exist.
state string	The desired state of Cisco Catalyst Center after module execution. Choices: :ansible-option-choices-entry-default:`"gathered"` ← (default)
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 Methods used are - issues.AssuranceSettings.get_all_the_custom_issue_definitions_based_on_the_given_filters

• Paths used are - GET /dna/intent/api/v1/customIssueDefinitions

• 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

# Example 3: Generate YAML Configuration with default file path for all user-defined issues
- name: Generate YAML Configuration for user-defined issues
  cisco.dnac.assurance_issue_playbook_config_generator:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: gathered

# Example 3: Filter by specific issue name
- name: Generate YAML for specific issue by name
  cisco.dnac.assurance_issue_playbook_config_generator:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: gathered
    file_path: "/tmp/high_cpu_issue.yml"
    file_mode: "overwrite"
    config:
      component_specific_filters:
        assurance_user_defined_issue_settings:
          - name: "High CPU Usage"

# Example 4: Filter by enabled status
- name: Generate YAML for only enabled issues
  cisco.dnac.assurance_issue_playbook_config_generator:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: gathered
    file_path: "/tmp/enabled_issues.yml"
    file_mode: "overwrite"
    config:
      component_specific_filters:
        assurance_user_defined_issue_settings:
          - is_enabled: true

# Example 5: Filter by name and enabled status
- name: Generate YAML for specific enabled issue
  cisco.dnac.assurance_issue_playbook_config_generator:
    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}}"
    dnac_log: true
    dnac_log_level: "{{dnac_log_level}}"
    state: gathered
    file_path: "/tmp/specific_enabled_issue.yml"
    file_mode: "overwrite"
    config:
      component_specific_filters:
        assurance_user_defined_issue_settings:
          - name: "Memory Leak Detection"
            is_enabled: true

Return Values

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

Key	Description
response_1 dictionary	A dictionary with the response returned by the Cisco Catalyst Center Python SDK Returned: always Sample: :ansible-rv-sample-value:`{"msg": "YAML config generation succeeded for module 'assurance\_issue\_workflow\_manager'.", "response": {"configurations\_generated": 15, "file\_path": "/tmp/assurance\_issue\_config.yml", "message": "YAML config generation succeeded for module 'assurance\_issue\_workflow\_manager'.", "operation\_summary": {"components\_with\_complete\_failure": [], "components\_with\_complete\_success": ["assurance\_user\_defined\_issue\_settings"], "components\_with\_partial\_success": [], "failure\_details": [], "success\_details": [{"component": "assurance\_user\_defined\_issue\_settings", "issues\_processed": 15, "status": "success"}], "total\_components\_processed": 25, "total\_failed\_operations": 3, "total\_successful\_operations": 22}}}`
response_2 dictionary	A dictionary with the response when no configurations are found Returned: always Sample: :ansible-rv-sample-value:`{"msg": "No configurations or components to process for module 'assurance\_issue\_workflow\_manager'. Verify input filters or configuration.", "response": {"message": "No configurations or components to process for module 'assurance\_issue\_workflow\_manager'. Verify input filters or configuration.", "operation\_summary": {"components\_with\_complete\_failure": [], "components\_with\_complete\_success": [], "components\_with\_partial\_success": [], "failure\_details": [], "success\_details": [], "total\_components\_processed": 0, "total\_failed\_operations": 0, "total\_successful\_operations": 0}}}`
response_3 dictionary	A dictionary with error details when YAML generation fails Returned: always Sample: :ansible-rv-sample-value:`{"msg": "YAML config generation failed for module 'assurance\_issue\_workflow\_manager'.", "response": {"file\_path": "/tmp/assurance\_issue\_config.yml", "message": "YAML config generation failed for module 'assurance\_issue\_workflow\_manager'.", "operation\_summary": {"components\_with\_complete\_failure": [], "components\_with\_complete\_success": ["assurance\_user\_defined\_issue\_settings"], "components\_with\_partial\_success": [], "failure\_details": [], "success\_details": [{"component": "assurance\_user\_defined\_issue\_settings", "issues\_processed": 10, "status": "success"}], "total\_components\_processed": 2, "total\_failed\_operations": 1, "total\_successful\_operations": 1}}}`

Authors

• Megha Kandari (@kandarimegha)

• Madhan Sankaranarayanan (@madhansansel)

Collection links

Issue Tracker Repository (Sources)