fwebos_waf_file_upload_policy.py – Config FortiWeb Input Validation File Security¶
New in version 1.0.1.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.11
FortiWeb Version Compatibility¶
v7.0.x |
v7.2.x |
v7.4.x |
v7.6.x |
|
| fwebos_waf_file_upload_policy.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- name name type:string maxLength:63
- action action type:string choice: alert, deny_no_log, alert_deny, block-period, client-id-block-period,
- block-period block period(1-3600) type:integer maximum:3600 minimum:1
- severity severity:High, Medium, Low or Informative type:string choice: High, Medium, Low, Info,
- trigger choose Email or syslog policy type:string
- av-scan AV scan upload file type:string choice: enable, disable,
- fortisandbox-check Upload suspicious file to FortiSandbox type:string choice: enable, disable,
- hold-session-while-scanning-file Hold session while scanning file type:string choice: enable, disable,
- icap-server-check Upload suspicious file to icap server type:string choice: enable, disable,
- exchange-mail-detection AV detection for Exchange email type:string choice: enable, disable,
- owa-protocol Exchange email for OWA protocol type:string choice: enable, disable,
- activesync-protocol Exchange email for ActiveSync protocol type:string choice: enable, disable,
- mapi-protocol Exchange email for mapi protocol type:string choice: enable, disable,
- rule rule type:array
-
- file-upload-restriction-rule file-upload-restriction-rule
-
- mkey If present, objects will be filtered on property with this name type:string
- vdom 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) type:array
- clone_mkey 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. type:string
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: delete
fwebos_waf_file_upload_policy:
action: delete
name: aaa
vdom: root
- name: Create
fwebos_waf_file_upload_policy:
action: add
vdom: root
block_period: 600
severity: Medium
av_scan: disable
icap_server_check: disable
name: test4
fortisandbox_check: disable
exchange_mail_detection: disable
file_action: alert
hold_session_while_scanning_file: disable
- name: edit
fwebos_waf_file_upload_policy:
action: edit
vdom: root
block_period: 600
severity: Medium
av_scan: disable
icap_server_check: disable
name: test4
fortisandbox_check: disable
exchange_mail_detection: disable
file_action: alert
hold_session_while_scanning_file: disable
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, 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 FortiWeb API errorcode at : https://documenter.getpostman.com/view/11233300/TVetbkaK#887b9eb4-7c13-4338-a8db-16cc117f0119