.. 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_profile_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.wireless_profile module -- Resource module for Wireless Profile ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 6.19.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 <ansible_collections.cisco.dnac.wireless_profile_module_requirements>` for details. To use it in a playbook, specify: :code:`cisco.dnac.wireless_profile`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 3.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operations create, update and delete of the resource Wireless Profile. - Creates Wireless Network Profile on Cisco DNA Center and associates sites and SSIDs to it. - Delete the Wireless Profile from Cisco DNA Center whose name is provided. - Updates the wireless Network Profile with updated details provided. All sites to be present in the network profile should be provided. This API has been deprecated. Please use the new endpoint URL /dna/intent/api/v2/wireless/profile. .. note:: This module has a corresponding :ref:`action plugin <action_plugins>`. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.wireless_profile_module_requirements: Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk \>= 2.7.2 - python \>= 3.5 .. Options Parameters ---------- .. rst-class:: ansible-option-table .. list-table:: :width: 100% :widths: auto :header-rows: 1 * - Parameter - Comments * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-dnac_debug: .. rst-class:: ansible-option-title **dnac_debug** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_debug" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> 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 </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_host"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-dnac_host: .. rst-class:: ansible-option-title **dnac_host** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_host" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` / :ansible-option-required:`required` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center hostname. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_password"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-dnac_password: .. rst-class:: ansible-option-title **dnac_password** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_password" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center password to authenticate. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_port"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-dnac_port: .. rst-class:: ansible-option-title **dnac_port** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_port" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center port. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`443` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_username"></div> <div class="ansibleOptionAnchor" id="parameter-user"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-user: .. rst-class:: ansible-option-title **dnac_username** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_username" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-aliases:`aliases: user` .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> The Cisco DNA Center username to authenticate. .. rst-class:: ansible-option-line :ansible-option-default-bold:`Default:` :ansible-option-default:`"admin"` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-dnac_verify: .. rst-class:: ansible-option-title **dnac_verify** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_verify" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> 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 </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-dnac_version"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-dnac_version: .. rst-class:: ansible-option-title **dnac_version** .. raw:: html <a class="ansibleOptionLink" href="#parameter-dnac_version" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> 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 </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails: .. rst-class:: ansible-option-title **profileDetails** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> Wireless Profile's profileDetails. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/name"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/name: .. rst-class:: ansible-option-title **name** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/name" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Profile Name. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/sites"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/sites: .. rst-class:: ansible-option-title **sites** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/sites" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Array of site name hierarchies(eg "Global/aaa/zzz", "Global/aaa/zzz"). .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/ssidDetails"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/ssiddetails: .. rst-class:: ansible-option-title **ssidDetails** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/ssidDetails" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Wireless Profile's ssidDetails. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/ssidDetails/enableFabric"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/ssiddetails/enablefabric: .. rst-class:: ansible-option-title **enableFabric** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/ssidDetails/enableFabric" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> True if ssid is fabric else false. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/ssidDetails/flexConnect"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/ssiddetails/flexconnect: .. rst-class:: ansible-option-title **flexConnect** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/ssidDetails/flexConnect" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Wireless Profile's flexConnect. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/ssidDetails/flexConnect/enableFlexConnect"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/ssiddetails/flexconnect/enableflexconnect: .. rst-class:: ansible-option-title **enableFlexConnect** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/ssidDetails/flexConnect/enableFlexConnect" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> True if flex connect is enabled else false. .. rst-class:: ansible-option-line :ansible-option-choices:`Choices:` - :ansible-option-choices-entry:`false` - :ansible-option-choices-entry:`true` .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/ssidDetails/flexConnect/localToVlan"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/ssiddetails/flexconnect/localtovlan: .. rst-class:: ansible-option-title **localToVlan** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/ssidDetails/flexConnect/localToVlan" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`integer` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Local To Vlan Id. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/ssidDetails/interfaceName"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/ssiddetails/interfacename: .. rst-class:: ansible-option-title **interfaceName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/ssidDetails/interfaceName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Interface Name. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/ssidDetails/name"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/ssiddetails/name: .. rst-class:: ansible-option-title **name** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/ssidDetails/name" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Ssid Name is required if ssidDetails is passed in PayLoad for mapping to the Network Profile. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/ssidDetails/policyProfileName"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/ssiddetails/policyprofilename: .. rst-class:: ansible-option-title **policyProfileName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/ssidDetails/policyProfileName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> Policy Profile Name. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-indent"></div><div class="ansible-option-indent"></div><div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-profileDetails/ssidDetails/wlanProfileName"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-profiledetails/ssiddetails/wlanprofilename: .. rst-class:: ansible-option-title **wlanProfileName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-profileDetails/ssidDetails/wlanProfileName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-indent-desc"></div><div class="ansible-option-indent-desc"></div><div class="ansible-option-cell"> WLAN Profile Name. .. raw:: html </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-validate_response_schema: .. rst-class:: ansible-option-title **validate_response_schema** .. raw:: html <a class="ansibleOptionLink" href="#parameter-validate_response_schema" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> 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 </div> * - .. raw:: html <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="parameter-wirelessProfileName"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__parameter-wirelessprofilename: .. rst-class:: ansible-option-title **wirelessProfileName** .. raw:: html <a class="ansibleOptionLink" href="#parameter-wirelessProfileName" title="Permalink to this option"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> WirelessProfileName path parameter. Wireless Profile Name. .. raw:: html </div> .. Attributes .. Notes 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/wireless/profile, delete /dna/intent/api/v1/wireless-profile/{wirelessProfileName}, put /dna/intent/api/v1/wireless/profile, - 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 CreateWirelessProfile <https://developer.cisco.com/docs/dna-center/#!create-wireless-profile>`_ Complete reference of the CreateWirelessProfile API. `Cisco DNA Center documentation for Wireless DeleteWirelessProfile <https://developer.cisco.com/docs/dna-center/#!delete-wireless-profile>`_ Complete reference of the DeleteWirelessProfile API. `Cisco DNA Center documentation for Wireless UpdateWirelessProfile <https://developer.cisco.com/docs/dna-center/#!update-wireless-profile>`_ Complete reference of the UpdateWirelessProfile API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Delete by name cisco.dnac.wireless_profile: 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 wirelessProfileName: string - name: Update all cisco.dnac.wireless_profile: 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 profileDetails: name: string sites: - string ssidDetails: - enableFabric: true flexConnect: enableFlexConnect: true localToVlan: 0 interfaceName: string name: string policyProfileName: string wlanProfileName: string - name: Create cisco.dnac.wireless_profile: 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 profileDetails: name: string sites: - string ssidDetails: - enableFabric: true flexConnect: enableFlexConnect: true localToVlan: 0 interfaceName: string name: string policyProfileName: string wlanProfileName: string .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here <common_return_values>`, 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 <div class="ansible-option-cell"> <div class="ansibleOptionAnchor" id="return-dnac_response"></div> .. _ansible_collections.cisco.dnac.wireless_profile_module__return-dnac_response: .. rst-class:: ansible-option-title **dnac_response** .. raw:: html <a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a> .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html </div> - .. raw:: html <div class="ansible-option-cell"> 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:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}` .. raw:: html </div> .. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html <p class="ansible-links"> <a href="https://github.com/cisco-en-programmability/dnacenter-ansible/issues" aria-role="button" target="_blank" rel="noopener external">Issue Tracker</a> <a href="https://github.com/cisco-en-programmability/dnacenter-ansible" aria-role="button" target="_blank" rel="noopener external">Repository (Sources)</a> </p> .. Parsing errors