fwebos_bot_detection_exception.py – Config FortiWeb Bot Detection Policy Exceptions¶
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_bot_detection_exception.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- id The numerical ID of Limit Sample Collections From IPs. type:string maxLength:63
- policy_id The numerical ID of Server Policy. type:string maxLength:63
- host_status Host Status. type:string choice: enable, disable
- url_type Sample Count. type:string choice: regular, plain
- url_pattern URL Pattern. 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 exception
fwebos_bot_detection_exception:
action: add
policy_id: 2
host_status: enable
url_type: plain
host: a_host
url_pattern: /url_1/url_2/
- name: edit a bot detection policy exception
fwebos_bot_detection_exception:
action: edit
policy_id: 2
id: 1
host_status: enable
url_type: regular
host: a_host_1
url_pattern: /url_1/url_2/abc/
- name: get a bot detection policy exception
fwebos_bot_detection_exception:
action: get
policy_id: 2
id: 1
- name: delete a bot detection policy exception
fwebos_bot_detection_exception:
action: delete
policy_id: 2
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