fwebos_json_generic.py – FortiWeb All REST API Requests Sender/Receiver¶
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_content_routing_list.py | yes | yes | yes | yes |
Parameters¶
- body Possible parameters to go in the body for the request required: True
- json_generic The content of request. type:array
- method Type of request sent to the server.
- path URL where the request will be sent.
- jsonbody The body of json object.
- 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
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: Test create server pool
fwebos_json_generic:
vdom: root
json_generic:
method: POST
path: /api/v2.0/cmdb/server-policy/server-pool
jsonbody: {
comment: "999",
hlck-sip: "3.3.3.0/24",
hlck-sip6: "::/0",
lb-algo: "round-robin",
name: "sp3",
server-balance: "disable",
type: "reverse-proxy"
}
- name: Test get server pool
fwebos_json_generic:
vdom: root
json_generic:
method: GET
path: /api/v2.0/cmdb/server-policy/server-pool?mkey=sp3
jsonbody: {
}
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