fwebos_waf_url_rewriting_policy_rule.py – Config FortiWeb URL Rules in a Rewriting Policy¶
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_url_rewriting_policy_rule.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- name The name of the url rewriting policy. type:string maxLength:63
- id The ID of a rule in the url rewriting policy. type:string maxLength:63
- url_rewrite_rule_name The name of the url rewriting rule. type:string maxLength:63
- continue_execution Enable Continue Executing the Next Rule to run this rule together with the next rule, for instance, inserting a custom header together with rewriting a header. If disabled, only the first matched rule in the table will be executed. type:string choice: enable, disable,
- 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 URL rewriting rule in a policy
fwebos_waf_url_rewriting_policy_rule_rule:
action: add
name: rp1
url_rewrite_rule_name: test_rule1
continue_execution: enable
- name: get a URL rewriting rule in a policy
fwebos_waf_url_rewriting_policy_rule_rule:
action: get
name: rp1
id: 1
- name: edit a URL rewriting rule in a policy
fwebos_waf_url_rewriting_policy_rule_rule:
action: edit
name: rp1
id: 1
continue_execution: disable
- name: delete a URL rewriting policy
fwebos_waf_url_rewriting_policy_rule_rule:
action: delete
name: rp1
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