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.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.network_profile_wireless_workflow_manager.
New in cisco.dnac 6.31.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. |
|
Specifies additional interfaces to be added to this wireless profile. If the specified interface name and VLAN ID do not exist, they will be created. |
|
Name of the additional interface. |
|
VLAN ID for the interface. It must be a numeric value between 1 and 4094. This field is required if the VLAN interface and ID do not already exist. |
|
Defines AP (Access Point) zones that need to be associated with the wireless network profile. |
|
Name of the AP zone to be created and associated with the wireless profile. |
|
Specifies the Radio Frequency (RF) profile to be assigned to the AP zone. This can be a predefined profile such as “HIGH”, “LOW”, “TYPICAL”, or a custom RF profile created by the user. For example, “HIGH”. |
|
A list of SSIDs to be linked to this AP zone. For example, [“SSID1”, “SSID2”]. |
|
List of Day-N template names assigned to the profile. |
|
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. |
|
The name of the anchor group if SSID anchoring is required. SSID anchoring is used in mobility architectures where traffic for a particular SSID is tunneled to a designated anchor controller. |
|
The 802.11be profile name to be assigned to this SSID. This profile defines advanced Wi-Fi 7 (802.11be) parameters to optimize network performance and efficiency. |
|
Set to `True` to enable fabric mode for this SSID. When enabled, the SSID operates within a Cisco SD-Access fabric network, leveraging policy-based segmentation and automation. Choices:
|
|
The name of the network interface where this SSID is configured. If specified, the SSID will be mapped to this interface instead of being part of a VLAN group. |
|
The VLAN ID to which the SSID is mapped. This must be a numeric value between 1 and 4094, ensuring proper network segmentation. |
|
The name of the SSID (Service Set Identifier) to be configured. |
|
The VLAN group name to which this SSID belongs, if applicable. VLAN groups allow multiple VLANs to be logically grouped for efficient traffic segmentation and policy enforcement. |
|
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 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"
- 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 |
|---|---|
A dictionary or list containing the response returned by the Cisco Catalyst Center Python SDK. This response indicates that the wireless profile was either created or updated successfully. Returned: always Sample: |
|
A dictionary or list containing the response returned by the Cisco Catalyst Center Python SDK. This response indicates that the wireless profile was successfully deleted from the system. Returned: always Sample: |