fwebos_waf_http_header_security_policy_exception_item.py – Config FortiWeb HTTP Header Security Policy Exception Item¶
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_http_header_security_policy_exception_item.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- name A unique name that can be referenced in other parts of the configuration. type:string maxLength:63
- client_ip_status Click to enable or disable Client IP exception. type:string choice: enable, disable
- client_ip IPv4/IPv6/IP Range. type:string
- request_url_type Select 'plain' (Simple String) to match the URL of requests with a literal URL specified in Request URL. Select 'regular' (Regular Expression) to match the URL of requests with a regular expression specified in Request URL. type:string choice: plain, regular
- request_url_pattern Request URL. 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 New Secure Header Exception Item
fwebos_waf_http_header_security_policy_exception_item:
action: add
name: e1
client_ip_status: enable
client_ip: 10.2.3.4-10.2.3.55
request_url_type: plain
request_url_pattern: /www.test.com
- name: add a New Secure Header Exception Item
fwebos_waf_http_header_security_policy_exception_item:
action: add
name: e1
request_url_pattern: /www.334455.com
- name: edit a New Secure Header Exception Item
fwebos_waf_http_header_security_policy_exception_item:
action: edit
name: e1
id: 3
client_ip_status: enable
client_ip: 10.2.3.4-10.2.3.55
request_url_type: regular
request_url_pattern: aa11bb
- name: edit a New Secure Header Exception Item
fwebos_waf_http_header_security_policy_exception_item:
action: edit
name: e1
id: 3
client_ip_status: enable
client_ip: 10.2.3.4-10.2.3.55
request_url_type: regular
request_url_pattern: aa11bb
- name: delete a Secure Header Exception Item
fwebos_waf_http_header_security_policy_exception_item:
action: delete
name: e1
id: 4
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