fwebos_ml_based_api_protection_policy_domain.py – Config FortiWeb ML Based API Protection Policy Domain¶
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_ml_based_api_protection_policy.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- policy_id The numerical policy ID of the Server Policy. It is the same one as used in CLI. type:string maxLength:63
- domain_name Domain name. type:string maxLength:255
- domain_id The index of API Protection Domain. type:string maxLength:255
- id The index of Server Policy with ML Based Server 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 ML Based API protection policy domain
fwebos_ml_based_api_protection_policy_domain:
action: add
id: 1
policy_id: 11987745072721173265
domain_name: domain1
- name: get all ML Based API protection policy domain
fwebos_ml_based_api_protection_policy_domain:
action: get
- name: get a ML Based API protection policy domain
fwebos_ml_based_api_protection_policy_domain:
action: get
domain_id: 1
- name: retrain a ML Based API protection policy domain
fwebos_ml_based_api_protection_policy_domain:
action: retrain
domain_id: 1
- name: delete a ML Based API protection policy domain
fwebos_ml_based_api_protection_policy_domain:
action: delete
domain_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