:source: fadcos_error_page.py

:orphan:

.. fadcos_error_page:

fadcos_error_page -- Error page upload in Fortinet's FortiADC
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++

.. versionadded:: 1.1.0

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


Synopsis
--------
- Upload FortiADC Error Page



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

- ansible>=2.8

This module behaves differently across various system environments:

- In Python versions < 3.7, the supported compressed format for uploaded error pages is .tar.

- In Python versions >= 3.7, the supported compressed formats for uploaded error pages are .tar, .zip, and .tar.gz.
- Additionally, this support is restricted to FortiADC systems with versions 7.4.0 and later. 

We recommend users to utilize Python versions 3.7 with FotiADC 7.4.0 and later 

FortiADC Version Compatibility
------------------------------


.. raw:: html

 <br>
 <table>
 <tr>
 <td></td>
 <td><code class="docutils literal notranslate">v7.4.0 </code></td>
 </tr>
 <tr>
 <td>fadcos_error_page</td>
 <td>yes</td>
 </tr>
 </table>
 <p>



Parameters
----------


.. raw:: html

    <ul>
    <li> <span class="li-head">action</span> - Type of action to perform on the object. <span class="li-normal">type: str</span> <span class="li-required">required: true</span> </li>
    <li> <span class="li-head">name</span> - errpage name <span class="li-normal">type: str</span> <span class="li-required">required: false</span> </li>
    <li> <span class="li-head">srcfile</span> - source file path of error page.<span class="li-normal">type: str</span> <span class="li-required">required: false</span></li>
    <li> <span class="li-head">names</span> - error page list<span class="li-normal">type: list</span> <span class="li-required">required: false</span></li>
    <li> <span class="li-head">vpath</span> - upload target path<span class="li-normal">type: str</span> <span class="li-required">required: false</span> <span class="li-normal">default: /fortiadc_error_page/</span> </li>
    <li> <span class="li-head">vdom</span> - VDOM name if enabled.<span class="li-normal">type: str</span> <span class="li-required">required: true(if VDOM is enabled)</span></li>
    </ul>


Examples
--------

.. code-block:: yaml+jinja

        - name:
          hosts: all
          vars:
          connection: httpapi
          gather_facts: false
          tasks:
            - name: add
              fadcos_error_page:
               action: add
               name: test2
               vpath: /fortiadc_error_page/
               srcfile: errpage.tar

            - name: get
              fadcos_error_page:
               action: get

            - name: edit
              fadcos_error_page:
               action: edit
               name: test2
               vpath: /fortiadc_error_pages/

            - name: remove
              fadcos_error_page:
               action: remove
               names:
               - test2

    
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, or 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 FortiADC API errorcode at : https://fndn.fortinet.net/index.php?/fortiapi/981-fortiadc/

Status
------

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


Authors
-------

- Wayne Chou


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