You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_http module – Configure HTTP protocol options.

Note

This module is part of the fortinet.fortimanager collection (version 2.3.0).

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
access_token string	The token to access FortiManager without using username and password.
adom string / required	the parameter (adom) in requested url
bypass_validation boolean	Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices: false ← (default) true
enable_log boolean	Enable/Disable logging for task. Choices: false ← (default) true
firewall_profileprotocoloptions_http dictionary	the top level parameters set
address-ip-rating string	Enable/disable IP based URL rating. Choices: "disable" "enable"
block-page-status-code integer	Code number returned for blocked HTTP pages
comfort-amount integer	Amount of data to send in a transmission for client comforting
comfort-interval integer	Period of time between start, or last transmission, and the next client comfort transmission of data
fortinet-bar string	Enable/disable Fortinet bar on HTML content. Choices: "disable" "enable"
fortinet-bar-port integer	Port for use by Fortinet Bar
h2c string	Enable/disable h2c HTTP connection upgrade. Choices: "disable" "enable"
http-policy string	Enable/disable HTTP policy check. Choices: "disable" "enable"
inspect-all string	Enable/disable the inspection of all ports for the protocol. Choices: "disable" "enable"
options list / elements=string	no description Choices: "oversize" "chunkedbypass" "clientcomfort" "no-content-summary" "servercomfort"
oversize-limit integer	Maximum in-memory file size that can be scanned
ports any	(list) no description
post-lang list / elements=string	no description 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"
proxy-after-tcp-handshake string	Proxy traffic after the TCP 3-way handshake has been established Choices: "disable" "enable"
range-block string	Enable/disable blocking of partial downloads. Choices: "disable" "enable"
retry-count integer	Number of attempts to retry HTTP connection
scan-bzip2 string	Enable/disable scanning of BZip2 compressed files. Choices: "disable" "enable"
ssl-offloaded string	SSL decryption and encryption performed by an external device. Choices: "no" "yes"
status string	Enable/disable the active status of scanning for this protocol. Choices: "disable" "enable"
stream-based-uncompressed-limit integer	Maximum stream-based uncompressed data size that will be scanned
streaming-content-bypass string	Enable/disable bypassing of streaming content from buffering. Choices: "disable" "enable"
strip-x-forwarded-for string	Enable/disable stripping of HTTP X-Forwarded-For header. Choices: "disable" "enable"
switching-protocols string	Bypass from scanning, or block a connection that attempts to switch protocol. Choices: "bypass" "block"
tcp-window-maximum integer	Maximum dynamic TCP window size
tcp-window-minimum integer	Minimum dynamic TCP window size
tcp-window-size integer	Set TCP static window size
tcp-window-type string	Specify type of TCP window to use for this protocol. Choices: "system" "static" "dynamic" "auto-tuning"
tunnel-non-http string	Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Choices: "disable" "enable"
uncompressed-nest-limit integer	Maximum nested levels of compression that can be uncompressed and scanned
uncompressed-oversize-limit integer	Maximum in-memory uncompressed file size that can be scanned
unknown-content-encoding string	Configure the action the FortiGate unit will take on unknown content-encoding. Choices: "block" "inspect" "bypass"
unknown-http-version string	How to handle HTTP sessions that do not comply with HTTP 0. Choices: "best-effort" "reject" "tunnel"
verify-dns-for-policy-matching string	Enable/disable verification of DNS for policy matching. Choices: "disable" "enable"
forticloud_access_token string	Authenticate Ansible client with forticloud API access token.
profile-protocol-options string / required	the parameter (profile-protocol-options) in requested url
proposed_method string	The overridden method for the underlying Json RPC request. Choices: "update" "set" "add"
rc_failed list / elements=integer	The rc codes list with which the conditions to fail will be overriden.
rc_succeeded list / elements=integer	The rc codes list with which the conditions to succeed will be overriden.
workspace_locking_adom string	The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.
workspace_locking_timeout integer	The maximum time in seconds to wait for other user to release the workspace lock. Default: 300

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: <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]>

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Description
meta dictionary	The result of the request. Returned: always
request_url string	The full url requested. Returned: always Sample: "/sys/login/user"
response_code integer	The status of api request. Returned: always Sample: 0
response_data list / elements=string	The api response. Returned: always
response_message string	The descriptive message of the api response. Returned: always Sample: "OK."
system_information dictionary	The information of the target system. Returned: always
rc integer	The status the request. Returned: always Sample: 0
version_check_warning list / elements=string	Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex

Authors

• Xinwei Du (@dux-fortinet)

• Xing Li (@lix-fortinet)

• Jie Xue (@JieX19)

• Link Zheng (@chillancezen)

• Frank Shen (@fshen01)

• Hongbin Lu (@fgtdev-hblu)

Collection links

• Issue Tracker
• Homepage
• Repository (Sources)