fortinet.fortimanager.fmgr_firewall_profileprotocoloptions module – Configure protocol options.

Note

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

Cifs.

domain_controller

aliases: domain-controller

string

Domain for which to decrypt CIFS traffic.

file_filter

aliases: file-filter

dictionary

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

aliases: file-type

any

(list) 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

aliases: oversize-limit

integer

Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

scan_bzip2

aliases: scan-bzip2

string

Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

server_credential_type

aliases: server-credential-type

string

CIFS server credential type.

Choices:

  • "none"

  • "credential-replication"

  • "credential-keytab"

server_keytab

aliases: server-keytab

list / elements=dictionary

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

aliases: tcp-window-maximum

integer

Maximum dynamic TCP window size

tcp_window_minimum

aliases: tcp-window-minimum

integer

Minimum dynamic TCP window size

tcp_window_size

aliases: tcp-window-size

integer

Set TCP static window size

tcp_window_type

aliases: tcp-window-type

string

Specify type of TCP window to use for this protocol.

Choices:

  • "system"

  • "static"

  • "dynamic"

  • "auto-tuning"

uncompressed_nest_limit

aliases: uncompressed-nest-limit

integer

Maximum nested levels of compression that can be uncompressed and scanned

uncompressed_oversize_limit

aliases: uncompressed-oversize-limit

integer

Maximum in-memory uncompressed file size that can be scanned

comment

string

Optional comments.

dns

dictionary

Dns.

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

aliases: feature-set

string

Flow/proxy feature set.

Choices:

  • "proxy"

  • "flow"

ftp

dictionary

Ftp.

comfort_amount

aliases: comfort-amount

integer

Amount of data to send in a transmission for client comforting

comfort_interval

aliases: comfort-interval

integer

Period of time between start, or last transmission, and the next client comfort transmission of data

explicit_ftp_tls

aliases: explicit-ftp-tls

string

Enable/disable FTP redirection for explicit FTPS.

Choices:

  • "disable"

  • "enable"

inspect_all

aliases: inspect-all

string

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

aliases: oversize-limit

integer

Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

scan_bzip2

aliases: scan-bzip2

string

Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl_offloaded

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

aliases: stream-based-uncompressed-limit

integer

Maximum stream-based uncompressed data size that will be scanned

tcp_window_maximum

aliases: tcp-window-maximum

integer

Maximum dynamic TCP window size.

tcp_window_minimum

aliases: tcp-window-minimum

integer

Minimum dynamic TCP window size.

tcp_window_size

aliases: tcp-window-size

integer

Set TCP static window size.

tcp_window_type

aliases: tcp-window-type

string

TCP window type to use for this protocol.

Choices:

  • "system"

  • "static"

  • "dynamic"

  • "auto-tuning"

uncompressed_nest_limit

aliases: uncompressed-nest-limit

integer

Maximum nested levels of compression that can be uncompressed and scanned

uncompressed_oversize_limit

aliases: uncompressed-oversize-limit

integer

Maximum in-memory uncompressed file size that can be scanned

http

dictionary

Http.

address_ip_rating

aliases: address-ip-rating

string

Enable/disable IP based URL rating.

Choices:

  • "disable"

  • "enable"

block_page_status_code

aliases: block-page-status-code

integer

Code number returned for blocked HTTP pages

comfort_amount

aliases: comfort-amount

integer

Amount of data to send in a transmission for client comforting

comfort_interval

aliases: comfort-interval

integer

Period of time between start, or last transmission, and the next client comfort transmission of data

domain_fronting

aliases: domain-fronting

string

Configure HTTP domain fronting

Choices:

  • "block"

  • "monitor"

  • "allow"

fortinet_bar

aliases: fortinet-bar

string

Enable/disable Fortinet bar on HTML content.

Choices:

  • "disable"

  • "enable"

fortinet_bar_port

aliases: fortinet-bar-port

integer

Port for use by Fortinet Bar

h2c

string

Enable/disable h2c HTTP connection upgrade.

Choices:

  • "disable"

  • "enable"

http_policy

aliases: http-policy

string

Enable/disable HTTP policy check.

Choices:

  • "disable"

  • "enable"

inspect_all

aliases: inspect-all

string

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

aliases: oversize-limit

integer

Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

post_lang

aliases: post-lang

list / elements=string

ID codes for character sets to be used to convert to UTF-8 for banned words and DLP on HTTP posts

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

aliases: proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established

Choices:

  • "disable"

  • "enable"

range_block

aliases: range-block

string

Enable/disable blocking of partial downloads.

Choices:

  • "disable"

  • "enable"

retry_count

aliases: retry-count

integer

Number of attempts to retry HTTP connection

scan_bzip2

aliases: scan-bzip2

string

Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl_offloaded

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

aliases: stream-based-uncompressed-limit

integer

Maximum stream-based uncompressed data size that will be scanned

streaming_content_bypass

aliases: streaming-content-bypass

string

Enable/disable bypassing of streaming content from buffering.

Choices:

  • "disable"

  • "enable"

strip_x_forwarded_for

aliases: strip-x-forwarded-for

string

Enable/disable stripping of HTTP X-Forwarded-For header.

Choices:

  • "disable"

  • "enable"

switching_protocols

aliases: switching-protocols

string

Bypass from scanning, or block a connection that attempts to switch protocol.

Choices:

  • "bypass"

  • "block"

tcp_window_maximum

aliases: tcp-window-maximum

integer

Maximum dynamic TCP window size

tcp_window_minimum

aliases: tcp-window-minimum

integer

Minimum dynamic TCP window size

tcp_window_size

aliases: tcp-window-size

integer

Set TCP static window size

tcp_window_type

aliases: tcp-window-type

string

Specify type of TCP window to use for this protocol.

Choices:

  • "system"

  • "static"

  • "dynamic"

  • "auto-tuning"

tunnel_non_http

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

aliases: uncompressed-nest-limit

integer

Maximum nested levels of compression that can be uncompressed and scanned

uncompressed_oversize_limit

aliases: uncompressed-oversize-limit

integer

Maximum in-memory uncompressed file size that can be scanned

unknown_content_encoding

aliases: unknown-content-encoding

string

Configure the action the FortiGate unit will take on unknown content-encoding.

Choices:

  • "block"

  • "inspect"

  • "bypass"

unknown_http_version

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

aliases: verify-dns-for-policy-matching

string

Enable/disable verification of DNS for policy matching.

Choices:

  • "disable"

  • "enable"

imap

dictionary

Imap.

inspect_all

aliases: inspect-all

string

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

aliases: oversize-limit

integer

Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

proxy_after_tcp_handshake

aliases: proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established

Choices:

  • "disable"

  • "enable"

scan_bzip2

aliases: scan-bzip2

string

Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl_offloaded

aliases: 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"

uncompressed_nest_limit

aliases: uncompressed-nest-limit

integer

Maximum nested levels of compression that can be uncompressed and scanned

uncompressed_oversize_limit

aliases: uncompressed-oversize-limit

integer

Maximum in-memory uncompressed file size that can be scanned

mail_signature

aliases: mail-signature

dictionary

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

Mapi.

options

list / elements=string

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

Choices:

  • "fragmail"

  • "oversize"

  • "no-content-summary"

oversize_limit

aliases: oversize-limit

integer

Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

scan_bzip2

aliases: scan-bzip2

string

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

aliases: uncompressed-nest-limit

integer

Maximum nested levels of compression that can be uncompressed and scanned

uncompressed_oversize_limit

aliases: uncompressed-oversize-limit

integer

Maximum in-memory uncompressed file size that can be scanned

name

string / required

Name.

nntp

dictionary

Nntp.

inspect_all

aliases: inspect-all

string

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

aliases: oversize-limit

integer

Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

proxy_after_tcp_handshake

aliases: proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established

Choices:

  • "disable"

  • "enable"

scan_bzip2

aliases: scan-bzip2

string

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

aliases: uncompressed-nest-limit

integer

Maximum nested levels of compression that can be uncompressed and scanned

uncompressed_oversize_limit

aliases: uncompressed-oversize-limit

integer

Maximum in-memory uncompressed file size that can be scanned

oversize_log

aliases: oversize-log

string

Enable/disable logging for antivirus oversize file blocking.

Choices:

  • "disable"

  • "enable"

pop3

dictionary

Pop3.

inspect_all

aliases: inspect-all

string

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

aliases: oversize-limit

integer

Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

proxy_after_tcp_handshake

aliases: proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established

Choices:

  • "disable"

  • "enable"

scan_bzip2

aliases: scan-bzip2

string

Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl_offloaded

aliases: 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"

uncompressed_nest_limit

aliases: uncompressed-nest-limit

integer

Maximum nested levels of compression that can be uncompressed and scanned

uncompressed_oversize_limit

aliases: uncompressed-oversize-limit

integer

Maximum in-memory uncompressed file size that can be scanned

replacemsg_group

aliases: replacemsg-group

string

Name of the replacement message group to be used

rpc_over_http

aliases: rpc-over-http

string

Enable/disable inspection of RPC over HTTP.

Choices:

  • "disable"

  • "enable"

smtp

dictionary

Smtp.

inspect_all

aliases: inspect-all

string

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

aliases: oversize-limit

integer

Maximum in-memory file size that can be scanned

ports

any

(list) Ports to scan for content

proxy_after_tcp_handshake

aliases: proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established

Choices:

  • "disable"

  • "enable"

scan_bzip2

aliases: scan-bzip2

string

Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

server_busy

aliases: server-busy

string

Enable/disable SMTP server busy when server not available.

Choices:

  • "disable"

  • "enable"

ssl_offloaded

aliases: 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"

uncompressed_nest_limit

aliases: uncompressed-nest-limit

integer

Maximum nested levels of compression that can be uncompressed and scanned

uncompressed_oversize_limit

aliases: uncompressed-oversize-limit

integer

Maximum in-memory uncompressed file size that can be scanned

ssh

dictionary

Ssh.

comfort_amount

aliases: comfort-amount

integer

Amount of data to send in a transmission for client comforting

comfort_interval

aliases: comfort-interval

integer

Period of time between start, or last transmission, and the next client comfort transmission of data

options

list / elements=string

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

Choices:

  • "oversize"

  • "clientcomfort"

  • "servercomfort"

oversize_limit

aliases: oversize-limit

integer

Maximum in-memory file size that can be scanned

scan_bzip2

aliases: scan-bzip2

string

Enable/disable scanning of BZip2 compressed files.

Choices:

  • "disable"

  • "enable"

ssl_offloaded

aliases: ssl-offloaded

string

SSL decryption and encryption performed by an external device.

Choices:

  • "no"

  • "yes"

stream_based_uncompressed_limit

aliases: stream-based-uncompressed-limit

integer

Maximum stream-based uncompressed data size that will be scanned

tcp_window_maximum

aliases: tcp-window-maximum

integer

Maximum dynamic TCP window size.

tcp_window_minimum

aliases: tcp-window-minimum

integer

Minimum dynamic TCP window size.

tcp_window_size

aliases: tcp-window-size

integer

Set TCP static window size.

tcp_window_type

aliases: tcp-window-type

string

TCP window type to use for this protocol.

Choices:

  • "system"

  • "static"

  • "dynamic"

  • "auto-tuning"

uncompressed_nest_limit

aliases: uncompressed-nest-limit

integer

Maximum nested levels of compression that can be uncompressed and scanned

uncompressed_oversize_limit

aliases: uncompressed-oversize-limit

integer

Maximum in-memory uncompressed file size that can be scanned

switching_protocols_log

aliases: switching-protocols-log

string

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)