fortinet.fortimanager.fmgr_firewall_profileprotocoloptions module – Configure protocol options.

Note

This module is part of the fortinet.fortimanager collection (version 2.4.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.

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

dictionary

The top level parameters set.

cifs

dictionary

No description.

domain-controller

string

Deprecated, please rename it to domain_controller. Domain for which to decrypt CIFS traffic.

file-filter

dictionary

Deprecated, please rename it to file_filter.

entries

list / elements=dictionary

Entries.

action

string

Action taken for matched file.

Choices:

  • "log"

  • "block"

comment

string

Comment.

direction

string

Match files transmitted in the sessions originating or reply direction.

Choices:

  • "any"

  • "incoming"

  • "outgoing"

file-type

any

(list) Deprecated, please rename it to file_type. Select file type.

filter

string

Add a file filter.

protocol

list / elements=string

Protocols to apply with.

Choices:

  • "cifs"

log

string

Enable/disable file filter logging.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable file filter.

Choices:

  • "disable"

  • "enable"

options

list / elements=string

One or more options that can be applied to the session.

Choices:

  • "oversize"

oversize-limit

integer

Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

scan-bzip2

string

Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

server-credential-type

string

Deprecated, please rename it to server_credential_type. CIFS server credential type.

Choices:

  • "none"

  • "credential-replication"

  • "credential-keytab"

server-keytab

list / elements=dictionary

Deprecated, please rename it to server_keytab. Server-Keytab.

keytab

string

Base64 encoded keytab file containing credential of the server.

password

any

(list) Password for keytab.

principal

string

Service principal.

status

string

Enable/disable the active status of scanning for this protocol.

Choices:

  • "disable"

  • "enable"

tcp-window-maximum

integer

Deprecated, please rename it to tcp_window_maximum. Maximum dynamic TCP window size

tcp-window-minimum

integer

Deprecated, please rename it to tcp_window_minimum. Minimum dynamic TCP window size

tcp-window-size

integer

Deprecated, please rename it to tcp_window_size. Set TCP static window size

tcp-window-type

string

Deprecated, please rename it to tcp_window_type. Specify type of TCP window to use for this protocol.

Choices:

  • "system"

  • "static"

  • "dynamic"

  • "auto-tuning"

uncompressed-nest-limit

integer

Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompre…

uncompressed-oversize-limit

integer

Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be …

comment

string

Optional comments.

dns

dictionary

No description.

ports

any

(list) Ports to scan for content

status

string

Enable/disable the active status of scanning for this protocol.

Choices:

  • "disable"

  • "enable"

feature-set

string

Deprecated, please rename it to feature_set. Flow/proxy feature set.

Choices:

  • "proxy"

  • "flow"

ftp

dictionary

No description.

comfort-amount

integer

Deprecated, please rename it to comfort_amount. Amount of data to send in a transmission for client comforting

comfort-interval

integer

Deprecated, please rename it to comfort_interval. Period of time between start, or last transmission, and the next…

explicit-ftp-tls

string

Deprecated, please rename it to explicit_ftp_tls. Enable/disable FTP redirection for explicit FTPS.

Choices:

  • "disable"

  • "enable"

inspect-all

string

Deprecated, please rename it to inspect_all. Enable/disable the inspection of all ports for the protocol.

Choices:

  • "disable"

  • "enable"

options

list / elements=string

One or more options that can be applied to the session.

Choices:

  • "clientcomfort"

  • "no-content-summary"

  • "oversize"

  • "splice"

  • "bypass-rest-command"

  • "bypass-mode-command"

oversize-limit

integer

Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

scan-bzip2

string

Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl-offloaded

string

Deprecated, please rename it to ssl_offloaded. 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

Deprecated, please rename it to stream_based_uncompressed_limit. Maximum stream-based uncompressed data size that …

tcp-window-maximum

integer

Deprecated, please rename it to tcp_window_maximum. Maximum dynamic TCP window size.

tcp-window-minimum

integer

Deprecated, please rename it to tcp_window_minimum. Minimum dynamic TCP window size.

tcp-window-size

integer

Deprecated, please rename it to tcp_window_size. Set TCP static window size.

tcp-window-type

string

Deprecated, please rename it to tcp_window_type. TCP window type to use for this protocol.

Choices:

  • "system"

  • "static"

  • "dynamic"

  • "auto-tuning"

uncompressed-nest-limit

integer

Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompre…

uncompressed-oversize-limit

integer

Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be …

http

dictionary

No description.

address-ip-rating

string

Deprecated, please rename it to address_ip_rating. Enable/disable IP based URL rating.

Choices:

  • "disable"

  • "enable"

block-page-status-code

integer

Deprecated, please rename it to block_page_status_code. Code number returned for blocked HTTP pages

comfort-amount

integer

Deprecated, please rename it to comfort_amount. Amount of data to send in a transmission for client comforting

comfort-interval

integer

Deprecated, please rename it to comfort_interval. Period of time between start, or last transmission, and the next…

fortinet-bar

string

Deprecated, please rename it to fortinet_bar. Enable/disable Fortinet bar on HTML content.

Choices:

  • "disable"

  • "enable"

fortinet-bar-port

integer

Deprecated, please rename it to fortinet_bar_port. Port for use by Fortinet Bar

h2c

string

Enable/disable h2c HTTP connection upgrade.

Choices:

  • "disable"

  • "enable"

http-policy

string

Deprecated, please rename it to http_policy. Enable/disable HTTP policy check.

Choices:

  • "disable"

  • "enable"

inspect-all

string

Deprecated, please rename it to inspect_all. Enable/disable the inspection of all ports for the protocol.

Choices:

  • "disable"

  • "enable"

options

list / elements=string

One or more options that can be applied to the session.

Choices:

  • "oversize"

  • "chunkedbypass"

  • "clientcomfort"

  • "no-content-summary"

  • "servercomfort"

oversize-limit

integer

Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

post-lang

list / elements=string

Deprecated, please rename it to post_lang. ID codes for character sets to be used to convert to UTF-8 for banned w…

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

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

range-block

string

Deprecated, please rename it to range_block. Enable/disable blocking of partial downloads.

Choices:

  • "disable"

  • "enable"

retry-count

integer

Deprecated, please rename it to retry_count. Number of attempts to retry HTTP connection

scan-bzip2

string

Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl-offloaded

string

Deprecated, please rename it to ssl_offloaded. 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

Deprecated, please rename it to stream_based_uncompressed_limit. Maximum stream-based uncompressed data size that …

streaming-content-bypass

string

Deprecated, please rename it to streaming_content_bypass. Enable/disable bypassing of streaming content from buffe…

Choices:

  • "disable"

  • "enable"

strip-x-forwarded-for

string

Deprecated, please rename it to strip_x_forwarded_for. Enable/disable stripping of HTTP X-Forwarded-For header.

Choices:

  • "disable"

  • "enable"

switching-protocols

string

Deprecated, please rename it to switching_protocols. Bypass from scanning, or block a connection that attempts to …

Choices:

  • "bypass"

  • "block"

tcp-window-maximum

integer

Deprecated, please rename it to tcp_window_maximum. Maximum dynamic TCP window size

tcp-window-minimum

integer

Deprecated, please rename it to tcp_window_minimum. Minimum dynamic TCP window size

tcp-window-size

integer

Deprecated, please rename it to tcp_window_size. Set TCP static window size

tcp-window-type

string

Deprecated, please rename it to tcp_window_type. Specify type of TCP window to use for this protocol.

Choices:

  • "system"

  • "static"

  • "dynamic"

  • "auto-tuning"

tunnel-non-http

string

Deprecated, please rename it to tunnel_non_http. Configure how to process non-HTTP traffic when a profile configur…

Choices:

  • "disable"

  • "enable"

uncompressed-nest-limit

integer

Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompre…

uncompressed-oversize-limit

integer

Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be …

unknown-content-encoding

string

Deprecated, please rename it to unknown_content_encoding. Configure the action the FortiGate unit will take on unk…

Choices:

  • "block"

  • "inspect"

  • "bypass"

unknown-http-version

string

Deprecated, please rename it to unknown_http_version. How to handle HTTP sessions that do not comply with HTTP 0.

Choices:

  • "best-effort"

  • "reject"

  • "tunnel"

verify-dns-for-policy-matching

string

Deprecated, please rename it to verify_dns_for_policy_matching. Enable/disable verification of DNS for policy matc…

Choices:

  • "disable"

  • "enable"

imap

dictionary

No description.

inspect-all

string

Deprecated, please rename it to inspect_all. Enable/disable the inspection of all ports for the protocol.

Choices:

  • "disable"

  • "enable"

options

list / elements=string

One or more options that can be applied to the session.

Choices:

  • "oversize"

  • "fragmail"

  • "no-content-summary"

oversize-limit

integer

Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

scan-bzip2

string

Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl-offloaded

string

Deprecated, please rename it to ssl_offloaded. 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"

uncompressed-nest-limit

integer

Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompre…

uncompressed-oversize-limit

integer

Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be …

mail-signature

dictionary

Deprecated, please rename it to mail_signature.

signature

string

Email signature to be added to outgoing email

status

string

Enable/disable adding an email signature to SMTP email messages as they pass through the FortiGate.

Choices:

  • "disable"

  • "enable"

mapi

dictionary

No description.

options

list / elements=string

One or more options that can be applied to the session.

Choices:

  • "fragmail"

  • "oversize"

  • "no-content-summary"

oversize-limit

integer

Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

scan-bzip2

string

Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable the active status of scanning for this protocol.

Choices:

  • "disable"

  • "enable"

uncompressed-nest-limit

integer

Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompre…

uncompressed-oversize-limit

integer

Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be …

name

string / required

Name.

nntp

dictionary

No description.

inspect-all

string

Deprecated, please rename it to inspect_all. Enable/disable the inspection of all ports for the protocol.

Choices:

  • "disable"

  • "enable"

options

list / elements=string

One or more options that can be applied to the session.

Choices:

  • "oversize"

  • "no-content-summary"

  • "splice"

oversize-limit

integer

Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

scan-bzip2

string

Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

status

string

Enable/disable the active status of scanning for this protocol.

Choices:

  • "disable"

  • "enable"

uncompressed-nest-limit

integer

Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompre…

uncompressed-oversize-limit

integer

Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be …

oversize-log

string

Deprecated, please rename it to oversize_log. Enable/disable logging for antivirus oversize file blocking.

Choices:

  • "disable"

  • "enable"

pop3

dictionary

No description.

inspect-all

string

Deprecated, please rename it to inspect_all. Enable/disable the inspection of all ports for the protocol.

Choices:

  • "disable"

  • "enable"

options

list / elements=string

One or more options that can be applied to the session.

Choices:

  • "oversize"

  • "fragmail"

  • "no-content-summary"

oversize-limit

integer

Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

scan-bzip2

string

Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl-offloaded

string

Deprecated, please rename it to ssl_offloaded. 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"

uncompressed-nest-limit

integer

Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompre…

uncompressed-oversize-limit

integer

Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be …

replacemsg-group

string

Deprecated, please rename it to replacemsg_group. Name of the replacement message group to be used

rpc-over-http

string

Deprecated, please rename it to rpc_over_http. Enable/disable inspection of RPC over HTTP.

Choices:

  • "disable"

  • "enable"

smtp

dictionary

No description.

inspect-all

string

Deprecated, please rename it to inspect_all. Enable/disable the inspection of all ports for the protocol.

Choices:

  • "disable"

  • "enable"

options

list / elements=string

One or more options that can be applied to the session.

Choices:

  • "oversize"

  • "fragmail"

  • "no-content-summary"

  • "splice"

oversize-limit

integer

Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

scan-bzip2

string

Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

server-busy

string

Deprecated, please rename it to server_busy. Enable/disable SMTP server busy when server not available.

Choices:

  • "disable"

  • "enable"

ssl-offloaded

string

Deprecated, please rename it to ssl_offloaded. 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"

uncompressed-nest-limit

integer

Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompre…

uncompressed-oversize-limit

integer

Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be …

ssh

dictionary

No description.

comfort-amount

integer

Deprecated, please rename it to comfort_amount. Amount of data to send in a transmission for client comforting

comfort-interval

integer

Deprecated, please rename it to comfort_interval. Period of time between start, or last transmission, and the next…

options

list / elements=string

One or more options that can be applied to the session.

Choices:

  • "oversize"

  • "clientcomfort"

  • "servercomfort"

oversize-limit

integer

Deprecated, please rename it to oversize_limit. Maximum in-memory file size that can be scanned

scan-bzip2

string

Deprecated, please rename it to scan_bzip2. Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl-offloaded

string

Deprecated, please rename it to ssl_offloaded. SSL decryption and encryption performed by an external device.

Choices:

  • "no"

  • "yes"

stream-based-uncompressed-limit

integer

Deprecated, please rename it to stream_based_uncompressed_limit. Maximum stream-based uncompressed data size that …

tcp-window-maximum

integer

Deprecated, please rename it to tcp_window_maximum. Maximum dynamic TCP window size.

tcp-window-minimum

integer

Deprecated, please rename it to tcp_window_minimum. Minimum dynamic TCP window size.

tcp-window-size

integer

Deprecated, please rename it to tcp_window_size. Set TCP static window size.

tcp-window-type

string

Deprecated, please rename it to tcp_window_type. TCP window type to use for this protocol.

Choices:

  • "system"

  • "static"

  • "dynamic"

  • "auto-tuning"

uncompressed-nest-limit

integer

Deprecated, please rename it to uncompressed_nest_limit. Maximum nested levels of compression that can be uncompre…

uncompressed-oversize-limit

integer

Deprecated, please rename it to uncompressed_oversize_limit. Maximum in-memory uncompressed file size that can be …

switching-protocols-log

string

Deprecated, please rename it to switching_protocols_log. Enable/disable logging for HTTP/HTTPS switching protocols.

Choices:

  • "disable"

  • "enable"

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

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.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

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

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • 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

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure protocol options.
      fortinet.fortimanager.fmgr_firewall_profileprotocoloptions:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_profileprotocoloptions:
          comment: "ansible-comment"
          name: "ansible-test"

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the profile protocol options
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_profileprotocoloptions"
          params:
            adom: "ansible"
            profile-protocol-options: "your_value"

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)