.. 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
.. Anchors
.. _ansible_collections.cisco.dnac.wireless_enterprise_ssid_module:
.. Anchors: short name for ansible.builtin
.. Anchors: aliases
.. Title
cisco.dnac.wireless_enterprise_ssid -- Resource module for Wireless Enterprise Ssid
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. Collection note
.. note::
This plugin is part of the `cisco.dnac collection <https://galaxy.ansible.com/cisco/dnac>`_ (version 4.0.0).
You might already have this collection installed if you are using the ``ansible`` package.
It is not included in ``ansible-core``.
To check whether it is installed, run :code:`ansible-galaxy collection list`.
To install it, use: :code:`ansible-galaxy collection install cisco.dnac`.
To use it in a playbook, specify: :code:`cisco.dnac.wireless_enterprise_ssid`.
.. version_added
.. versionadded:: 3.1.0 of cisco.dnac
.. contents::
:local:
:depth: 1
.. Deprecated
Synopsis
--------
.. Description
- Manage operations create, update and delete of the resource Wireless Enterprise Ssid.
.. note::
This module has a corresponding :ref:`action plugin <action_plugins>`.
.. Aliases
.. Requirements
Requirements
------------
The below requirements are needed on the host that executes this module.
- dnacentersdk >= 2.4.0
- python >= 3.5
.. Options
Parameters
----------
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Parameter</th>
<th>Choices/<font color="blue">Defaults</font></th>
<th width="100%">Comments</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-basicServiceSetClientIdleTimeout"></div>
<b>basicServiceSetClientIdleTimeout</b>
<a class="ansibleOptionLink" href="#parameter-basicServiceSetClientIdleTimeout" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Basic Service Set Client Idle Timeout.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-clientExclusionTimeout"></div>
<b>clientExclusionTimeout</b>
<a class="ansibleOptionLink" href="#parameter-clientExclusionTimeout" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Client Exclusion Timeout.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_debug"></div>
<b>dnac_debug</b>
<a class="ansibleOptionLink" href="#parameter-dnac_debug" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li><div style="color: blue"><b>no</b> ←</div></li>
<li>yes</li>
</ul>
</td>
<td>
<div>Flag for Cisco DNA Center SDK to enable debugging.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_host"></div>
<b>dnac_host</b>
<a class="ansibleOptionLink" href="#parameter-dnac_host" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
/ <span style="color: red">required</span> </div>
</td>
<td>
</td>
<td>
<div>The Cisco DNA Center hostname.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_password"></div>
<b>dnac_password</b>
<a class="ansibleOptionLink" href="#parameter-dnac_password" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>The Cisco DNA Center password to authenticate.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_port"></div>
<b>dnac_port</b>
<a class="ansibleOptionLink" href="#parameter-dnac_port" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">443</div>
</td>
<td>
<div>The Cisco DNA Center port.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_username"></div>
<b>dnac_username</b>
<a class="ansibleOptionLink" href="#parameter-dnac_username" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"admin"</div>
</td>
<td>
<div>The Cisco DNA Center username to authenticate.</div>
<div style="font-size: small; color: darkgreen"><br/>aliases: user</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_verify"></div>
<b>dnac_verify</b>
<a class="ansibleOptionLink" href="#parameter-dnac_verify" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li><div style="color: blue"><b>yes</b> ←</div></li>
</ul>
</td>
<td>
<div>Flag to enable or disable SSL certificate verification.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-dnac_version"></div>
<b>dnac_version</b>
<a class="ansibleOptionLink" href="#parameter-dnac_version" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
<b>Default:</b><br/><div style="color: blue">"2.2.3.3"</div>
</td>
<td>
<div>Informs the SDK which version of Cisco DNA Center to use.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-enableBasicServiceSetMaxIdle"></div>
<b>enableBasicServiceSetMaxIdle</b>
<a class="ansibleOptionLink" href="#parameter-enableBasicServiceSetMaxIdle" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Enable Basic Service Set Max Idle.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-enableBroadcastSSID"></div>
<b>enableBroadcastSSID</b>
<a class="ansibleOptionLink" href="#parameter-enableBroadcastSSID" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Enable Broadcast SSID.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-enableClientExclusion"></div>
<b>enableClientExclusion</b>
<a class="ansibleOptionLink" href="#parameter-enableClientExclusion" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Enable Client Exclusion.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-enableDirectedMulticastService"></div>
<b>enableDirectedMulticastService</b>
<a class="ansibleOptionLink" href="#parameter-enableDirectedMulticastService" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Enable Directed Multicast Service.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-enableFastLane"></div>
<b>enableFastLane</b>
<a class="ansibleOptionLink" href="#parameter-enableFastLane" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Enable Fast Lane.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-enableMACFiltering"></div>
<b>enableMACFiltering</b>
<a class="ansibleOptionLink" href="#parameter-enableMACFiltering" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Enable MAC Filtering.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-enableNeighborList"></div>
<b>enableNeighborList</b>
<a class="ansibleOptionLink" href="#parameter-enableNeighborList" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Enable Neighbor List.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-enableSessionTimeOut"></div>
<b>enableSessionTimeOut</b>
<a class="ansibleOptionLink" href="#parameter-enableSessionTimeOut" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li>yes</li>
</ul>
</td>
<td>
<div>Enable Session Timeout.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-fastTransition"></div>
<b>fastTransition</b>
<a class="ansibleOptionLink" href="#parameter-fastTransition" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Fast Transition.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-mfpClientProtection"></div>
<b>mfpClientProtection</b>
<a class="ansibleOptionLink" href="#parameter-mfpClientProtection" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Management Frame Protection Client.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-name"></div>
<b>name</b>
<a class="ansibleOptionLink" href="#parameter-name" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Enter SSID Name.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-passphrase"></div>
<b>passphrase</b>
<a class="ansibleOptionLink" href="#parameter-passphrase" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Pass Phrase (Only applicable for SSID with PERSONAL security level).</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-radioPolicy"></div>
<b>radioPolicy</b>
<a class="ansibleOptionLink" href="#parameter-radioPolicy" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Radio Policy. Allowed values are 'Dual band operation (2.4GHz and 5GHz)', 'Dual band operation with band select', '5GHz only', '2.4GHz only'.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-securityLevel"></div>
<b>securityLevel</b>
<a class="ansibleOptionLink" href="#parameter-securityLevel" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Security Level.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-sessionTimeOut"></div>
<b>sessionTimeOut</b>
<a class="ansibleOptionLink" href="#parameter-sessionTimeOut" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">integer</span>
</div>
</td>
<td>
</td>
<td>
<div>Session Time Out.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-ssidName"></div>
<b>ssidName</b>
<a class="ansibleOptionLink" href="#parameter-ssidName" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>SsidName path parameter. Enter the SSID name to be deleted.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-trafficType"></div>
<b>trafficType</b>
<a class="ansibleOptionLink" href="#parameter-trafficType" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">string</span>
</div>
</td>
<td>
</td>
<td>
<div>Traffic Type.</div>
</td>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="parameter-validate_response_schema"></div>
<b>validate_response_schema</b>
<a class="ansibleOptionLink" href="#parameter-validate_response_schema" title="Permalink to this option"></a>
<div style="font-size: small">
<span style="color: purple">boolean</span>
</div>
</td>
<td>
<ul style="margin: 0; padding: 0"><b>Choices:</b>
<li>no</li>
<li><div style="color: blue"><b>yes</b> ←</div></li>
</ul>
</td>
<td>
<div>Flag for Cisco DNA Center SDK to enable the validation of request bodies against a JSON schema.</div>
</td>
</tr>
</table>
<br/>
.. Attributes
.. Notes
Notes
-----
.. note::
- Does not support ``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::
`Wireless Enterprise Ssid reference <https://dnacentersdk.readthedocs.io/en/latest/api/api.html#v3-0-0-summary>`_
Complete reference of the Wireless Enterprise Ssid object model.
.. Examples
Examples
--------
.. code-block:: yaml+jinja
- name: Create
cisco.dnac.wireless_enterprise_ssid:
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
basicServiceSetClientIdleTimeout: 0
clientExclusionTimeout: 0
enableBasicServiceSetMaxIdle: true
enableBroadcastSSID: true
enableClientExclusion: true
enableDirectedMulticastService: true
enableFastLane: true
enableMACFiltering: true
enableNeighborList: true
enableSessionTimeOut: true
fastTransition: string
mfpClientProtection: string
name: string
passphrase: string
radioPolicy: string
securityLevel: string
sessionTimeOut: 0
trafficType: string
- name: Update all
cisco.dnac.wireless_enterprise_ssid:
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
basicServiceSetClientIdleTimeout: 0
clientExclusionTimeout: 0
enableBasicServiceSetMaxIdle: true
enableBroadcastSSID: true
enableClientExclusion: true
enableDirectedMulticastService: true
enableFastLane: true
enableMACFiltering: true
enableNeighborList: true
enableSessionTimeOut: true
fastTransition: string
mfpClientProtection: string
name: string
passphrase: string
radioPolicy: string
securityLevel: string
sessionTimeOut: 0
trafficType: string
- name: Delete by name
cisco.dnac.wireless_enterprise_ssid:
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
ssidName: 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:
.. raw:: html
<table border=0 cellpadding=0 class="documentation-table">
<tr>
<th colspan="1">Key</th>
<th>Returned</th>
<th width="100%">Description</th>
</tr>
<tr>
<td colspan="1">
<div class="ansibleOptionAnchor" id="return-dnac_response"></div>
<b>dnac_response</b>
<a class="ansibleOptionLink" href="#return-dnac_response" title="Permalink to this return value"></a>
<div style="font-size: small">
<span style="color: purple">dictionary</span>
</div>
</td>
<td>always</td>
<td>
<div>A dictionary or list with the response returned by the Cisco DNAC Python SDK</div>
<br/>
<div style="font-size: smaller"><b>Sample:</b></div>
<div style="font-size: smaller; color: blue; word-wrap: break-word; word-break: break-all;">{
"executionId": "string",
"executionStatusUrl": "string",
"message": "string"
}</div>
</td>
</tr>
</table>
<br/><br/>
.. Status (Presently only deprecated)
.. Authors
Authors
~~~~~~~
- Rafael Campos (@racampos)
.. Parsing errors