cisco.catalystcenter.wireless_settings_ap_profiles module -- Resource module for Wireless Settings Ap Profiles

Note

This module is part of the cisco.catalystcenter collection (version 2.11.0).

To install it, use: ansible-galaxy collection install cisco.catalystcenter. You need further requirements to be able to use this module, see Requirements for details.

To use it in a playbook, specify: cisco.catalystcenter.wireless_settings_ap_profiles.

New in cisco.catalystcenter 2.0.0

Synopsis

  • 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 action plugin.

Requirements

The below requirements are needed on the host that executes this module.

  • catalystcentersdk >= 3.2.3.0.0

  • python >= 3.12

Parameters

Parameter

Comments

apPowerProfileName

string

Name of the AP power profile. Max allowed characters is 128.

apProfileName

string

Name of the Access Point profile. Max length is 32 characters.

awipsEnabled

boolean

Indicates if AWIPS is enabled on the AP.

Choices:

awipsForensicEnabled

boolean

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.

Choices:

calendarPowerProfiles

list / elements=dictionary

List of calendar-based power profiles.

apPowerProfileName

string

Name of the AP power profile. The following API is used create AP Power Profile. API-/dna/intent/api/v1/wirelessSettings/powerProfiles.

calendarProfileName

string

Name of the calendar profile.

duration

dictionary

Details of the duration setting for a calendar scheduler.

schedulerDate

list / elements=string

Start and End date of the duration setting, applicable for MONTHLY schedulers.

schedulerDay

list / elements=string

Applies every week on the selected days.

schedulerEndTime

string

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").

schedulerStartTime

string

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").

schedulerType

string

Type of the scheduler (DAILY, WEEKLY, MONTHLY).

catalystcenter_debug

aliases: dnac_debug

boolean

Flag for Cisco Catalyst Center SDK to enable debugging.

Choices:

catalystcenter_host

aliases: dnac_host

string / required

The Cisco Catalyst Center hostname.

catalystcenter_password

aliases: dnac_password

string

The Cisco Catalyst Center password to authenticate.

catalystcenter_port

aliases: dnac_port, catalystcenter_api_port

integer

The Cisco Catalyst Center port.

Default: :ansible-option-default:`443`

catalystcenter_username

aliases: dnac_username, user

string

The Cisco Catalyst Center username to authenticate.

Default: :ansible-option-default:`"admin"`

catalystcenter_verify

aliases: dnac_verify

boolean

Flag to enable or disable SSL certificate verification.

Choices:

catalystcenter_version

aliases: dnac_version

string

Informs the SDK which version of Cisco Catalyst Center to use.

Default: :ansible-option-default:`"3.1.6.0"`

clientLimit

integer

Number of clients. Value should be between 0-1200.

countryCode

string

Country Code of the AP. Refer below '#/components/schemas/CountryCodes'.

description

string

Description of the AP profile. Max length is 241 characters.

id

string

AP Profile unique ID.

managementSetting

dictionary

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.

authType

string

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.

cdpState

boolean

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:

dot1xPassword

string

Password for 802.1X authentication. Length must be 8-120 characters.

dot1xUsername

string

Username for 802.1X authentication. Dot1xUsername must have a minimum of 1 character and a maximum of 32 characters.

managementEnablePassword

string

Enable password for managing the AP. Length 8-120 characters, At least one uppercase character, At least one lowercase character, At least one digit.

managementPassword

string

Management password for the AP. Length 8-120 characters.

managementUserName

string

Management username must have a minimum of 1 character and a maximum of 32 characters.

sshEnabled

boolean

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.

Choices:

telnetEnabled

boolean

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.

Choices:

meshEnabled

boolean

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.

Choices:

meshSetting

dictionary

Settings specific to mesh networking. MAC address of APs in mesh mode must be added to the AP Authorization list.

backhaulClientAccess

boolean

Indicates if backhaul client access is enabled on the AP.

Choices:

bridgeGroupName

string

Name of the bridge group for mesh settings. If not configured, 'Default' Bridge group name will be used in mesh profile.

ghz24BackhaulDataRates

string

2.4GHz backhaul data rates. Available values auto, 802.11abg, 802.11ax, 802.11n.

ghz5BackhaulDataRates

string

5GHz backhaul data rates. Available values auto, 802.11abg, 802.11ax, 802.11n, 802.12ac.

range

integer

Range of the mesh network. Value should be between 150-132000.

rapDownlinkBackhaul

string

Type of downlink backhaul used. Available values 5 GHz, 2.4 GHz.

pmfDenialEnabled

boolean

Indicates if PMF denial is active. PMF Denial is supported from IOS-XE version 17.12 and above.

Choices:

remoteWorkerEnabled

boolean

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:

rogueDetectionSetting

dictionary

Detect Access Points that have been installed on a secure network without explicit authorization from a system administrator and configure rogue general configuration parameters.

rogueDetection

boolean

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.

Choices:

rogueDetectionMinRssi

integer

Minimum RSSI for rogue detection. Value should be in range -128 decibel milliwatts and -70 decibel milliwatts.

rogueDetectionReportInterval

integer

Report interval for rogue detection. Value should be in range 10 and 300.

rogueDetectionTransientInterval

integer

Transient interval for rogue detection. Value should be 0 or from 120 to 1800.

timeZone

string

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.

timeZoneOffsetHour

integer

Enter the hour value (HH). The valid range is from -12 through 14.

timeZoneOffsetMinutes

integer

Enter the minute value (DD). The valid range is from 0 through 59.

validate_response_schema

boolean

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.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 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)

See Also

See also

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

---
- 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

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

catalystcenter_response

dictionary

A dictionary or list with the response returned by the Cisco Catalyst Center Python SDK

Returned: always

Sample: :ansible-rv-sample-value:`{"response": {}, "version": "string"}`

Authors

  • Bryan Vargas (@bvargasre)