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.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0 7.2.0
firewall_profileprotocoloptions_http yes yes yes yes yes yes yes yes yes

Parameters

  • 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
  • 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 - no description type: dict
    • block-page-status-code - Code number returned for blocked HTTP pages (non-FortiGuard only) (100 - 599, default = 403). type: int more...
    • comfort-amount - Amount of data to send in a transmission for client comforting (1 - 10240 bytes, default = 1). type: int more...
    • 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...
    • fortinet-bar - Enable/disable Fortinet bar on HTML content. type: str choices: [disable, enable] more...
    • fortinet-bar-port - Port for use by Fortinet Bar (1 - 65535, default = 8011). type: int more...
    • http-policy - Enable/disable HTTP policy check. type: str choices: [disable, enable] more...
    • inspect-all - Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
    • options - No description for the parameter type: array choices: [oversize, chunkedbypass, clientcomfort, no-content-summary, servercomfort] more...
    • oversize-limit - Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). type: int more...
    • ports - No description for the parameter type: int more...
    • 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] more...
    • range-block - Enable/disable blocking of partial downloads. type: str choices: [disable, enable] more...
    • retry-count - Number of attempts to retry HTTP connection (0 - 100, default = 0). type: int more...
    • scan-bzip2 - Enable/disable scanning of BZip2 compressed files. type: str choices: [disable, enable] more...
    • status - Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
    • streaming-content-bypass - Enable/disable bypassing of streaming content from buffering. type: str choices: [disable, enable] more...
    • strip-x-forwarded-for - Enable/disable stripping of HTTP X-Forwarded-For header. type: str choices: [disable, enable] more...
    • switching-protocols - Bypass from scanning, or block a connection that attempts to switch protocol. type: str choices: [bypass, block] more...
    • uncompressed-nest-limit - Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
    • uncompressed-oversize-limit - Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). type: int more...
    • tcp-window-maximum - Maximum dynamic TCP window size (default = 8MB). type: int more...
    • tcp-window-minimum - Minimum dynamic TCP window size (default = 128KB). type: int more...
    • tcp-window-size - Set TCP static window size (default = 256KB). type: int more...
    • tcp-window-type - Specify type of TCP window to use for this protocol. type: str choices: [system, static, dynamic, auto-tuning] more...
    • ssl-offloaded - SSL decryption and encryption performed by an external device. type: str choices: [no, yes] more...
    • stream-based-uncompressed-limit - Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). type: int more...
    • proxy-after-tcp-handshake - Proxy traffic after the TCP 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
    • 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...
    • unknown-http-version - How to handle HTTP sessions that do not comply with HTTP 0. type: str choices: [best-effort, reject, tunnel] more...
    • address-ip-rating - Enable/disable IP based URL rating. type: str choices: [disable, enable] more...
    • h2c - Enable/disable h2c HTTP connection upgrade. type: str choices: [disable, enable] more...

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: no description
     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>
           tcp-window-maximum: <value of integer>
           tcp-window-minimum: <value of integer>
           tcp-window-size: <value of integer>
           tcp-window-type: <value in [system, static, dynamic, ...]>
           ssl-offloaded: <value in [no, yes]>
           stream-based-uncompressed-limit: <value of 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]>

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

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.