fadcos_waf_file_restriction_rule – Configuring a File Restriction rule¶

New in version 1.3.0.

Synopsis
Requirements
FortiADC Version Compatibility
Parameters
Examples
Return Values
Status
Authors

Synopsis ¶

Configuring a File Restriction rule

Requirements ¶

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

ansible>=2.8

FortiADC Version Compatibility ¶

	`v7.1.4`	`v7.2.2`	`v7.4.0`
fadcos_waf_file_restriction_rule	yes	yes	yes

Parameters ¶

action - Type of action to perform on the object. type: str required: true
name - Specify the name of the type: str required: true
security_action - Specify the action of the File Restriction Rule object.type: str required: false
host_status - Specify status of the host.type: int required: false
severity - Set the severity level in WAF logs of the violations of the file restriction rule object. type: str required: false
url - Specify the URL of file restriction rule object. type: str required: false
upload_file_size - Specify the upload file size. type: str required: false
upload_file_status - Specify the upload file status. type: str required: false
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 file_restriction_rule
      fadcos_waf_file_restriction_rule:
        action: add
        name: test_fr1
        severity: low
        url: /abb/ccd

    - name: edit file_restriction_rule
      fadcos_waf_file_restriction_rule:
        action: edit
        name: test_fr1
        severity: high
        url: /hggg/ccd

    - name: get file_restriction_rule
      fadcos_waf_file_restriction_rule:
        action: get
        name: test_fr1

    - name: delete file_restriction_rule
      fadcos_waf_file_restriction_rule:
        action: delete
        name: test_fr1

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 ¶

Joseph Chen

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