.. 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_provision_ssid_create_provision_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.wireless_provision_ssid_create_provision module -- Resource module for Wireless Provision Ssid Create Provision ++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This module is part of the `cisco.dnac collection `_ (version 6.20.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_provision_ssid_create_provision`. .. version_added .. rst-class:: ansible-version-added New in cisco.dnac 3.1.0 .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Manage operation create of the resource Wireless Provision Ssid Create Provision. - Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements .. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_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
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_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_provision_ssid_create_provision_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_provision_ssid_create_provision_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_provision_ssid_create_provision_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_provision_ssid_create_provision_module__parameter-dnac_username: .. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_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_provision_ssid_create_provision_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_provision_ssid_create_provision_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_provision_ssid_create_provision_module__parameter-enablefabric: .. rst-class:: ansible-option-title **enableFabric** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable SSID for Fabric. .. 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_provision_ssid_create_provision_module__parameter-flexconnect: .. rst-class:: ansible-option-title **flexConnect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Provision Ssid Create Provision's flexConnect. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-flexconnect/enableflexconnect: .. rst-class:: ansible-option-title **enableFlexConnect** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable Flex Connect. .. 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_provision_ssid_create_provision_module__parameter-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 (range is 1 to 4094). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-headers: .. rst-class:: ansible-option-title **headers** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Additional headers. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-managedaplocations: .. rst-class:: ansible-option-title **managedAPLocations** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Managed AP Locations (Enter entire Site(s) hierarchy). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssiddetails: .. rst-class:: ansible-option-title **ssidDetails** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`dictionary` .. raw:: html
- .. raw:: html
Wireless Provision Ssid Create Provision's ssidDetails. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssiddetails/authkeymgmt: .. rst-class:: ansible-option-title **authKeyMgmt** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`list` / :ansible-option-elements:`elements=string` .. raw:: html
- .. raw:: html
Takes string inputs for the AKMs that should be set true. Possible AKM values dot1x,dot1x\_ft, dot1x\_sha, psk, psk\_ft, psk\_sha, owe, sae, sae\_ft. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssiddetails/enablebroadcastssid: .. rst-class:: ansible-option-title **enableBroadcastSSID** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable Broadcast SSID. .. 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_provision_ssid_create_provision_module__parameter-ssiddetails/enablefastlane: .. rst-class:: ansible-option-title **enableFastLane** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable Fast Lane. .. 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_provision_ssid_create_provision_module__parameter-ssiddetails/enablemacfiltering: .. rst-class:: ansible-option-title **enableMACFiltering** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Enable MAC Filtering. .. 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_provision_ssid_create_provision_module__parameter-ssiddetails/fasttransition: .. rst-class:: ansible-option-title **fastTransition** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Fast Transition. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssiddetails/ghz24policy: .. rst-class:: ansible-option-title **ghz24Policy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
2.4 GHz Policy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssiddetails/ghz6policyclientsteering: .. rst-class:: ansible-option-title **ghz6PolicyClientSteering** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
6 Ghz Client Steering. .. 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_provision_ssid_create_provision_module__parameter-ssiddetails/name: .. rst-class:: ansible-option-title **name** .. 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_provision_ssid_create_provision_module__parameter-ssiddetails/passphrase: .. rst-class:: ansible-option-title **passphrase** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Pass Phrase ( Only applicable for SSID with PERSONAL auth type ). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssiddetails/radiopolicy: .. rst-class:: ansible-option-title **radioPolicy** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Radio Policy. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssiddetails/rsnciphersuiteccmp256: .. rst-class:: ansible-option-title **rsnCipherSuiteCcmp256** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Rsn Cipher Suite Ccmp256. .. 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_provision_ssid_create_provision_module__parameter-ssiddetails/rsnciphersuitegcmp128: .. rst-class:: ansible-option-title **rsnCipherSuiteGcmp128** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Rsn Cipher Suite Gcmp128. .. 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_provision_ssid_create_provision_module__parameter-ssiddetails/rsnciphersuitegcmp256: .. rst-class:: ansible-option-title **rsnCipherSuiteGcmp256** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`boolean` .. raw:: html
- .. raw:: html
Rsn Cipher Suite Gcmp256. .. 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_provision_ssid_create_provision_module__parameter-ssiddetails/securitylevel: .. rst-class:: ansible-option-title **securityLevel** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Security Level(For guest SSID OPEN/WEB\_AUTH, For Enterprise SSID ENTERPRISE/PERSONAL/OPEN). .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssiddetails/traffictype: .. rst-class:: ansible-option-title **trafficType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Traffic Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssiddetails/webauthurl: .. rst-class:: ansible-option-title **webAuthURL** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
Web Auth URL. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_module__parameter-ssidtype: .. rst-class:: ansible-option-title **ssidType** .. raw:: html .. rst-class:: ansible-option-type-line :ansible-option-type:`string` .. raw:: html
- .. raw:: html
SSID Type. .. raw:: html
* - .. raw:: html
.. _ansible_collections.cisco.dnac.wireless_provision_ssid_create_provision_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
.. Attributes .. Notes Notes ----- .. note:: - SDK Method used are wireless.Wireless.create\_and\_provision\_ssid, - Paths used are post /dna/intent/api/v1/business/ssid, - 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 CreateAndProvisionSSID `_ Complete reference of the CreateAndProvisionSSID API. .. Examples Examples -------- .. code-block:: yaml+jinja - name: Create cisco.dnac.wireless_provision_ssid_create_provision: 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}}" enableFabric: true flexConnect: enableFlexConnect: true localToVlan: 0 headers: '{{my_headers | from_json}}' managedAPLocations: - string ssidDetails: authKeyMgmt: - string enableBroadcastSSID: true enableFastLane: true enableMACFiltering: true fastTransition: string ghz24Policy: string ghz6PolicyClientSteering: true name: string passphrase: string radioPolicy: string rsnCipherSuiteCcmp256: true rsnCipherSuiteGcmp128: true rsnCipherSuiteGcmp256: true securityLevel: string trafficType: string webAuthURL: string ssidType: 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_provision_ssid_create_provision_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:`{"executionId": "string", "executionStatusUrl": "string", "message": "string"}` .. raw:: html
.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Extra links Collection links ~~~~~~~~~~~~~~~~ .. raw:: html .. Parsing errors