fadcos_system_vdom – Configure the parameters of each VDOM in Fortinet’s FortiADC¶
New in version 1.1.0.
Parameters¶
- action - Type of action to perform on the object. type: str required: true
- name - Specify the vdom name type: str required: true
- l4cps - The number of layer 4 connections created per second. (0-1000000)type: str required: false default: 0
- l7cps - The number of layer 7 TCP connections created by the httproxy frontend per second. (0-1000000)type: str required: false default: 0
- l7rps - The number of HTTP GET requests handled by the httproxy from the client side per second. (0-1000000)type: str required: false default: 0
- sslcps - The number of SSL connections created by the httproxy frontend per second. (0-1000000)type: str required: false default: 0
- sslthroughput - The volume of SSL encrypted TCP traffic from both the incoming and outgoing side. (0-10000000 Kbps)type: str required: false default: 0
- concurrentsession - The total number of living connections for ADC traffic. (0-1000000)type: str required: false default: 0
- inbound - The maximum volume of inbound traffic allowed. (0-40000000 Kbps)type: str required: false default: 0
- outbound - The maximum volume of outbound traffic allowed. (0-40000000 Kbps)type: str required: false default: 0
- virtual_server - The maximum number of virtual servers. (0-1024)type: str required: false default: 0
- real_server - The maximum number of real servers. (0-1024)type: str required: false default: 0
- health_check - The maximum number of healthcheck members. (0-1024)type: str required: false default: 0
- source_pool - The maximum number of IP pools. (0-1024)type: str required: false default: 0
- error_page - The maximum number of error page files. (0-1024)type: str required: false default: 0
- local_user - The maximum number of local users. (0-1024)type: str required: false default: 0
- user_group - The maximum number of user groups. (0-1024)type: str required: false default: 0
Examples¶
- name:
hosts: all
vars:
connection: httpapi
gather_facts: false
tasks:
- name: edit
fadcos_system_vdom:
action: edit
name: vd1
l4cps: 1
l7cps: 1
l7rps: 1
sslcps: 1
sslthroughput: 1
concurrentsession: 1
inbound: 1
outbound: 1
virtual_server: 1
real_server: 1
health_check: 4
source_pool: 1
error_page: 1
local_user: 1
user_group: 1
- name: get
fadcos_system_vdom:
action: get
name: vd1
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, or 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 FortiADC API errorcode at : https://fndn.fortinet.net/index.php?/fortiapi/981-fortiadc/
Authors¶
- Wayne Chou
Hint
If you notice any issues in this documentation, you can create a pull request to improve it at: https://github.com/fortinet-ansible-dev/ansible-galaxy-fortiadc-sphinxdoc/pulls