fortinet.fortimanager.fmgr_firewall_profileprotocoloptions_http – Configure HTTP protocol options.

Note

This plugin is part of the fortinet.fortimanager collection (version 2.0.1).

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 version 2.10: of fortinet.fortimanager

Synopsis
Parameters
Notes
Examples
Return Values

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		Choices/Defaults	Comments
adom string / required			the parameter (adom) in requested url
bypass_validation boolean		no ← yes	only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
firewall_profileprotocoloptions_http dictionary			the top level parameters set
	block-page-status-code integer		Code number returned for blocked HTTP pages (non-FortiGuard only) (100 - 599, default = 403).
	comfort-amount integer		Amount of data to send in a transmission for client comforting (1 - 10240 bytes, default = 1).
	comfort-interval integer		Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, default = 10).
	fortinet-bar string	disable enable	Enable/disable Fortinet bar on HTML content.
	fortinet-bar-port integer		Port for use by Fortinet Bar (1 - 65535, default = 8011).
	http-policy string	disable enable	Enable/disable HTTP policy check.
	inspect-all string	disable enable	Enable/disable the inspection of all ports for the protocol.
	options list / elements=string	oversize chunkedbypass clientcomfort no-content-summary servercomfort	no description
	oversize-limit integer		Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10).
	ports integer		no description
	post-lang list / elements=string	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	no description
	range-block string	disable enable	Enable/disable blocking of partial downloads.
	retry-count integer		Number of attempts to retry HTTP connection (0 - 100, default = 0).
	scan-bzip2 string	disable enable	Enable/disable scanning of BZip2 compressed files.
	status string	disable enable	Enable/disable the active status of scanning for this protocol.
	streaming-content-bypass string	disable enable	Enable/disable bypassing of streaming content from buffering.
	strip-x-forwarded-for string	disable enable	Enable/disable stripping of HTTP X-Forwarded-For header.
	switching-protocols string	bypass block	Bypass from scanning, or block a connection that attempts to switch protocol.
	uncompressed-nest-limit integer		Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12).
	uncompressed-oversize-limit integer		Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
profile-protocol-options string / required			the parameter (profile-protocol-options) in requested url
rc_failed list / elements=string			the rc codes list with which the conditions to fail will be overriden
rc_succeeded list / elements=string			the rc codes list with which the conditions to succeed will be overriden
state string / required		present absent	the directive to create, update or delete an object
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		Default: 300	the maximum time in seconds to wait for other user to release the workspace lock

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 here, the following are the fields unique to this module:

Key	Returned	Description
request_url string	always	The full url requested Sample: /sys/login/user
response_code integer	always	The status of api request
response_message string	always	The descriptive message of the api response Sample: OK.

Authors

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

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_firewall_profileprotocoloptions_http_module.html