fmgr_firewall_profileprotocoloptions_http – Configure HTTP protocol options.¶
New in version 2.10.
Synopsis¶
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v6.0.0.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters type: bool required: false default: False
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock type: integer required: false default: 300
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden type: list required: false
- adom - The parameter in requested url type: str required: true
- profile-protocol-options - The parameter in requested url type: str required: true
- firewall_profileprotocoloptions_http - Configure HTTP protocol options. type: dict
- block-page-status-code - Code number returned for blocked HTTP pages (non-FortiGuard only) (100 - 599, default = 403). type: int
- comfort-amount - Amount of data to send in a transmission for client comforting (1 - 10240 bytes, default = 1). type: int
- comfort-interval - Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, default = 10). type: int
- fortinet-bar - Enable/disable Fortinet bar on HTML content. type: str choices: [disable, enable]
- fortinet-bar-port - Port for use by Fortinet Bar (1 - 65535, default = 8011). type: int
- http-policy - Enable/disable HTTP policy check. type: str choices: [disable, enable]
- inspect-all - Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable]
- options - No description for the parameter type: array choices: [oversize, chunkedbypass, clientcomfort, no-content-summary, servercomfort]
- oversize-limit - Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). type: int
- ports - No description for the parameter type: int
- post-lang - No description for the parameter type: array choices: [jisx0201, jisx0208, jisx0212, gb2312, ksc5601-ex, euc-jp, sjis, iso2022-jp, iso2022-jp-1, iso2022-jp-2, euc-cn, ces-gbk, hz, ces-big5, euc-kr, iso2022-jp-3, iso8859-1, tis620, cp874, cp1252, cp1251]
- range-block - Enable/disable blocking of partial downloads. type: str choices: [disable, enable]
- retry-count - Number of attempts to retry HTTP connection (0 - 100, default = 0). type: int
- scan-bzip2 - Enable/disable scanning of BZip2 compressed files. type: str choices: [disable, enable]
- status - Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable]
- streaming-content-bypass - Enable/disable bypassing of streaming content from buffering. type: str choices: [disable, enable]
- strip-x-forwarded-for - Enable/disable stripping of HTTP X-Forwarded-For header. type: str choices: [disable, enable]
- switching-protocols - Bypass from scanning, or block a connection that attempts to switch protocol. type: str choices: [bypass, block]
- uncompressed-nest-limit - Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int
- uncompressed-oversize-limit - Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). type: int
Notes¶
Note
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples¶
- hosts: fortimanager-inventory
collections:
- fortinet.fortimanager
connection: httpapi
vars:
ansible_httpapi_use_ssl: True
ansible_httpapi_validate_certs: False
ansible_httpapi_port: 443
tasks:
- name: Configure HTTP protocol options.
fmgr_firewall_profileprotocoloptions_http:
bypass_validation: False
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
rc_succeeded: [0, -2, -3, ...]
rc_failed: [-2, -3, ...]
adom: <your own value>
profile-protocol-options: <your own value>
firewall_profileprotocoloptions_http:
block-page-status-code: <value of integer>
comfort-amount: <value of integer>
comfort-interval: <value of integer>
fortinet-bar: <value in [disable, enable]>
fortinet-bar-port: <value of integer>
http-policy: <value in [disable, enable]>
inspect-all: <value in [disable, enable]>
options:
- oversize
- chunkedbypass
- clientcomfort
- no-content-summary
- servercomfort
oversize-limit: <value of integer>
ports: <value of integer>
post-lang:
- jisx0201
- jisx0208
- jisx0212
- gb2312
- ksc5601-ex
- euc-jp
- sjis
- iso2022-jp
- iso2022-jp-1
- iso2022-jp-2
- euc-cn
- ces-gbk
- hz
- ces-big5
- euc-kr
- iso2022-jp-3
- iso8859-1
- tis620
- cp874
- cp1252
- cp1251
range-block: <value in [disable, enable]>
retry-count: <value of integer>
scan-bzip2: <value in [disable, enable]>
status: <value in [disable, enable]>
streaming-content-bypass: <value in [disable, enable]>
strip-x-forwarded-for: <value in [disable, enable]>
switching-protocols: <value in [bypass, block]>
uncompressed-nest-limit: <value of integer>
uncompressed-oversize-limit: <value of integer>
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:
- request_url - The full url requested returned: always type: str sample: /sys/login/user
- response_code - The status of api request returned: always type: int sample: 0
- response_message - The descriptive message of the api response returned: always type: str sample: OK
- response_data - The data body of the api response returned: optional type: list or dict