fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_http module – Configure HTTP protocol options.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.2).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_http.
New in fortinet.fortimanager 2.0.0
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Enable/disable IP based URL rating. Choices:
|
|
Code number returned for blocked HTTP pages |
|
Amount of data to send in a transmission for client comforting |
|
Period of time between start, or last transmission, and the next client comfort transmission of data |
|
Configure HTTP domain fronting Choices:
|
|
Enable/disable Fortinet bar on HTML content. Choices:
|
|
Port for use by Fortinet Bar |
|
Enable/disable h2c HTTP connection upgrade. Choices:
|
|
Enable/disable HTTP policy check. Choices:
|
|
Enable/disable the inspection of all ports for the protocol. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned |
|
(list) Ports to scan for content |
|
ID codes for character sets to be used to convert to UTF-8 for banned words and DLP on HTTP posts Choices:
|
|
Proxy traffic after the TCP 3-way handshake has been established Choices:
|
|
Enable/disable blocking of partial downloads. Choices:
|
|
Number of attempts to retry HTTP connection |
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
SSL decryption and encryption performed by an external device. Choices:
|
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum stream-based uncompressed data size that will be scanned |
|
Enable/disable bypassing of streaming content from buffering. Choices:
|
|
Enable/disable stripping of HTTP X-Forwarded-For header. Choices:
|
|
Bypass from scanning, or block a connection that attempts to switch protocol. Choices:
|
|
Maximum dynamic TCP window size |
|
Minimum dynamic TCP window size |
|
Set TCP static window size |
|
Specify type of TCP window to use for this protocol. Choices:
|
|
Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned |
|
Maximum in-memory uncompressed file size that can be scanned |
|
Configure the action the FortiGate unit will take on unknown content-encoding. Choices:
|
|
How to handle HTTP sessions that do not comply with HTTP 0. Choices:
|
|
Enable/disable verification of DNS for policy matching. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
Deprecated, please use “profile_protocol_options” |
|
The parameter (profile-protocol-options) in requested url. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
Notes
Note
Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.
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.
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
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure HTTP protocol options.
fortinet.fortimanager.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: <integer>
comfort_amount: <integer>
comfort_interval: <integer>
fortinet_bar: <value in [disable, enable]>
fortinet_bar_port: <integer>
http_policy: <value in [disable, enable]>
inspect_all: <value in [disable, enable]>
options:
- "oversize"
- "chunkedbypass"
- "clientcomfort"
- "no-content-summary"
- "servercomfort"
oversize_limit: <integer>
ports: <list or 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: <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: <integer>
uncompressed_oversize_limit: <integer>
tcp_window_maximum: <integer>
tcp_window_minimum: <integer>
tcp_window_size: <integer>
tcp_window_type: <value in [system, static, dynamic, ...]>
ssl_offloaded: <value in [no, yes]>
stream_based_uncompressed_limit: <integer>
proxy_after_tcp_handshake: <value in [disable, enable]>
tunnel_non_http: <value in [disable, enable]>
unknown_http_version: <value in [best-effort, reject, tunnel]>
address_ip_rating: <value in [disable, enable]>
h2c: <value in [disable, enable]>
verify_dns_for_policy_matching: <value in [disable, enable]>
unknown_content_encoding: <value in [block, inspect, bypass]>
domain_fronting: <value in [block, monitor, allow]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |