cisco.dnac.network_profile_wireless_playbook_config_generator module -- Generate YAML configurations playbook for 'network_profile_wireless_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.network_profile_wireless_playbook_config_generator.
New in cisco.dnac 6.45.0
Synopsis
Generates YAML configurations compatible with the 'network_profile_wireless_workflow_manager' module, reducing the effort required to manually create Ansible playbooks and enabling programmatic modifications.
Supports complete network wireless profile by collecting all wireless profiles config from Cisco Catalyst Center.
Enables targeted extraction using filters (profile names, Day-N templates, site hierarchies, SSIDs, AP zones, feature templates, or additional interfaces).
Auto-generates timestamped YAML filenames when file path not specified.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.10.10
python >= 3.9
Parameters
Parameter |
Comments |
|---|---|
A dictionary of filters for generating YAML playbook compatible with the 'network_profile_wireless_playbook_config_generator' module. Filters specify which components to include in the YAML configuration file. If If |
|
Global filters to apply when generating the YAML configuration file. These filters apply to all components unless overridden by component-specific filters. At least one filter type must be specified to identify target devices. Filter priority (highest to lowest) is profile_name_list, day_n_template_list, site_list, ssid_list, ap_zone_list, feature_template_list, additional_interface_list. Only the highest priority filter with valid data will be processed. |
|
List of additional interfaces to filter wireless profiles. LOWEST PRIORITY - Only used if all other filters are not provided. Retrieves all wireless profiles containing any of the specified additional interfaces. Case-sensitive and must be exact matches. Example ["VLAN_22", "GigabitEthernet0/2"] |
|
List of AP zones to filter wireless profiles. LOW PRIORITY - Only used if higher priority filters are not provided. Retrieves all wireless profiles containing any of the specified AP zones. Case-sensitive and must be exact matches. Example ["Branch_AP_Zone", "HQ_AP_Zone"] |
|
List of Day-N templates to filter wireless profiles. MEDIUM-HIGH PRIORITY - Only used if profile_name_list is not provided. Retrieves all wireless profiles containing any of the specified templates. Case-sensitive and must be exact matches. Example ["evpn_l2vn_anycast_template", "Wireless_Controller_Config"] Requires retrieving all profiles first, then filtering based on template assignments. |
|
List of feature templates to filter wireless profiles. LOWER PRIORITY - Only used if higher priority filters are not provided. Retrieves all wireless profiles containing any of the specified feature templates. Case-sensitive and must be exact matches. Example ["Default AAA_Radius_Attributes_Configuration", "Default CleanAir 6GHz Design"] |
|
List of wireless profile names to extract configurations from. HIGHEST PRIORITY - Used first if provided with valid data. Wireless Profile names must match those registered in Catalyst Center. Case-sensitive and must be exact matches. Example ["Campus_Wireless_Profile", "Enterprise_Wireless_Profile"] Module will fail if any specified profile does not exist in Catalyst Center. |
|
List of site hierarchies to filter wireless profiles. MEDIUM PRIORITY - Only used if neither profile_name_list nor day_n_template_list are provided. Retrieves all wireless profiles assigned to any of the specified sites. Case-sensitive and must be exact matches. Example ["Global/India/Chennai/Main_Office", "Global/USA/San_Francisco/Regional_HQ"] Requires retrieving all profiles first, then filtering based on site assignments. |
|
List of SSIDs to filter wireless profiles. MEDIUM-LOW PRIORITY - Only used if profile_name_list, day_n_template_list, and site_list are not provided. Retrieves all wireless profiles containing any of the specified SSIDs. Case-sensitive and must be exact matches. Example ["Guest_WiFi", "Corporate_WiFi"] |
|
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` |
|
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: :ansible-option-default:`"dnac.log"` |
|
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"` |
|
The password for authentication at the Cisco Catalyst Center. |
|
Specifies the port number associated with the Cisco Catalyst Center. Default: :ansible-option-default:`"443"` |
|
Specifies the interval in seconds between successive calls to the API to retrieve task details. Default: :ansible-option-default:`2` |
|
The username for authentication at the Cisco Catalyst Center. Default: :ansible-option-default:`"admin"` |
|
Flag to enable or disable SSL certificate verification. Choices: |
|
Specifies the version of the Cisco Catalyst Center that the SDK should use. Default: :ansible-option-default:`"2.2.3.3"` |
|
Determines how the output YAML configuration file is written. Relevant only when When set to When set to Choices: |
|
Path where the YAML configuration file will be saved. If not provided, the file will be saved in the current working directory with a default file name For example, Supports both absolute and relative file paths. |
|
The desired state of Cisco Catalyst Center after module execution. Choices: |
|
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: |
Notes
Note
This module utilizes the following SDK methods site_design.retrieves_the_list_of_sites_that_the_given_network_profile_for_sites_is_assigned_to_v1 site_design.retrieves_the_list_of_network_profiles_for_sites_v1 configuration_templates.gets_the_templates_available_v1 network_settings.retrieve_cli_templates_attached_to_a_network_profile_v1 wireless.get_wireless_profile wireless.get_interfaces
The following API paths are used GET /dna/intent/api/v1/networkProfilesForSites GET /dna/intent/api/v1/template-programmer/template GET /dna/intent/api/v1/networkProfilesForSites/{profileId}/templates GET /dna/intent/api/v1/wireless/profile GET /dna/intent/api/v1/interfaces
Minimum Cisco Catalyst Center version required is 2.3.7.9 for YAML playbook generation support.
Filter priority hierarchy ensures only one filter type is processed per execution.
Module creates YAML file compatible with 'network_profile_wireless_workflow_manager' module for automation workflows.
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
---
- name: Auto-generate YAML Configuration for all Wireless Profiles
cisco.dnac.network_profile_wireless_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
- name: Auto-generate YAML Configuration with custom file path
cisco.dnac.network_profile_wireless_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/complete_wireless_profile_config.yml"
file_mode: "overwrite"
- name: Generate YAML Configuration with default file path for given wireless profiles
cisco.dnac.network_profile_wireless_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/network_profile_wireless_playbook_config_profile_base.yml"
file_mode: "overwrite"
config:
global_filters:
profile_name_list:
- "Campus_Wireless_Profile"
- "Enterprise_Wireless_Profile"
- name: Generate YAML Configuration with default file path based on Day-N templates filters
cisco.dnac.network_profile_wireless_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/network_profile_wireless_playbook_config_dayn_template_base.yml"
file_mode: "overwrite"
config:
global_filters:
day_n_template_list:
- "Periodic_Config_Audit"
- "Security_Compliance_Check"
- name: Generate YAML Configuration with default file path based on site list filters
cisco.dnac.network_profile_wireless_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/network_profile_wireless_playbook_config_site_base.yml"
file_mode: "overwrite"
config:
global_filters:
site_list:
- "Global/India/Chennai/Main_Office"
- "Global/USA/San_Francisco/Regional_HQ"
- name: Generate YAML Configuration with default file path based on ssid list filters
cisco.dnac.network_profile_wireless_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/network_profile_wireless_playbook_config_ssid_base.yml"
file_mode: "overwrite"
config:
global_filters:
ssid_list:
- "SSID1"
- "SSID2"
- name: Generate YAML Configuration with default file path based on ap zone list filters
cisco.dnac.network_profile_wireless_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/network_profile_wireless_playbook_config_ap_zone_base.yml"
file_mode: "overwrite"
config:
global_filters:
ap_zone_list:
- "AP_Zone1"
- "AP_Zone2"
- name: Generate YAML Configuration with default file path based on feature template list filters
cisco.dnac.network_profile_wireless_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/network_profile_wireless_playbook_config_feature_template_base.yml"
file_mode: "overwrite"
config:
global_filters:
feature_template_list:
- "Default AAA_Radius_Attributes_Configuration"
- "Default CleanAir 6GHz Design"
- name: Generate YAML Configuration with default file path based on additional interface list filters
cisco.dnac.network_profile_wireless_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/network_profile_wireless_playbook_config_additional_interface_base.yml"
file_mode: "overwrite"
config:
global_filters:
additional_interface_list:
- "VLAN_22"
- "GigabitEthernet0/2"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary with the response returned by the Cisco Catalyst Center Python SDK Returned: always |
|
A string with the response returned by the Cisco Catalyst Center Python SDK Returned: always |