:source: fwebos_waf_csrf_url_rule.py

:orphan:

.. fwebos_waf_csrf_url_rule.py:

fwebos_waf_csrf_url_rule.py -- Config FortiWeb CSRF URL Rule
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 1.0.1

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


Synopsis
--------
Config FortiWeb CSRF URL Rule


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.0 </code></td>
 <td><code class="docutils literal notranslate">v7.0.1 </code></td>
 <td><code class="docutils literal notranslate">v7.0.2 </code></td>
 <td><code class="docutils literal notranslate">v7.0.3 </code></td>
 </tr>
 <tr>
 <td>fwebos_waf_csrf_url_rule.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> name of the CSRF url rule<span class="li-normal"> type:string 
                    maxLength:63</span></li>
              <li><span class="li-head"> host_status </span> Enable to apply this rule only to HTTP requests for specific web hosts. Disable to match the rule based on the URL and any parameter filter only.<span class="li-normal"> type:string choice:
                      enable,
                      disable,</span></li>     
              <li><span class="li-head"> host </span> Select a protected host names entry (either a web host name or IP address).<span class="li-normal"> type:string
                    maxLength:255</span></li>   
              <li><span class="li-head"> request_type </span> Select whether Full URL contains a literal URL (Simple String), or a regular expression designed to match multiple URLs (Regular Expression).<span class="li-normal"> type:string choice:
                      plain,
                      regular,</span></li>
              <li><span class="li-head"> request_url </span> a literal URL or regular expression.<span class="li-normal"> type:string
                    maxLength:255</span></li> 
              <li><span class="li-head"> parameter_filter </span> Select to specify a parameter name and value to match. The parameter can be located in either the URL or the HTTP body of a request.<span class="li-normal"> type:string choice:
                      enable,
                      disable,</span></li>     
              <li><span class="li-head"> parameter_name </span> Enter the parameter name to match.<span class="li-normal"> type:string
                    maxLength:63</span></li> 
              <li><span class="li-head"> parameter_value </span> Enter either a literal URL or regular expression.<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 rule
      fwebos_waf_csrf_url_rule:
       action: add 
       name: c1
       request_type: plain
       host_status: enable
       host: gaogle
       request_url: /myurl.com
       parameter_filter: enable
       parameter_name: p1
       parameter_value_type: regular
       parameter_value: a1b2

    - name: edit a rule
      fwebos_waf_csrf_url_rule:
       action: edit 
       name: c1
       id: 1
       request_type: regular
       parameter_value_type: regular
       host_status: enable
       host: ftnt
       request_url: wwwcc
       parameter_filter: enable
       parameter_name: test
       parameter_value: a1b2

    - name: get a rule
      fwebos_waf_csrf_url_rule:
       action: get 
       name: c1
       id: 1

    - name: delete a rule
      fwebos_waf_csrf_url_rule:
       action: delete 
       name: c1
       id: 1


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.