fadcos_error_page – Error page upload in Fortinet’s FortiADC¶

New in version 1.1.0.

Synopsis
Requirements
FortiADC Version Compatibility
Parameters
Examples
Return Values
Status
Authors

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 ¶

	`v7.4.0`
fadcos_error_page	yes

Parameters ¶

action - Type of action to perform on the object. type: str required: true
name - errpage name type: str required: false
srcfile - source file path of error page.type: str required: false
names - error page listtype: list required: false
vpath - upload target pathtype: str required: false default: /fortiadc_error_page/
vdom - VDOM name if enabled.type: str required: true(if VDOM is enabled)

Examples ¶

- 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:

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

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 at: https://github.com/fortinet-ansible-dev/ansible-galaxy-fortiadc-sphinxdoc/pulls