cisco.catalystcenter.wireless_profiles module -- Resource module for Wireless Profiles

Note

This module is part of the cisco.catalystcenter collection (version 2.12.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_profiles.

New in cisco.catalystcenter 1.0.0

Synopsis

• Manage operations create, update and delete of the resource Wireless Profiles.

• This API allows the user to create a Wireless Network Profile.

• This API allows the user to delete Wireless Network Profile by Id. - > This API allows the user to update a Wireless Network Profile by Id.Note that, when performing a PUT operation on a wireless network profile, it is essential to provide a complete payload. This is because the wireless network profile is tightly integrated with other network design entities. Consequently, all fields must be included—not just the fields to be updated. Any missing fields will be set to their default or null values. To ensure all fields are accurately populated, consider using the GET operation to retrieve the current resource data before proceeding with the PUT operation.

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
additionalInterfaces list / elements=string	These interfaces will be configured on the device as independent interfaces in addition to the interfaces mapped to SSIDs.
apZones list / elements=dictionary	List of apZones Attached to wireless Profile.
apZoneName string	Name of the apZone.
rfProfileName string	Name of the RF profile attached to the AP Zone.
ssids list / elements=string	Wireless Profiles's ssids.
catalystcenter_debug aliases: dnac_debug boolean	Flag for Cisco Catalyst Center SDK to enable debugging. Choices: :ansible-option-choices-entry-default:`false` ← (default) :ansible-option-choices-entry:`true`
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: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
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"`
featureTemplates list / elements=dictionary	Feature Templates which needs to be associated to the wireless network profile.
id string	Feature Template UUID.
ssids list / elements=string	Wireless Profiles's ssids.
id string	Id.
ssidDetails list / elements=dictionary	SSID Details.
anchorGroupName string	Anchor Group Name. Below are points to consider - If 'enableFabric' field is set to true,'anchorGroupName' must be null.If 'anchorGroupName' is null,'enableFabric' must be false. - If 'interfaceName' field is non-null,'anchorGroupName' must be null.If 'anchorGroupName' is non-null,'interfaceName' must be null.
dot11beProfileId string	802.11be Profile Id. Applicable to IOS controllers with version 17.15.2 and higher.
enableFabric boolean	True if fabric is enabled, else false. Flex and fabric cannot be enabled simultaneously and a profile can only contain either flex SSIDs or fabric SSIDs and not both at the same time. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
flexConnect dictionary	FlexConnect.
enableFlexConnect boolean	True if flex connect is enabled, else false. Flex and fabric cannot be enabled simultaneously and a profile can only contain either flex SSIDs or fabric SSIDs and not both at the same time. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry:`true`
localToVlan integer	Local to VLAN ID.
interfaceName string	Interface Name. Default Value management.
policyProfileName string	Policy Profile Name. If 'policyProfileName' is not provided, the value of 'wlanProfileName' will be assigned to it. If 'profileName' is also not provided, an autogenerated name will be used. Autogenerated name is generated by appending 'ssidName' field's value with '_profile' (Example If 'ssidName' = 'ExampleSsid', then autogenerated name will be 'ExampleSsid_profile').
ssidName string	SSID Name.
vlanGroupName string	VLAN Group Name.Below are points to consider - If 'interfaceName' is non-null in payload,'vlanGroupName' must be null.If 'vlanGroupName' is non-null,'interfaceName' must be null.
wlanProfileName string	WLAN Profile Name.
validate_response_schema boolean	Flag for Cisco Catalyst Center SDK to enable the validation of request bodies against a JSON schema. Choices: :ansible-option-choices-entry:`false` :ansible-option-choices-entry-default:`true` ← (default)
wirelessProfileName string	Wireless Profile Name.

Notes

Note

• SDK Method used are wireless.Wireless.create_wireless_profile, wireless.Wireless.delete_wireless_profile, wireless.Wireless.update_wireless_profile,

• Paths used are post /dna/intent/api/v1/wirelessProfiles, delete /dna/intent/api/v1/wirelessProfiles/{id}, put /dna/intent/api/v1/wirelessProfiles/{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 CreateWirelessProfile

Complete reference of the CreateWirelessProfile API.

Cisco Catalyst Center documentation for Wireless DeleteWirelessProfile

Complete reference of the DeleteWirelessProfile API.

Cisco Catalyst Center documentation for Wireless UpdateWirelessProfile

Complete reference of the UpdateWirelessProfile API.

Examples

---
- name: Update by id
  cisco.catalystcenter.wireless_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
    additionalInterfaces:
      - string
    apZones:
      - apZoneName: string
        rfProfileName: string
        ssids:
          - string
    featureTemplates:
      - id: string
        ssids:
          - string
    id: string
    ssidDetails:
      - anchorGroupName: string
        dot11beProfileId: string
        enableFabric: true
        flexConnect:
          enableFlexConnect: true
          localToVlan: 0
        interfaceName: string
        policyProfileName: string
        ssidName: string
        vlanGroupName: string
        wlanProfileName: string
    wirelessProfileName: string
- name: Delete by id
  cisco.catalystcenter.wireless_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
- name: Create
  cisco.catalystcenter.wireless_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
    additionalInterfaces:
      - string
    apZones:
      - apZoneName: string
        rfProfileName: string
        ssids:
          - string
    featureTemplates:
      - id: string
        ssids:
          - string
    id: string
    ssidDetails:
      - anchorGroupName: string
        dot11beProfileId: string
        enableFabric: true
        flexConnect:
          enableFlexConnect: true
          localToVlan: 0
        interfaceName: string
        policyProfileName: string
        ssidName: string
        vlanGroupName: string
        wlanProfileName: string
    wirelessProfileName: 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": {"taskId": "string", "url": "string"}, "version": "string"}`

Authors

• Bryan Vargas (@bvargasre)

Collection links

Issue Tracker Repository (Sources)