.. Document meta :orphan: .. |antsibull-internal-nbsp| unicode:: 0xA0 :trim: .. role:: ansible-attribute-support-label .. role:: ansible-attribute-support-property .. role:: ansible-attribute-support-full .. role:: ansible-attribute-support-partial .. role:: ansible-attribute-support-none .. role:: ansible-attribute-support-na .. role:: ansible-option-type .. role:: ansible-option-elements .. role:: ansible-option-required .. role:: ansible-option-versionadded .. role:: ansible-option-aliases .. role:: ansible-option-choices .. role:: ansible-option-choices-default-mark .. role:: ansible-option-default-bold .. role:: ansible-option-configuration .. role:: ansible-option-returned-bold .. role:: ansible-option-sample-bold .. Anchors .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.catalystcenter.wireless_settings_ap_profiles module -- Resource module for Wireless Settings Ap Profiles ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.catalystcenter collection `_ (version 2.11.0). To install it, use: :code:`ansible-galaxy collection install cisco.catalystcenter`. You need further requirements to be able to use this module, see :ref:`Requirements ` for details. To use it in a playbook, specify: :code:`cisco.catalystcenter.wireless_settings_ap_profiles`. .. version_added .. rst-class:: ansible-version-added New in cisco.catalystcenter 2.0.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Wireless Settings Ap Profiles. - This API allows the user to create a custom AP Profile. - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - catalystcentersdk \>= 3.2.3.0.0 - python \>= 3.12 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-appowerprofilename: .. rst-class:: ansible-option-title **apPowerProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the AP power profile. Max allowed characters is 128. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-approfilename: .. rst-class:: ansible-option-title **apProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the Access Point profile. Max length is 32 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-awipsenabled: .. rst-class:: ansible-option-title **awipsEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates if AWIPS is enabled on the AP. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-awipsforensicenabled: .. rst-class:: ansible-option-title **awipsForensicEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates if AWIPS forensic is enabled. Forensic Capture is supported from IOS-XE version 17.4 and above. Forensic Capture can be activated only if aWIPS is enabled. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-calendarpowerprofiles: .. rst-class:: ansible-option-title **calendarPowerProfiles** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
List of calendar-based power profiles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-calendarpowerprofiles/appowerprofilename: .. rst-class:: ansible-option-title **apPowerProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the AP power profile. The following API is used create AP Power Profile. API-/dna/intent/api/v1/wirelessSettings/powerProfiles. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-calendarpowerprofiles/calendarprofilename: .. rst-class:: ansible-option-title **calendarProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the calendar profile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-calendarpowerprofiles/duration: .. rst-class:: ansible-option-title **duration** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Details of the duration setting for a calendar scheduler. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-calendarpowerprofiles/duration/schedulerdate: .. rst-class:: ansible-option-title **schedulerDate** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Start and End date of the duration setting, applicable for MONTHLY schedulers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-calendarpowerprofiles/duration/schedulerday: .. rst-class:: ansible-option-title **schedulerDay** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Applies every week on the selected days. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-calendarpowerprofiles/duration/schedulerendtime: .. rst-class:: ansible-option-title **schedulerEndTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
End time of the duration setting. The value must be provided in 12-hour format with AM/PM (e.g., "07 00 AM", "09 30 PM"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-calendarpowerprofiles/duration/schedulerstarttime: .. rst-class:: ansible-option-title **schedulerStartTime** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Start time of the duration setting. The value must be provided in 12-hour format with AM/PM (e.g., "05 00 AM", "07 30 PM"). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-calendarpowerprofiles/schedulertype: .. rst-class:: ansible-option-title **schedulerType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of the scheduler (DAILY, WEEKLY, MONTHLY). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-catalystcenter_debug: .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **catalystcenter_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_debug` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable debugging. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry-default:`false` :ansible-option-choices-default-mark:`← (default)` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-catalystcenter_host: .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-dnac_host: .. rst-class:: ansible-option-title **catalystcenter_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_host` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-catalystcenter_password: .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-dnac_password: .. rst-class:: ansible-option-title **catalystcenter_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_password` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-catalystcenter_api_port: .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-catalystcenter_port: .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-dnac_port: .. rst-class:: ansible-option-title **catalystcenter_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_port, catalystcenter_api_port` .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-catalystcenter_username: .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-dnac_username: .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-user: .. rst-class:: ansible-option-title **catalystcenter_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_username, user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco Catalyst Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-catalystcenter_verify: .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **catalystcenter_verify** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_verify` .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag to enable or disable SSL certificate verification. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-catalystcenter_version: .. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-dnac_version: .. rst-class:: ansible-option-title **catalystcenter_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: dnac_version` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco Catalyst Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"3.1.6.0"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-clientlimit: .. rst-class:: ansible-option-title **clientLimit** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Number of clients. Value should be between 0-1200. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-countrycode: .. rst-class:: ansible-option-title **countryCode** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Country Code of the AP. Refer below '#/components/schemas/CountryCodes'. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-description: .. rst-class:: ansible-option-title **description** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Description of the AP profile. Max length is 241 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AP Profile unique ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting: .. rst-class:: ansible-option-title **managementSetting** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
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 and Enable SSH and Telnet to add credentials for device management. If SSH and Telnet are disable, credentials can still be added for console access. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting/authtype: .. rst-class:: ansible-option-title **authType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. Available values NO-AUTH, EAP-TLS, EAP-PEAP, EAP-FAST. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting/cdpstate: .. rst-class:: ansible-option-title **cdpState** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting/dot1xpassword: .. rst-class:: ansible-option-title **dot1xPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Password for 802.1X authentication. Length must be 8-120 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting/dot1xusername: .. rst-class:: ansible-option-title **dot1xUsername** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Username for 802.1X authentication. Dot1xUsername must have a minimum of 1 character and a maximum of 32 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting/managementenablepassword: .. rst-class:: ansible-option-title **managementEnablePassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Enable password for managing the AP. Length 8-120 characters, At least one uppercase character, At least one lowercase character, At least one digit. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting/managementpassword: .. rst-class:: ansible-option-title **managementPassword** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Management password for the AP. Length 8-120 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting/managementusername: .. rst-class:: ansible-option-title **managementUserName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Management username must have a minimum of 1 character and a maximum of 32 characters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting/sshenabled: .. rst-class:: ansible-option-title **sshEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates if SSH is enabled on the AP. Enable SSH add credentials for device management. If SSH is disable, credentials can still be added for console access. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-managementsetting/telnetenabled: .. rst-class:: ansible-option-title **telnetEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates if Telnet is enabled on the AP. Enable Telnet to add credentials for device management. If Telnet is disable, credentials can still be added for console access. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-meshenabled: .. rst-class:: ansible-option-title **meshEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
This indicates whether mesh networking is enabled. 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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-meshsetting: .. rst-class:: ansible-option-title **meshSetting** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Settings specific to mesh networking. MAC address of APs in mesh mode must be added to the AP Authorization list. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-meshsetting/backhaulclientaccess: .. rst-class:: ansible-option-title **backhaulClientAccess** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates if backhaul client access is enabled on the AP. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-meshsetting/bridgegroupname: .. rst-class:: ansible-option-title **bridgeGroupName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Name of the bridge group for mesh settings. If not configured, 'Default' Bridge group name will be used in mesh profile. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-meshsetting/ghz24backhauldatarates: .. rst-class:: ansible-option-title **ghz24BackhaulDataRates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
2.4GHz backhaul data rates. Available values auto, 802.11abg, 802.11ax, 802.11n. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-meshsetting/ghz5backhauldatarates: .. rst-class:: ansible-option-title **ghz5BackhaulDataRates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
5GHz backhaul data rates. Available values auto, 802.11abg, 802.11ax, 802.11n, 802.12ac. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-meshsetting/range: .. rst-class:: ansible-option-title **range** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Range of the mesh network. Value should be between 150-132000. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-meshsetting/rapdownlinkbackhaul: .. rst-class:: ansible-option-title **rapDownlinkBackhaul** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Type of downlink backhaul used. Available values 5 GHz, 2.4 GHz. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-pmfdenialenabled: .. rst-class:: ansible-option-title **pmfDenialEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates if PMF denial is active. PMF Denial is supported from IOS-XE version 17.12 and above. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-remoteworkerenabled: .. rst-class:: ansible-option-title **remoteWorkerEnabled** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-roguedetectionsetting: .. rst-class:: ansible-option-title **rogueDetectionSetting** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Detect Access Points that have been installed on a secure network without explicit authorization from a system administrator and configure rogue general configuration parameters. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-roguedetectionsetting/roguedetection: .. rst-class:: ansible-option-title **rogueDetection** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Indicates if rogue detection is enabled. Detect Access Points that have been installed on a secure network without explicit authorization from a system administrator and configure rogue general configuration parameters. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-roguedetectionsetting/roguedetectionminrssi: .. rst-class:: ansible-option-title **rogueDetectionMinRssi** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Minimum RSSI for rogue detection. Value should be in range -128 decibel milliwatts and -70 decibel milliwatts. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-roguedetectionsetting/roguedetectionreportinterval: .. rst-class:: ansible-option-title **rogueDetectionReportInterval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Report interval for rogue detection. Value should be in range 10 and 300. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-roguedetectionsetting/roguedetectiontransientinterval: .. rst-class:: ansible-option-title **rogueDetectionTransientInterval** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Transient interval for rogue detection. Value should be 0 or from 120 to 1800. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-timezone: .. rst-class:: ansible-option-title **timeZone** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-timezoneoffsethour: .. rst-class:: ansible-option-title **timeZoneOffsetHour** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Enter the hour value (HH). The valid range is from -12 through 14. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-timezoneoffsetminutes: .. rst-class:: ansible-option-title **timeZoneOffsetMinutes** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Enter the minute value (DD). The valid range is from 0 through 59. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry-default:`true` :ansible-option-choices-default-mark:`← (default)` .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are wireless.Wireless.create\_ap\_profile, wireless.Wireless.delete\_ap\_profile\_by\_id, wireless.Wireless.update\_approfile\_by\_id, - Paths used are post /dna/intent/api/v1/wirelessSettings/apProfiles, delete /dna/intent/api/v1/wirelessSettings/apProfiles/{id}, put /dna/intent/api/v1/wirelessSettings/apProfiles/{id}, - Does not support \ :literal:`check\_mode`\ - The plugin runs on the control node and does not use any ansible connection plugins, - but instead uses the embedded connection manager from Cisco CATALYST SDK - Requires Python \>= 3.10, matching the controller Python versions supported by the collection's minimum ansible-core version (see the collection README for the current ansible-core / Python compatibility range) .. Seealso See Also -------- .. seealso:: `Cisco Catalyst Center documentation for Wireless CreateApProfile `_ Complete reference of the CreateApProfile API. `Cisco Catalyst Center documentation for Wireless DeleteApProfileByID `_ Complete reference of the DeleteApProfileByID API. `Cisco Catalyst Center documentation for Wireless UpdateApprofileByID `_ Complete reference of the UpdateApprofileByID API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.catalystcenter.wireless_settings_ap_profiles: catalystcenter_host: "{{catalystcenter_host}}" catalystcenter_username: "{{catalystcenter_username}}" catalystcenter_password: "{{catalystcenter_password}}" catalystcenter_verify: "{{catalystcenter_verify}}" catalystcenter_port: "{{catalystcenter_port}}" catalystcenter_version: "{{catalystcenter_version}}" catalystcenter_debug: "{{catalystcenter_debug}}" state: present apPowerProfileName: string apProfileName: string awipsEnabled: true awipsForensicEnabled: true calendarPowerProfiles: - apPowerProfileName: string calendarProfileName: string duration: schedulerDate: - string schedulerDay: - string schedulerEndTime: string schedulerStartTime: 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 - name: Update by id cisco.catalystcenter.wireless_settings_ap_profiles: catalystcenter_host: "{{catalystcenter_host}}" catalystcenter_username: "{{catalystcenter_username}}" catalystcenter_password: "{{catalystcenter_password}}" catalystcenter_verify: "{{catalystcenter_verify}}" catalystcenter_port: "{{catalystcenter_port}}" catalystcenter_version: "{{catalystcenter_version}}" catalystcenter_debug: "{{catalystcenter_debug}}" state: present apPowerProfileName: string apProfileName: string awipsEnabled: true awipsForensicEnabled: true calendarPowerProfiles: - apPowerProfileName: string calendarProfileName: string duration: schedulerDate: - string schedulerDay: - string schedulerEndTime: string schedulerStartTime: 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 - name: Delete by id cisco.catalystcenter.wireless_settings_ap_profiles: catalystcenter_host: "{{catalystcenter_host}}" catalystcenter_username: "{{catalystcenter_username}}" catalystcenter_password: "{{catalystcenter_password}}" catalystcenter_verify: "{{catalystcenter_verify}}" catalystcenter_port: "{{catalystcenter_port}}" catalystcenter_version: "{{catalystcenter_version}}" catalystcenter_debug: "{{catalystcenter_debug}}" state: absent id: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Key - Description * - .. raw:: html
.. _ansible_collections.cisco.catalystcenter.wireless_settings_ap_profiles_module__return-catalystcenter_response: .. rst-class:: ansible-option-title **catalystcenter_response** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK .. rst-class:: ansible-option-line :ansible-option-returned-bold:`Returned:` always .. rst-class:: ansible-option-line .. rst-class:: ansible-option-sample :ansible-option-sample-bold:`Sample:` :ansible-rv-sample-value:`{"response": {}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Bryan Vargas (@bvargasre) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors