W3cubDocs

/Ansible

fortinet.fortios.fortios_firewall_profile_protocol_options – Configure protocol options in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.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.fortios.

To use it in a playbook, specify: fortinet.fortios.fortios_firewall_profile_protocol_options.

New in version 2.10: of fortinet.fortios

Synopsis

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and profile_protocol_options category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

Requirements

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

  • ansible>=2.9.0

Parameters

Parameter Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
firewall_profile_protocol_options
dictionary
Configure protocol options.
cifs
dictionary
Configure CIFS protocol options.
domain_controller
string
Domain for which to decrypt CIFS traffic. Source credential-store.domain-controller.server-name.
options
list / elements=string
    Choices:
  • oversize
One or more options that can be applied to the session.
oversize_limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB).
ports
integer
Ports to scan for content (1 - 65535).
scan_bzip2
string
    Choices:
  • enable
  • disable
Enable/disable scanning of BZip2 compressed files.
server_credential_type
string
    Choices:
  • none
  • credential-replication
  • credential-keytab
CIFS server credential type.
server_keytab
string
Server keytab.
keytab
string
Base64 encoded keytab file containing credential of the server.
principal
string / required
Service principal. For example, "host/[email protected]".
status
string
    Choices:
  • enable
  • disable
Enable/disable the active status of scanning for this protocol.
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
    Choices:
  • system
  • static
  • dynamic
Specify type of TCP window to use for this protocol.
uncompressed_nest_limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100).
uncompressed_oversize_limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited).
comment
string
Optional comments.
dns
dictionary
Configure DNS protocol options.
ports
integer
Ports to scan for content (1 - 65535).
status
string
    Choices:
  • enable
  • disable
Enable/disable the active status of scanning for this protocol.
ftp
dictionary
Configure FTP protocol options.
comfort_amount
integer
Amount of data to send in a transmission for client comforting (1 - 10240 bytes).
comfort_interval
integer
Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec).
inspect_all
string
    Choices:
  • enable
  • disable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • clientcomfort
  • oversize
  • splice
  • bypass-rest-command
  • bypass-mode-command
One or more options that can be applied to the session.
oversize_limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB).
ports
integer
Ports to scan for content (1 - 65535).
scan_bzip2
string
    Choices:
  • enable
  • disable
Enable/disable scanning of BZip2 compressed files.
ssl_offloaded
string
    Choices:
  • False
  • True
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • enable
  • disable
Enable/disable the active status of scanning for this protocol.
stream_based_uncompressed_limit
integer
Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based uncompression used only under certain conditions.).
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
    Choices:
  • system
  • static
  • dynamic
TCP window type to use for this protocol.
uncompressed_nest_limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100).
uncompressed_oversize_limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited).
http
dictionary
Configure HTTP protocol options.
block_page_status_code
integer
Code number returned for blocked HTTP pages (non-FortiGuard only) (100 - 599).
comfort_amount
integer
Amount of data to send in a transmission for client comforting (1 - 10240 bytes).
comfort_interval
integer
Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec).
fortinet_bar
string
    Choices:
  • enable
  • disable
Enable/disable Fortinet bar on HTML content.
fortinet_bar_port
integer
Port for use by Fortinet Bar (1 - 65535).
http_policy
string
    Choices:
  • disable
  • enable
Enable/disable HTTP policy check.
inspect_all
string
    Choices:
  • enable
  • disable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • clientcomfort
  • servercomfort
  • oversize
  • chunkedbypass
One or more options that can be applied to the session.
oversize_limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB).
ports
integer
Ports to scan for content (1 - 65535).
post_lang
list / elements=string
    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
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).
proxy_after_tcp_handshake
string
    Choices:
  • enable
  • disable
Proxy traffic after the TCP 3-way handshake has been established (not before).
range_block
string
    Choices:
  • disable
  • enable
Enable/disable blocking of partial downloads.
retry_count
integer
Number of attempts to retry HTTP connection (0 - 100).
scan_bzip2
string
    Choices:
  • enable
  • disable
Enable/disable scanning of BZip2 compressed files.
ssl_offloaded
string
    Choices:
  • False
  • True
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • enable
  • disable
Enable/disable the active status of scanning for this protocol.
stream_based_uncompressed_limit
integer
Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based uncompression used only under certain conditions.).
streaming_content_bypass
string
    Choices:
  • enable
  • disable
Enable/disable bypassing of streaming content from buffering.
strip_x_forwarded_for
string
    Choices:
  • disable
  • enable
Enable/disable stripping of HTTP X-Forwarded-For header.
switching_protocols
string
    Choices:
  • bypass
  • block
Bypass from scanning, or block a connection that attempts to switch protocol.
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
    Choices:
  • system
  • static
  • dynamic
Specify type of TCP window to use for this protocol.
tunnel_non_http
string
    Choices:
  • enable
  • disable
Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Can occur if an application sends non-HTTP traffic using an HTTP destination port.
uncompressed_nest_limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100).
uncompressed_oversize_limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited).
unknown_http_version
string
    Choices:
  • reject
  • tunnel
  • best-effort
How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1.
imap
dictionary
Configure IMAP protocol options.
inspect_all
string
    Choices:
  • enable
  • disable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • fragmail
  • oversize
One or more options that can be applied to the session.
oversize_limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB).
ports
integer
Ports to scan for content (1 - 65535).
proxy_after_tcp_handshake
string
    Choices:
  • enable
  • disable
Proxy traffic after the TCP 3-way handshake has been established (not before).
scan_bzip2
string
    Choices:
  • enable
  • disable
Enable/disable scanning of BZip2 compressed files.
ssl_offloaded
string
    Choices:
  • False
  • True
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • enable
  • disable
Enable/disable the active status of scanning for this protocol.
uncompressed_nest_limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100).
uncompressed_oversize_limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited).
mail_signature
dictionary
Configure Mail signature.
signature
string
Email signature to be added to outgoing email (if the signature contains spaces, enclose with quotation marks).
status
string
    Choices:
  • disable
  • enable
Enable/disable adding an email signature to SMTP email messages as they pass through the FortiGate.
mapi
dictionary
Configure MAPI protocol options.
options
list / elements=string
    Choices:
  • fragmail
  • oversize
One or more options that can be applied to the session.
oversize_limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB).
ports
integer
Ports to scan for content (1 - 65535).
scan_bzip2
string
    Choices:
  • enable
  • disable
Enable/disable scanning of BZip2 compressed files.
status
string
    Choices:
  • enable
  • disable
Enable/disable the active status of scanning for this protocol.
uncompressed_nest_limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100).
uncompressed_oversize_limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited).
name
string / required
Name.
nntp
dictionary
Configure NNTP protocol options.
inspect_all
string
    Choices:
  • enable
  • disable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • oversize
  • splice
One or more options that can be applied to the session.
oversize_limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB).
ports
integer
Ports to scan for content (1 - 65535).
proxy_after_tcp_handshake
string
    Choices:
  • enable
  • disable
Proxy traffic after the TCP 3-way handshake has been established (not before).
scan_bzip2
string
    Choices:
  • enable
  • disable
Enable/disable scanning of BZip2 compressed files.
status
string
    Choices:
  • enable
  • disable
Enable/disable the active status of scanning for this protocol.
uncompressed_nest_limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100).
uncompressed_oversize_limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited).
oversize_log
string
    Choices:
  • disable
  • enable
Enable/disable logging for antivirus oversize file blocking.
pop3
dictionary
Configure POP3 protocol options.
inspect_all
string
    Choices:
  • enable
  • disable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • fragmail
  • oversize
One or more options that can be applied to the session.
oversize_limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB).
ports
integer
Ports to scan for content (1 - 65535).
proxy_after_tcp_handshake
string
    Choices:
  • enable
  • disable
Proxy traffic after the TCP 3-way handshake has been established (not before).
scan_bzip2
string
    Choices:
  • enable
  • disable
Enable/disable scanning of BZip2 compressed files.
ssl_offloaded
string
    Choices:
  • False
  • True
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • enable
  • disable
Enable/disable the active status of scanning for this protocol.
uncompressed_nest_limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100).
uncompressed_oversize_limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited).
replacemsg_group
string
Name of the replacement message group to be used Source system.replacemsg-group.name.
rpc_over_http
string
    Choices:
  • enable
  • disable
Enable/disable inspection of RPC over HTTP.
smtp
dictionary
Configure SMTP protocol options.
inspect_all
string
    Choices:
  • enable
  • disable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • fragmail
  • oversize
  • splice
One or more options that can be applied to the session.
oversize_limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB).
ports
integer
Ports to scan for content (1 - 65535).
proxy_after_tcp_handshake
string
    Choices:
  • enable
  • disable
Proxy traffic after the TCP 3-way handshake has been established (not before).
scan_bzip2
string
    Choices:
  • enable
  • disable
Enable/disable scanning of BZip2 compressed files.
server_busy
string
    Choices:
  • enable
  • disable
Enable/disable SMTP server busy when server not available.
ssl_offloaded
string
    Choices:
  • False
  • True
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • enable
  • disable
Enable/disable the active status of scanning for this protocol.
uncompressed_nest_limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100).
uncompressed_oversize_limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited).
ssh
dictionary
Configure SFTP and SCP protocol options.
comfort_amount
integer
Amount of data to send in a transmission for client comforting (1 - 65535 bytes).
comfort_interval
integer
Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec).
options
list / elements=string
    Choices:
  • oversize
  • clientcomfort
  • servercomfort
One or more options that can be applied to the session.
oversize_limit
integer
Maximum in-memory file size that can be scanned (1 - 383 MB).
scan_bzip2
string
    Choices:
  • enable
  • disable
Enable/disable scanning of BZip2 compressed files.
ssl_offloaded
string
    Choices:
  • False
  • True
SSL decryption and encryption performed by an external device.
stream_based_uncompressed_limit
integer
Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based uncompression used only under certain conditions.).
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
    Choices:
  • system
  • static
  • dynamic
TCP window type to use for this protocol.
uncompressed_nest_limit
integer
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100).
uncompressed_oversize_limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited).
switching_protocols_log
string
    Choices:
  • disable
  • enable
Enable/disable logging for HTTP/HTTPS switching protocols.
state
string / required
    Choices:
  • present
  • absent
Indicates whether to create or remove the object.
vdom
string
Default:
"root"
Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit.

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure protocol options.
    fortios_firewall_profile_protocol_options:
      vdom:  "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_profile_protocol_options:
        cifs:
            domain_controller: "<your_own_value> (source credential-store.domain-controller.server-name)"
            options: "oversize"
            oversize_limit: "6"
            ports: "7"
            scan_bzip2: "enable"
            server_credential_type: "none"
            server_keytab:
             -
                keytab: "<your_own_value>"
                principal: "<your_own_value>"
            status: "enable"
            tcp_window_maximum: "14"
            tcp_window_minimum: "15"
            tcp_window_size: "16"
            tcp_window_type: "system"
            uncompressed_nest_limit: "18"
            uncompressed_oversize_limit: "19"
        comment: "Optional comments."
        dns:
            ports: "22"
            status: "enable"
        ftp:
            comfort_amount: "25"
            comfort_interval: "26"
            inspect_all: "enable"
            options: "clientcomfort"
            oversize_limit: "29"
            ports: "30"
            scan_bzip2: "enable"
            ssl_offloaded: "no"
            status: "enable"
            stream_based_uncompressed_limit: "34"
            tcp_window_maximum: "35"
            tcp_window_minimum: "36"
            tcp_window_size: "37"
            tcp_window_type: "system"
            uncompressed_nest_limit: "39"
            uncompressed_oversize_limit: "40"
        http:
            block_page_status_code: "42"
            comfort_amount: "43"
            comfort_interval: "44"
            fortinet_bar: "enable"
            fortinet_bar_port: "46"
            http_policy: "disable"
            inspect_all: "enable"
            options: "clientcomfort"
            oversize_limit: "50"
            ports: "51"
            post_lang: "jisx0201"
            proxy_after_tcp_handshake: "enable"
            range_block: "disable"
            retry_count: "55"
            scan_bzip2: "enable"
            ssl_offloaded: "no"
            status: "enable"
            stream_based_uncompressed_limit: "59"
            streaming_content_bypass: "enable"
            strip_x_forwarded_for: "disable"
            switching_protocols: "bypass"
            tcp_window_maximum: "63"
            tcp_window_minimum: "64"
            tcp_window_size: "65"
            tcp_window_type: "system"
            tunnel_non_http: "enable"
            uncompressed_nest_limit: "68"
            uncompressed_oversize_limit: "69"
            unknown_http_version: "reject"
        imap:
            inspect_all: "enable"
            options: "fragmail"
            oversize_limit: "74"
            ports: "75"
            proxy_after_tcp_handshake: "enable"
            scan_bzip2: "enable"
            ssl_offloaded: "no"
            status: "enable"
            uncompressed_nest_limit: "80"
            uncompressed_oversize_limit: "81"
        mail_signature:
            signature: "<your_own_value>"
            status: "disable"
        mapi:
            options: "fragmail"
            oversize_limit: "87"
            ports: "88"
            scan_bzip2: "enable"
            status: "enable"
            uncompressed_nest_limit: "91"
            uncompressed_oversize_limit: "92"
        name: "default_name_93"
        nntp:
            inspect_all: "enable"
            options: "oversize"
            oversize_limit: "97"
            ports: "98"
            proxy_after_tcp_handshake: "enable"
            scan_bzip2: "enable"
            status: "enable"
            uncompressed_nest_limit: "102"
            uncompressed_oversize_limit: "103"
        oversize_log: "disable"
        pop3:
            inspect_all: "enable"
            options: "fragmail"
            oversize_limit: "108"
            ports: "109"
            proxy_after_tcp_handshake: "enable"
            scan_bzip2: "enable"
            ssl_offloaded: "no"
            status: "enable"
            uncompressed_nest_limit: "114"
            uncompressed_oversize_limit: "115"
        replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
        rpc_over_http: "enable"
        smtp:
            inspect_all: "enable"
            options: "fragmail"
            oversize_limit: "121"
            ports: "122"
            proxy_after_tcp_handshake: "enable"
            scan_bzip2: "enable"
            server_busy: "enable"
            ssl_offloaded: "no"
            status: "enable"
            uncompressed_nest_limit: "128"
            uncompressed_oversize_limit: "129"
        ssh:
            comfort_amount: "131"
            comfort_interval: "132"
            options: "oversize"
            oversize_limit: "134"
            scan_bzip2: "enable"
            ssl_offloaded: "no"
            stream_based_uncompressed_limit: "137"
            tcp_window_maximum: "138"
            tcp_window_minimum: "139"
            tcp_window_size: "140"
            tcp_window_type: "system"
            uncompressed_nest_limit: "142"
            uncompressed_oversize_limit: "143"
        switching_protocols_log: "disable"

Return Values

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

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

Sample:
v5.6.3


Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

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