:source: fmgr_firewall_profileprotocoloptions_http.py
:orphan:
.. _fmgr_firewall_profileprotocoloptions_http:
fmgr_firewall_profileprotocoloptions_http -- Configure HTTP protocol options.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. warning::
Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).
- Argument name before 3.0.0: ``var-name``, ``var name``, ``var.name``
- New argument name starting in 3.0.0: ``var_name``
FortiManager Ansible v2.4+ supports both previous argument name and new underscore name.
You will receive deprecation warnings if you keep using the previous argument name.
You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.
.. contents::
:local:
:depth: 1
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 v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v6.0.0 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- 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
- 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
- revision_note - The change note that can be specified when an object is created or updated. type: string 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 (Alias name: block-page-status-code) Code number returned for blocked http pages (non-fortiguard only) (100 - 599, default = 403). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- comfort_amount (Alias name: comfort-amount) Amount of data to send in a transmission for client comforting (1 - 10240 bytes, default = 1). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- comfort_interval (Alias name: 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
more...
Supported Version Ranges: v6.0.0 -> latest
- fortinet_bar (Alias name: fortinet-bar) Enable/disable fortinet bar on html content. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- fortinet_bar_port (Alias name: fortinet-bar-port) Port for use by fortinet bar (1 - 65535, default = 8011). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- http_policy (Alias name: http-policy) Enable/disable http policy check. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> v7.2.1
- inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- options One or more options that can be applied to the session. type: list choices: [oversize, chunkedbypass, clientcomfort, no-content-summary, servercomfort]
more...
Supported Version Ranges: v6.0.0 -> latest
- oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- ports Ports to scan for content (1 - 65535, default = 80). type: list
more...
Supported Version Ranges: v6.0.0 -> latest
- post_lang (Alias name: post-lang) Id codes for character sets to be used to convert to utf-8 for banned words and dlp on http posts (maximum of 5 character sets). type: list 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]
more...
Supported Version Ranges: v6.0.0 -> latest
- range_block (Alias name: range-block) Enable/disable blocking of partial downloads. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- retry_count (Alias name: retry-count) Number of attempts to retry http connection (0 - 100, default = 0). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- streaming_content_bypass (Alias name: streaming-content-bypass) Enable/disable bypassing of streaming content from buffering. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- strip_x_forwarded_for (Alias name: strip-x-forwarded-for) Enable/disable stripping of http x-forwarded-for header. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.0.0 -> latest
- switching_protocols (Alias name: switching-protocols) Bypass from scanning, or block a connection that attempts to switch protocol. type: str choices: [bypass, block]
more...
Supported Version Ranges: v6.0.0 -> latest
- uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int
more...
Supported Version Ranges: v6.0.0 -> latest
- tcp_window_maximum (Alias name: tcp-window-maximum) Maximum dynamic tcp window size (default = 8mb). type: int
more...
Supported Version Ranges: v6.2.0 -> latest
- tcp_window_minimum (Alias name: tcp-window-minimum) Minimum dynamic tcp window size (default = 128kb). type: int
more...
Supported Version Ranges: v6.2.0 -> latest
- tcp_window_size (Alias name: tcp-window-size) Set tcp static window size (default = 256kb). type: int
more...
Supported Version Ranges: v6.2.0 -> latest
- tcp_window_type (Alias name: tcp-window-type) Specify type of tcp window to use for this protocol. type: str choices: [system, static, dynamic, auto-tuning]
more...
Supported Version Ranges: v6.2.0 -> latest
- ssl_offloaded (Alias name: ssl-offloaded) Ssl decryption and encryption performed by an external device. type: str choices: [no, yes]
more...
Supported Version Ranges: v6.2.2 -> latest
- stream_based_uncompressed_limit (Alias name: stream-based-uncompressed-limit) Maximum stream-based uncompressed data size that will be scanned (mb, 0 = unlimited (default). type: int
more...
Supported Version Ranges: v6.2.2 -> latest
- proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.0 -> latest
- tunnel_non_http (Alias name: tunnel-non-http) Configure how to process non-http traffic when a profile configured for http traffic accepts a non-http session. type: str choices: [disable, enable]
more...
Supported Version Ranges: v6.4.0 -> latest
- unknown_http_version (Alias name: unknown-http-version) How to handle http sessions that do not comply with http 0. type: str choices: [best-effort, reject, tunnel]
more...
Supported Version Ranges: v6.4.0 -> latest
- address_ip_rating (Alias name: address-ip-rating) Enable/disable ip based url rating. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.0.4 -> latest
- h2c Enable/disable h2c http connection upgrade. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.0 -> latest
- verify_dns_for_policy_matching (Alias name: verify-dns-for-policy-matching) Enable/disable verification of dns for policy matching. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.1 -> latest
- unknown_content_encoding (Alias name: unknown-content-encoding) Configure the action the fortigate unit will take on unknown content-encoding. type: str choices: [block, inspect, bypass]
more...
Supported Version Ranges: v7.2.2 -> latest
- domain_fronting (Alias name: domain-fronting) Configure http domain fronting (default = block). type: str choices: [block, monitor, allow, disable, enable, strict]
more...
Supported Version Ranges: v7.4.8 -> latest
- http_0_9 (Alias name: http-0.9) Configure action to take upon receipt of http 0. type: str choices: [block, allow]
more...
Supported Version Ranges: v7.6.2 -> latest
- dns_protection (Alias name: dns-protection) Enable/disable dns protection for http/https traffic. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- encrypted_file (Alias name: encrypted-file) Encrypted file. type: str choices: [block, pass, inspect]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
- encrypted_file_log (Alias name: encrypted-file-log) Encrypted file log. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> latest
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
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure HTTP protocol options.
fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_http:
# workspace_locking_adom:
adom:
profile_protocol_options:
firewall_profileprotocoloptions_http:
# block_page_status_code:
# comfort_amount:
# comfort_interval:
# fortinet_bar:
# fortinet_bar_port:
# http_policy:
# inspect_all:
# options: ["oversize", "chunkedbypass", "clientcomfort", "no-content-summary",
# "servercomfort"]
# oversize_limit:
# ports:
# 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:
# retry_count:
# scan_bzip2:
# status:
# streaming_content_bypass:
# strip_x_forwarded_for:
# switching_protocols:
# uncompressed_nest_limit:
# uncompressed_oversize_limit:
# tcp_window_maximum:
# tcp_window_minimum:
# tcp_window_size:
# tcp_window_type:
# ssl_offloaded:
# stream_based_uncompressed_limit:
# proxy_after_tcp_handshake:
# tunnel_non_http:
# unknown_http_version:
# address_ip_rating:
# h2c:
# verify_dns_for_policy_matching:
# unknown_content_encoding:
# domain_fronting:
# http_0_9:
# dns_protection:
# encrypted_file:
# encrypted_file_log:
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:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)