cisco.dnac.wireless_settings_ap_profiles_id module – Resource module for Wireless Settings Ap Profiles Id
Note
This module is part of the cisco.dnac collection (version 6.41.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.wireless_settings_ap_profiles_id.
New in cisco.dnac 6.17.0
Synopsis
Manage operations update and delete of the resource Wireless Settings Ap Profiles Id.
This API allows the user to delete an AP Profile by specifying the AP Profile ID.
This API allows the user to update a custom AP Profile.
Note
This module has a corresponding action plugin.
Requirements
The below requirements are needed on the host that executes this module.
dnacentersdk >= 2.10.1
python >= 3.5
Parameters
Parameter |
Comments |
|---|---|
Name of the existing AP power profile. |
|
Name of the Access Point profile. Max length is 32 characters. |
|
Indicates if AWIPS is enabled on the AP. Choices:
|
|
Indicates if AWIPS forensic is enabled on the AP. Forensic Capture is supported from IOS-XE version 17.4 and above. Forensic Capture can be activated only if aWIPS is enabled. Choices:
|
|
Wireless Settings Ap Profiles Id’s calendarPowerProfiles. |
|
Wireless Settings Ap Profiles Id’s duration. |
|
Start and End date of the duration setting, applicable for MONTHLY schedulers. Values must be between 1 and 31. |
|
Applies every week on the selected days. Ex “sunday”,”saturday”,”tuesday”,”wednesday”,”thu… |
|
End time of the duration setting. |
|
Start time of the duration setting. |
|
Name of the existing AP power profile to be mapped to the calendar power profile. API-/intent/api/v1/wirelessSettings/powerProfiles. |
|
Type of the scheduler. |
|
Number of clients. Value should be between 0-1200. |
|
Country Code. |
|
Description of the AP profile. Max length is 241 characters. |
|
Flag for Cisco DNA Center SDK to enable debugging. Choices:
|
|
The Cisco DNA Center hostname. |
|
The Cisco DNA Center password to authenticate. |
|
The Cisco DNA Center port. Default: |
|
The Cisco DNA Center username to authenticate. Default: |
|
Flag to enable or disable SSL certificate verification. Choices:
|
|
Informs the SDK which version of Cisco DNA Center to use. Default: |
|
Id path parameter. AP Profile ID. |
|
Wireless Settings Ap Profiles Id’s managementSetting. |
|
Authentication type used in the AP profile. These setting are applicable during PnP claim and for day-N authentication of AP. Changing these settings will be service impacting for the PnP onboarded APs and will need a factory-reset for those APs. |
|
Indicates if CDP is enabled on the AP. Enable CDP in order to make Cisco Access Points known to its neighboring devices and vice-versa. Choices:
|
|
Password for 802.1X authentication. Length must be 8-120 characters. |
|
Username for 802.1X authentication. Dot1xUsername must have a minimum of 1 character and a maximum of 32 characters. |
|
Enable password for managing the AP. Length must be 8-120 characters. |
|
Management password for the AP. Length must be 8-120 characters. |
|
Management username must have a minimum of 1 character and a maximum of 32 characters. |
|
Indicates if SSH is enabled on the AP. Enable SSH add credentials for device management. Choices:
|
|
Indicates if Telnet is enabled on the AP. Enable Telnet to add credentials for device management. Choices:
|
|
This indicates whether mesh networking is enabled on the AP. For IOS-XE devices, when mesh networking is enabled, a custom mesh profile with the configured parameters will be created and mapped to the AP join profile on the device. When mesh networking is disabled, any existing custom mesh profile will be deleted from the device, and the AP join profile will be mapped to the default mesh profile on the device. Choices:
|
|
Wireless Settings Ap Profiles Id’s meshSetting. |
|
Indicates if backhaul client access is enabled on the AP. Choices:
|
|
Name of the bridge group for mesh settings. If not configured, ‘Default’ Bridge group name will be used in mesh profile. |
|
2.4GHz backhaul data rates. |
|
5GHz backhaul data rates. |
|
Range of the mesh network. Value should be between 150-132000. |
|
Type of downlink backhaul used. Available values 5 GHz, 2.4 GHz. |
|
Indicates if PMF denial is active on the AP. PMF Denial is supported from IOS-XE version 17.12 and above. Choices:
|
|
Indicates if remote worker mode is enabled on the AP. Remote teleworker enabled profile cannot support security features like aWIPS,Forensic Capture Enablement, Rogue Detection and Rogue Containment. Choices:
|
|
Wireless Settings Ap Profiles Id’s rogueDetectionSetting. |
|
Indicates if rogue detection is enabled on the AP. Detect Access Points that have been installed on a secure network without explicit authorization from a system administrator and configure rogue general configuration parameters. Choices:
|
|
Minimum RSSI for rogue detection. Value should be in range -128 decibel milliwatts and -70 decibel milliwatts. |
|
Report interval for rogue detection. Value should be in range 10 and 300. |
|
Transient interval for rogue detection. Value should be 0 or from 120 to 1800. |
|
In the Time Zone area, choose one of the following options. Not Configured - APs operate in the UTC time zone. Controller - APs operate in the Cisco Wireless Controller time zone. Delta from Controller - APs operate in the offset time from the wireless controller time zone. |
|
Enter the hour value (HH). The valid range is from -12 through 14. |
|
Enter the minute value (MM). The valid range is from 0 through 59. |
|
Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema. Choices:
|
Notes
Note
SDK Method used are wireless.Wireless.delete_ap_profile_by_id, wireless.Wireless.update_ap_profile_by_id,
Paths used are delete /dna/intent/api/v1/wirelessSettings/apProfiles/{id}, put /dna/intent/api/v1/wirelessSettings/apProfiles/{id},
Does not support
check_modeThe plugin runs on the control node and does not use any ansible connection plugins, but instead the embedded connection manager from Cisco DNAC SDK
The parameters starting with dnac_ are used by the Cisco DNAC Python SDK to establish the connection
See Also
See also
- Cisco DNA Center documentation for Wireless DeleteAPProfileByID
Complete reference of the DeleteAPProfileByID API.
- Cisco DNA Center documentation for Wireless UpdateAPProfileByID
Complete reference of the UpdateAPProfileByID API.
Examples
---
- name: Delete by id
cisco.dnac.wireless_settings_ap_profiles_id:
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}}"
state: absent
id: string
- name: Update by id
cisco.dnac.wireless_settings_ap_profiles_id:
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}}"
state: present
apPowerProfileName: string
apProfileName: string
awipsEnabled: true
awipsForensicEnabled: true
calendarPowerProfiles:
duration:
schedulerDate:
- string
schedulerDay:
- string
schedulerEndTime: string
schedulerStartTime: string
powerProfileName: string
schedulerType: string
clientLimit: 0
countryCode: string
description: string
id: string
managementSetting:
authType: string
cdpState: true
dot1xPassword: string
dot1xUsername: string
managementEnablePassword: string
managementPassword: string
managementUserName: string
sshEnabled: true
telnetEnabled: true
meshEnabled: true
meshSetting:
backhaulClientAccess: true
bridgeGroupName: string
ghz24BackhaulDataRates: string
ghz5BackhaulDataRates: string
range: 0
rapDownlinkBackhaul: string
pmfDenialEnabled: true
remoteWorkerEnabled: true
rogueDetectionSetting:
rogueDetection: true
rogueDetectionMinRssi: 0
rogueDetectionReportInterval: 0
rogueDetectionTransientInterval: 0
timeZone: string
timeZoneOffsetHour: 0
timeZoneOffsetMinutes: 0
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
A dictionary or list with the response returned by the Cisco DNAC Python SDK Returned: always Sample: |