infra_ssids - FortiAP SSID Resource
+++++++++++++++++++++++++++++++++++

.. versionadded:: 1.0.0

.. contents::
   :local:
   :depth: 1

Synopsis
--------
FortiAP SSID Resource.

Use API "/resource-api/v2/infra/ssids".

Requirements
------------

The below requirements are needed on the host that executes this module.

- ansible>=2.17.0


Parameters
----------
.. raw:: html

 <ul>
 <li><span class="li-head">state</span> The state of the module. "present" means create or update the resource, "absent" means delete the resource.<span class="li-normal">type: str</span><span class="li-normal">choices: ['present', 'absent']</span><span class="li-normal">default: present</span></li>
 <li><span class="li-head">force_behavior</span> Specify this option to force the method to use to interact with the resource.<span class="li-normal">type: str</span><span class="li-normal">choices: ['none', 'read', 'create', 'update', 'delete']</span><span class="li-normal">default: none</span></li>
 <li><span class="li-head">bypass_validation</span> Bypass validation of the module.<span class="li-normal">type: bool</span><span class="li-normal">default: False</span></li>
 <li><span class="li-head">params</span> The parameters of the module.<span class="li-required">[Required]</span><span class="li-normal">type: dict</span> <ul class="ul-self"> <li><span class="li-head">primary_key</span> <span class="li-required">[Required]</span><span class="li-normal">type: str</span></li>
 <li><span class="li-head">wifi_ssid</span> <span class="li-normal">type: str</span></li>
 <li><span class="li-head">broadcast_ssid</span> <span class="li-normal">type: str</span><span class="li-normal">choices: ['disable', 'enable']</span></li>
 <li><span class="li-head">client_limit</span> <span class="li-normal">type: int</span></li>
 <li><span class="li-head">security_mode</span> <span class="li-normal">type: str</span><span class="li-normal">choices: ['captive-portal', 'open', 'wpa2-only-enterprise', 'wpa2-only-personal', 'wpa2-only-personal+captive-portal', 'wpa3-only-enterprise', 'wpa3-sae']</span></li>
 <li><span class="li-head">captive_portal</span> <span class="li-normal">type: bool</span></li>
 <li><span class="li-head">security_groups</span> <span class="li-normal">type: list</span><span class="li-normal">elements: dict</span> <ul class="ul-self"> <li><span class="li-head">primary_key</span> <span class="li-normal">type: str</span></li>
 <li><span class="li-head">datasource</span> <span class="li-normal">type: str</span></li>
 </ul></li>
 <li><span class="li-head">pre_shared_key</span> <span class="li-normal">type: str</span></li>
 <li><span class="li-head">radius_server</span> <span class="li-normal">type: dict</span> <ul class="ul-self"> <li><span class="li-head">primary_key</span> <span class="li-normal">type: str</span></li>
 <li><span class="li-head">datasource</span> <span class="li-normal">type: str</span></li>
 </ul></li>
 <li><span class="li-head">user_groups</span> <span class="li-normal">type: list</span><span class="li-normal">elements: dict</span> <ul class="ul-self"> <li><span class="li-head">datasource</span> <span class="li-normal">type: str</span></li>
 </ul></li>
 </ul></li>
 </ul>



Examples
-------------

.. code-block:: yaml

  - name: Infrastructure SSIDs
    hosts: fortisase
    gather_facts: false
    vars:
      primary_key: "example"
    tasks:
      - name: Create/Update Infrastructure SSIDs
        fortinet.fortisase.infra_ssids:
          state: present
          params:
            primary_key: "{{ primary_key }}"
            broadcast_ssid: "enable"
            security_mode: "wpa2-only-personal"
            pre_shared_key: "1234567890"
            wifi_ssid: "wifi_ssid_example"
            client_limit: 101
      - name: Delete Infrastructure SSIDs
        fortinet.fortisase.infra_ssids:
          state: absent
          params:
            primary_key: "{{ primary_key }}"
  


Return Values
-------------
.. raw:: html

 <ul>
 <li><span class="li-head">http_code</span> <span class="li-normal">type: int</span><span class="li-normal">returned: always</span></li>
 <li><span class="li-head">response</span> <span class="li-normal">type: raw</span><span class="li-normal">returned: always</span></li>
 </ul>


Authors
-------

- Xinwei Du (@dux-fortinet)