.. Document meta :orphan: .. Anchors .. _ansible_collections.cisco.dnac.ssid_module: .. Anchors: short name for ansible.builtin .. Anchors: aliases .. Title cisco.dnac.ssid -- Manage Ssid objects of Wireless ++++++++++++++++++++++++++++++++++++++++++++++++++ .. Collection note .. note:: This plugin is part of the `cisco.dnac collection `_ (version 2.0.7). To install it use: :code:`ansible-galaxy collection install cisco.dnac`. To use it in a playbook, specify: :code:`cisco.dnac.ssid`. .. version_added .. versionadded:: 1.0.0 of cisco.dnac .. contents:: :local: :depth: 1 .. Deprecated Synopsis -------- .. Description - Creates SSID, updates the SSID to the corresponding site profiles and provision it to the devices matching the given sites. - Removes SSID or WLAN from the network profile, reprovision the device(s) and deletes the SSID or WLAN from DNA Center. .. note:: This module has a corresponding :ref:`action plugin `. .. Aliases .. Requirements Requirements ------------ The below requirements are needed on the host that executes this module. - dnacentersdk .. Options Parameters ---------- .. raw:: html

Parameter		Choices/Defaults	Comments
enableFabric boolean		Choices: no yes	EnableFabric, property of the request body. Required for state create.
flexConnect dictionary			Flex Connect - Applicable for non fabric profile, property of the request body.
	enableFlexConnect boolean	Choices: no yes	It is the Ssid's enableFlexConnect.
	localToVlan integer		It is the Ssid's localToVlan.
managed_aplocations string			ManagedAPLocations path parameter. Required for state delete.
managedAPLocations list / elements=string			Managed AP Locations (Enter entire Site(s) hierarchy), property of the request body (list of strings). Required for state create.
ssid_name string			SsidName path parameter. Required for state delete.
ssidDetails dictionary			SsidDetails, property of the request body. Required for state create.
	enableBroadcastSSID boolean	Choices: no yes	It is the Ssid's enableBroadcastSSID.
	enableFastLane boolean	Choices: no yes	It is the Ssid's enableFastLane.
	enableMACFiltering boolean	Choices: no yes	It is the Ssid's enableMACFiltering.
	fastTransition string		It is the Ssid's fastTransition.
	name string		It is the Ssid's name.
	passphrase string		It is the Ssid's passphrase.
	radioPolicy string		It is the Ssid's radioPolicy.
	securityLevel string		It is the Ssid's securityLevel.
	trafficType string		It is the Ssid's trafficType.
	webAuthURL string		It is the Ssid's webAuthURL.
ssidType string			SSID Type, property of the request body. Available values are 'Guest' and 'Enterprise'. Required for state create.

.. Notes .. Seealso See Also -------- .. seealso:: :ref:`cisco.dnac.plugins.module_utils.definitions.ssid ` The official documentation on the **cisco.dnac.plugins.module_utils.definitions.ssid** module. `Ssid reference `_ Complete reference of the Ssid object model. `Ssid reference `_ SDK reference. .. Examples Examples -------- .. code-block:: yaml+jinja - name: create_and_provision_ssid cisco.dnac.ssid: state: create # required enableFabric: True # boolean, required managedAPLocations: # required - SomeValue # string ssidDetails: # required name: SomeValue # string securityLevel: SomeValue # string enableFastLane: True # boolean passphrase: SomeValue # string trafficType: SomeValue # string enableBroadcastSSID: True # boolean radioPolicy: SomeValue # string enableMACFiltering: True # boolean fastTransition: SomeValue # string webAuthURL: SomeValue # string ssidType: # valid values are 'Guest', # 'Enterprise'. SomeValue # string, required flexConnect: enableFlexConnect: True # boolean localToVlan: 1 # integer - name: delete_ssid_and_provision_it_to_devices cisco.dnac.ssid: state: delete # required managed_aplocations: SomeValue # string, required ssid_name: SomeValue # string, required .. Facts .. Return values Return Values ------------- Common return values are documented :ref:`here `, the following are the fields unique to this module: .. raw:: html

Key	Returned	Description
dnac_response dictionary	always	A dictionary with the response returned by the DNA Center Python SDK Sample: {'response': 29, 'version': '1.0'}
missing_params list / elements=string	when the function request schema is not satisfied	Provided arguments do not comply with the schema of the DNA Center Python SDK function
sdk_function string	always	The DNA Center SDK function used to execute the task Sample: wireless.create_and_provision_ssid

.. Status (Presently only deprecated) .. Authors Authors ~~~~~~~ - Rafael Campos (@racampos) .. Parsing errors