fwebos_bot_detection.py – Config FortiWeb Bot Detection Policy¶
New in version 1.0.1.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.11
Parameters¶
- body Possible parameters to go in the body for the request required: True
- id The numerical index of bot detection policy. type:string maxLength:63
- policy_id The numerical policy ID of the Server Policy. It is the same one as used in CLI. type:string maxLength:63
- allow_ip Limit Sample Collections From IPs. type:list maxLength:63
- advanced_mode Enable or disable Advanced Mode. type:string choice: enable, disable
- client_identification_method Client Identification Method. type:string choice: IP-and-User-Agent, IP, Cookie
- sampling_count Sample Count. type:integer maximum:1000 minimum:1
- sampling_count_per_client Sample Count per Client per Hour. type:integer maximum:60 minimum:1
- sampling_time_per_vector Sampling Time per Vector. type:integer maximum:10 minimum:1
- selected_model Model Type for Model Building Settings. type:string choice: Strict, Moderate
- anomaly_count Anomaly Count. type:integer maximum:65535 minimum:1
- bot_confirmation Enable or disable Bot Confirmation. type:string choice: enable, disable
- verification_method Bot Verification Method. type:string choice: Real-Browser-Enforement, Disable, Captcha-Enforcement
- security Select security level. type:string choice: Info, Low, Medium, High
- security_action Choose the action FortiWeb takes when a user client is confirmed as a bot. type:string choice: alert, deny_no_log, alert_deny, block-period, client-id-block-period,
- block_period Block Period. type:integer maximum:3600 minimum:1
- security Select security level. type:string choice: Info, Low, Medium, High
- trigger Select the trigger policy, if any, that FortiWeb carries out when it logs and/or sends an alert email about a violation. type:string maxLength:255
- global_exception Select New Bot Mitigation Exception Policy. type:string maxLength:255
- 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: add a bot detection policy
fwebos_bot_detection:
action: add
policy_id: 6814698978843458079
allow_ip:
- 11.2.3.4
- 192.168.253.1
- name: get a bot detection policy
fwebos_bot_detection:
action: get
id: 1
- name: edit a bot detection policy
fwebos_bot_detection:
action: edit
id: 1
anomaly_count: 14456
sampling_count: 999
security_action: alert_deny
- name: delete a bot detection policy
fwebos_bot_detection:
action: delete
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:
- 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