:source: fwebos_waf_site_publish_policy.py

:orphan:

.. fwebos_waf_site_publish_policy.py:

fwebos_waf_site_publish_policy.py -- Config FortiWeb Published Site Policy
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 1.0.1

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


Synopsis
--------
Config FortiWeb Published Site Policy


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

- ansible>=2.11


FortiWeb Version Compatibility
------------------------------


.. raw:: html

 <br>
 <table>
 <tr>
 <td></td>
 <td><code class="docutils literal notranslate">v7.0.x </code></td>
 <td><code class="docutils literal notranslate">v7.2.x </code></td>
 <td><code class="docutils literal notranslate">v7.4.x </code></td>
 <td><code class="docutils literal notranslate">v7.6.x </code></td>
 </tr>
 <tr>
 <td>fwebos_waf_site_publish_policy.py</td>
 <td>yes</td>
 <td>yes</td>
 <td>yes</td>
 <td>yes</td>
 </tr>
 </table>
 <p>



Parameters
----------


.. raw:: html


  <ul>
  <li><span class="li-head">body</span> Possible parameters to go in the body for the request <span class="li-required">required: True </li>
        <ul class="ul-self">
              <li><span class="li-head"> name </span> A unique name that can be referenced in other parts of the configuration.<span class="li-normal"> type:string 
                    maxLength:63</span></li>  
              <li><span class="li-head"> account_lockout </span> Enable or disable Account Lockout. <span class="li-normal"> type:string choice:
                      enable,
                      disable</span></li>
              <li><span class="li-head"> max_login_failures </span> Max Login Failures. Only available when 'account_lockout' is enabled.<span class="li-normal"> type:integer
                    maximum:30
                    minimum:1</span></li>
              <li><span class="li-head"> within </span> The number of minutes allowing max login login failures. Only available when 'account_lockout' is enabled.<span class="li-normal"> type:integer
                    maximum:30
                    minimum:1</span></li>
              <li><span class="li-head"> account_block_period </span> Account Block Period. Only available when 'account_lockout' is enabled.<span class="li-normal"> type:integer
                    maximum:3600
                    minimum:1</span></li>
              <li><span class="li-head"> limit_users </span> Enable or disable Limit Concurrent Users Per Account. <span class="li-normal"> type:string choice:
                      enable,
                      disable</span></li>
              <li><span class="li-head"> maximum_users </span> Maximum Concurrent Users. Only available when 'limit_users' is enabled.<span class="li-normal"> type:integer
                    maximum:128
                    minimum:1</span></li>
              <li><span class="li-head"> session_idle_timeout </span>Session Idle Timeout (Unit: minute). Only available when 'limit_users' is enabled.<span class="li-normal"> type:integer
                    maximum:1440
                    minimum:1</span></li>
              <li><span class="li-head"> credential_stuffing_online_query </span> Enable or disable Credential Stuffing Defense. <span class="li-normal"> type:string choice:
                      enable,
                      disable</span></li>
              <li><span class="li-head"> credential_stuffing_protection </span> Enable or disable Credential Stuffing Online Check. <span class="li-normal"> type:string choice:
                      enable,
                      disable</span></li>
              <li><span class="li-head"> match_type </span> Select Match type.<span class="li-normal"> type:string choice:
                      any,
                      all</span></li>       
              <li><span class="li-head"> security_action </span> Select Match type.<span class="li-normal"> type:string choice:
                      alert,
                      deny_no_log,
                      alert_deny,
                      block-period,
                      client-id-block-period,</span></li>
              <li><span class="li-head"> block_period </span> Block Period.  Only available when 'security_action' is 'block-period'.<span class="li-normal"> type:integer
                    maximum:30
                    minimum:1</span></li>
              <li><span class="li-head"> security </span> Select security level.<span class="li-normal"> type:string choice:
                      Info,
                      Low,
                      Medium,
                      High</span></li>
              <li><span class="li-head"> trigger </span> Select the trigger policy, if any, that FortiWeb carries out when it logs and/or sends an alert email about a violation.<span class="li-normal"> type:string 
                    maxLength:255 </span></li>  
        <li><span class="li-head">mkey</span> If present, objects will be filtered on property with this name <span class="li-normal"> type:string </span></li><li><span class="li-head">vdom</span> Specify the Virtual Domain(s) from which results are returned or changes are applied to. If this parameter is not provided, the management VDOM will be used. If the admin does not have access to the VDOM, a permission error will be returned. The URL parameter is one of: vdom=root (Single VDOM) vdom=vdom1,vdom2 (Multiple VDOMs) vdom=* (All VDOMs)   <span class="li-normal"> type:array </span></li><li><span class="li-head">clone_mkey</span> Use *clone_mkey* to specify the ID for the new resource to be cloned.  If *clone_mkey* is set, *mkey* must be provided which is cloned from.   <span class="li-normal"> type:string </span></li>
  </ul>

Examples
--------
.. code-block:: yaml+jinja

 - name:
   hosts: all
   vars:
   connection: httpapi
   gather_facts: false
   tasks:
    - name: add a site_publish policy
      fwebos_waf_site_publish_policy:
        action: add 
        name: pp1
        account_block_period: 600  
        account_lockout: enable 
        security_action: alert_deny
        credential_stuffing_online_query: enable
        credential_stuffing_protection: enable   
        limit_users: enable
        max_login_failures: 5  
        maximum_users: 1  
        session_idle_timeout: 30  
        severity: Medium 
        trigger: tp1
        within: 3  

    - name: get a site_publish policy
      fwebos_waf_site_publish_policy:
        action: get 
        name: pp1

    - name: edit a dlp dictionary
      fwebos_waf_site_publish_policy:
        action: edit 
        name: pp1
        account_lockout: disable 
        security_action: alert

    - name: delete a site_publish
      fwebos_waf_site_publish_policy:
        action: delete 
        name: pp1  


Return Values
-------------
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

.. raw:: html

    <ul><li><span class="li-return"> 200 </span> : OK: Request returns successful</li>
      <li><span class="li-return"> 400 </span> : Bad Request: Request cannot be processed by the API</li>
      <li><span class="li-return"> 401 </span> : Not Authorized: Request without successful login session</li>
      <li><span class="li-return"> 403 </span> : Forbidden: Request is missing CSRF token or administrator is missing access profile permissions.</li>
      <li><span class="li-return"> 404 </span> : Resource Not Found: Unable to find the specified resource.</li>
      <li><span class="li-return"> 405 </span> : Method Not Allowed: Specified HTTP method is not allowed for this resource. </li>
      <li><span class="li-return"> 413 </span> : Request Entity Too Large: Request cannot be processed due to large entity </li>
      <li><span class="li-return"> 424 </span> : Failed Dependency: Fail dependency can be duplicate resource, missing required parameter, missing required attribute, invalid attribute value</li>
      <li><span class="li-return"> 429 </span> : Access temporarily blocked: Maximum failed authentications reached. The offended source is temporarily blocked for certain amount of time.</li>
      <li><span class="li-return"> 500 </span> : Internal Server Error: Internal error when processing the request </li>
      
    </ul>

For errorcode please check FortiWeb API errorcode at : https://documenter.getpostman.com/view/11233300/TVetbkaK#887b9eb4-7c13-4338-a8db-16cc117f0119

Status
------

- This module is not guaranteed to have a backwards compatible interface.


Authors
-------

- Joseph Chen

.. hint::
	If you notice any issues in this documentation, you can create a pull request to improve it.