.. 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.dnac.wireless_profiles_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.wireless_profiles module -- Resource module for Wireless Profiles ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.36.0). To install it, use: :code:`ansible-galaxy collection install cisco.dnac`. 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.dnac.wireless_profiles`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 6.15.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - 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 :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.wireless_profiles_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.10.1 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-additionalinterfaces: .. rst-class:: ansible-option-title **additionalInterfaces** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
These additional interfaces will be configured on the device as independent interfaces in addition to the interfaces mapped to SSIDs. Max Limit 4094. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-apzones: .. rst-class:: ansible-option-title **apZones** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Wireless Profiles's apZones. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-apzones/apzonename: .. rst-class:: ansible-option-title **apZoneName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
AP Zone Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-apzones/rfprofilename: .. rst-class:: ansible-option-title **rfProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
RF Profile Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-apzones/ssids: .. rst-class:: ansible-option-title **ssids** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Ssids part of apZone. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Flag for Cisco DNA 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.dnac.wireless_profiles_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html
- .. raw:: html
The Cisco DNA Center hostname. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA Center password to authenticate. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
The Cisco DNA 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.dnac.wireless_profiles_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html .. 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.dnac.wireless_profiles_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Informs the SDK which version of Cisco DNA Center to use. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"2.3.7.6"` .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-featuretemplates: .. rst-class:: ansible-option-title **featureTemplates** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Wireless Profiles's featureTemplates. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-featuretemplates/id: .. rst-class:: ansible-option-title **id** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Feature Template UUID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-featuretemplates/ssids: .. rst-class:: ansible-option-title **ssids** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
List of SSIDs. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_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
Id path parameter. Wireless Profile Id. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails: .. rst-class:: ansible-option-title **ssidDetails** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html
- .. raw:: html
Wireless Profiles's ssidDetails. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails/anchorgroupname: .. rst-class:: ansible-option-title **anchorGroupName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Anchor Group Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails/dot11beprofileid: .. rst-class:: ansible-option-title **dot11beProfileId** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
802.11be Profile Id. Applicable to IOS controllers with version 17.15 and higher. 802.11be Profiles if passed, should be same across all SSIDs in network profile being configured. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails/enablefabric: .. rst-class:: ansible-option-title **enableFabric** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. 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.dnac.wireless_profiles_module__parameter-ssiddetails/flexconnect: .. rst-class:: ansible-option-title **flexConnect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Profiles's flexConnect. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails/flexconnect/enableflexconnect: .. rst-class:: ansible-option-title **enableFlexConnect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
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. .. 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.dnac.wireless_profiles_module__parameter-ssiddetails/flexconnect/localtovlan: .. rst-class:: ansible-option-title **localToVlan** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html
- .. raw:: html
Local to VLAN ID. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails/interfacename: .. rst-class:: ansible-option-title **interfaceName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Interface Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails/policyprofilename: .. rst-class:: ansible-option-title **policyProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
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'). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails/ssidname: .. rst-class:: ansible-option-title **ssidName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SSID Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails/vlangroupname: .. rst-class:: ansible-option-title **vlanGroupName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
VLAN Group Name. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-ssiddetails/wlanprofilename: .. rst-class:: ansible-option-title **wlanProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
WLAN Profile Name, if not passed autogenerated profile name will be assigned. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_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 DNA 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
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_profiles_module__parameter-wirelessprofilename: .. rst-class:: ansible-option-title **wirelessProfileName** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Wireless Network Profile Name. .. raw:: html
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are wireless.Wireless.create\_wireless\_profile\_connectivity, wireless.Wireless.delete\_wireless\_profile\_connectivity, wireless.Wireless.update\_wireless\_profile\_connectivity, - 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 \ :literal:`check\_mode`\ - The 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 .. Seealso See Also -------- .. seealso:: `Cisco DNA Center documentation for Wireless CreateWirelessProfileConnectivity `_ Complete reference of the CreateWirelessProfileConnectivity API. `Cisco DNA Center documentation for Wireless DeleteWirelessProfileConnectivity `_ Complete reference of the DeleteWirelessProfileConnectivity API. `Cisco DNA Center documentation for Wireless UpdateWirelessProfileConnectivity `_ Complete reference of the UpdateWirelessProfileConnectivity API. .. Examples Examples -------- .. code-block:: yaml+jinja --- - name: Create cisco.dnac.wireless_profiles: 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 additionalInterfaces: - string apZones: - apZoneName: string rfProfileName: string ssids: - string featureTemplates: - id: string ssids: - 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: Update by id cisco.dnac.wireless_profiles: 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 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.dnac.wireless_profiles: 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 .. 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.dnac.wireless_profiles_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_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 DNAC 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": {"taskId": "string", "url": "string"}, "version": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors