cisco.dnac.network_profile_wireless_workflow_manager module -- Resource module for managing network wireless profile in Cisco Catalyst Center
Note
This module is part of the cisco.dnac collection (version 6.46.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_workflow_manager.
New in cisco.dnac 6.37.0
Synopsis
This module allows the creation and deletion of wireless profiles in Cisco Catalyst Center.
It enables configuring SSID details, assigning profile names, and managing additional interface settings, destination ports, and protocols.
This module interacts with Cisco Catalyst Center's to create profile name, SSID details, additional interface details destination port and protocol.
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 containing the details for network wireless profile creation. |
|
|
|
Name of the additional interface. |
|
|
|
|
|
Name of the AP zone to be created and associated with the wireless profile. |
|
|
|
|
|
List of Day-N template names assigned to the profile. |
|
|
|
Default: :ansible-option-default:`["All"]` |
|
|
|
|
|
Specify the name of the wireless profile that needs to be created. |
|
List of site names assigned to the profile. For example, ["Global/USA/New York/BLDNYC"]. |
|
Contains the SSID details required to update or configure the wireless network profile. |
|
|
|
|
|
Choices: |
|
|
|
|
|
The name of the SSID (Service Set Identifier) to be configured. |
|
|
|
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: :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"` |
|
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 wireless.create_wireless_profile , wireless.update_application_policy, wireless.get_wireless_profile, site_design.assign_sites, wireless.get_interfaces wireless.create_interface
Paths used are GET dna/intent/api/v1/wirelessProfiles POST dna/intent/api/v1/wirelessProfiles/{ GET /dna/intent/api/v1/app-policy-intent DELETE /dna/intent/api/v1/app-policy-intent GET /dna/intent/api/v1/wirelessSettings/interfaces POST /dna/intent/api/v1/wirelessSettings/interfaces
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: Create network wireless profile
cisco.dnac.network_profile_wireless_workflow_manager:
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: DEBUG
config_verify: true
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- profile_name: Corporate_Wireless_Profile
site_names:
- Global/Headquarters
- Global/BranchOffice
ssid_details:
- ssid_name: Corporate_WiFi
enable_fabric: false
dot11be_profile_name: Corporate_VLAN
vlan_group_name: Corporate_VLAN_Group
- ssid_name: Guest_WiFi
enable_fabric: false
dot11be_profile_name: Corporate_VLAN
interface_name: guest_network
local_to_vlan: 3002
ap_zones:
- ap_zone_name: HQ_AP_Zone
rf_profile_name: HIGH
ssids:
- Corporate_WiFi
- ap_zone_name: Branch_AP_Zone
rf_profile_name: TYPICAL
ssids:
- Guest_WiFi
additional_interfaces:
- interface_name: Corp_Interface_1
vlan_id: 100
- interface_name: Guest_Interface_1
vlan_id: 3002
day_n_templates:
- Wireless_Controller_Config
feature_template_designs:
- design_type: Advanced SSID Configuration
feature_templates:
- Default Advanced SSID Design
applicability_ssids:
- HQ_WiFi
- Branch_Secure
- name: Create network wireless profile name only
cisco.dnac.network_profile_wireless_workflow_manager:
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: DEBUG
config_verify: true
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- profile_name: Corporate_Wireless_Profile
- name: Create network wireless profile assign to site
cisco.dnac.network_profile_wireless_workflow_manager:
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: DEBUG
config_verify: true
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- profile_name: Corporate_Wireless_Profile
site_names:
- Global/USA/SAN JOSE/SJ_BLD20
- name: Create network wireless profile with feature template assign to site
cisco.dnac.network_profile_wireless_workflow_manager:
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: DEBUG
config_verify: true
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- profile_name: Corporate_Wireless_Profile
site_names:
- Global/USA/SAN JOSE/SJ_BLD20/FLOOR3
feature_template_designs:
- design_type: AAA_RADIUS_ATTRIBUTES_CONFIGURATION
feature_templates:
- Default AAA_Radius_Attributes_Configuration
- name: Update network wireless profile with feature template
cisco.dnac.network_profile_wireless_workflow_manager:
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: DEBUG
config_verify: true
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- profile_name: Corporate_Wireless_Profile
site_names:
- Global/USA/SAN JOSE/SJ_BLD20/FLOOR3
feature_template_designs:
- design_type: AAA_RADIUS_ATTRIBUTES_CONFIGURATION
feature_templates:
- Default AAA_Radius_Attributes_Configuration
- design_type: CLEANAIR_CONFIGURATION
feature_templates:
- SAMPLE
- Default CleanAir 6GHz Design
- name: Create network wireless profile with SSID details
cisco.dnac.network_profile_wireless_workflow_manager:
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: DEBUG
config_verify: true
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- profile_name: Corporate_Wireless_Profile
ssid_details:
- ssid_name: Guest_WiFi
enable_fabric: false
dot11be_profile_name: Corporate_VLAN
interface_name: guest_network
local_to_vlan: 3002
- ssid_name: ODC_WiFi
enable_fabric: false
dot11be_profile_name: Corporate_VLAN
interface_name: guest_network
local_to_vlan: 3001
- name: Update network wireless profile with additional SSID details
cisco.dnac.network_profile_wireless_workflow_manager:
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: DEBUG
config_verify: true
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- profile_name: Corporate_Wireless_Profile
ssid_details:
- ssid_name: Guest_WiFi
enable_fabric: false
dot11be_profile_name: Corporate_VLAN
interface_name: guest_network
local_to_vlan: 3002
- ssid_name: ODC_WiFi
enable_fabric: false
dot11be_profile_name: Corporate_VLAN
interface_name: guest_network
local_to_vlan: 3001
- ssid_name: Corporate_WiFi
enable_fabric: false
dot11be_profile_name: Corporate_VLAN
interface_name: guest_network
local_to_vlan: 3003
- name: Update wireless network profile
cisco.dnac.network_profile_wireless_workflow_manager:
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: DEBUG
config_verify: true
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: merged
config:
- profile_name: Corporate_Wireless_Profile
site_names:
- Global/FrontOffice
ssid_details:
- ssid_name: Guest_WiFi
enable_fabric: false
dot11be_profile_name: Corporate_VLAN
interface_name: guest_network
local_to_vlan: 3002
ap_zones:
- ap_zone_name: Branch_AP_Zone
rf_profile_name: TYPICAL
ssids:
- Guest_WiFi
additional_interfaces:
- interface_name: Guest_Interface_4
vlan_id: 2002
day_n_templates:
- Wireless_Controller_Config
- name: Delete wireless profile from Cisco Catalyst Center.
cisco.dnac.network_profile_wireless_workflow_manager:
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: DEBUG
config_verify: true
dnac_api_task_timeout: 1000
dnac_task_poll_interval: 1
state: deleted
config:
- profile_name: Corporate_Wireless_Profile
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Response returned when wireless profile deletion completes successfully. Contains details about profile removal and site disassociation. Returned: always when state=deleted |
|
Response when wireless profile operations fail. Contains error details and information about what failed. Returned: when operations fail |
|
Response returned when wireless profile operations complete successfully. Contains details about profile creation, updates, site assignments, and template associations. Returned: always when state=merged |
|
Response when no changes are required as the desired state already exists. Returned: when configuration already matches desired state |
|
Response when some operations succeed but others encounter issues. Contains details about successful operations and any warnings or failures. Returned: when some operations succeed but others fail |
|
Response when profile operations complete but verification fails. Indicates the operation may have succeeded but the final state doesn't match expectations. Returned: when config_verify=true and verification fails |