:source: fwebos_waf_http_header_security_policy_exception_item.py

:orphan:

.. fwebos_waf_http_header_security_policy_exception_item.py:

fwebos_waf_http_header_security_policy_exception_item.py -- Config FortiWeb HTTP Header Security Policy Exception Item
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 1.0.1

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


Synopsis
--------
Config FortiWeb HTTP Header Security Policy Exception Item


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_http_header_security_policy_exception_item.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"> client_ip_status </span> Click to enable or disable Client IP exception.<span class="li-normal"> type:string choice:
                      enable,
                      disable</span></li> 
              <li><span class="li-head"> client_ip </span> IPv4/IPv6/IP Range. <span class="li-normal"> type:string </span></li>                 
              <li><span class="li-head"> request_url_type </span> Select 'plain' (Simple String) to match the URL of requests with a literal URL specified in Request URL. Select 'regular' (Regular Expression) to match the URL of requests with a regular expression specified in Request URL. <span class="li-normal"> type:string choice:
                      plain,
                      regular</span></li> 
              <li><span class="li-head"> request_url_pattern </span> Request URL. <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 New Secure Header Exception Item
      fwebos_waf_http_header_security_policy_exception_item:
       action: add 
       name: e1
       client_ip_status: enable
       client_ip: 10.2.3.4-10.2.3.55
       request_url_type: plain
       request_url_pattern: /www.test.com

    - name: add a New Secure Header Exception Item
      fwebos_waf_http_header_security_policy_exception_item:
       action: add 
       name: e1
       request_url_pattern: /www.334455.com

    - name: edit a New Secure Header Exception Item
      fwebos_waf_http_header_security_policy_exception_item:
       action: edit 
       name: e1
       id: 3
       client_ip_status: enable
       client_ip: 10.2.3.4-10.2.3.55
       request_url_type: regular
       request_url_pattern: aa11bb

    - name: edit a New Secure Header Exception Item
      fwebos_waf_http_header_security_policy_exception_item:
       action: edit 
       name: e1
       id: 3
       client_ip_status: enable
       client_ip: 10.2.3.4-10.2.3.55
       request_url_type: regular
       request_url_pattern: aa11bb

    - name: delete a Secure Header Exception Item
      fwebos_waf_http_header_security_policy_exception_item:
       action: delete 
       name: e1
       id: 4

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.