fortinet.fortimanager.fmgr_firewall_profileprotocoloptions – Configure protocol options.

Note

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

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

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
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
firewall_profileprotocoloptions
dictionary
the top level parameters set
cifs
dictionary
no description
domain-controller
string
Domain for which to decrypt CIFS traffic.
file-filter
dictionary
no description
entries
list / elements=string
Entries.
action
string
    Choices:
  • log
  • block
Action taken for matched file.
comment
string
Comment.
direction
string
    Choices:
  • any
  • incoming
  • outgoing
Match files transmitted in the sessions originating or reply direction.
file-type
string
Select file type.
filter
string
Add a file filter.
protocol
list / elements=string
    Choices:
  • cifs
Protocols to apply with.
log
string
    Choices:
  • disable
  • enable
Enable/disable file filter logging.
status
string
    Choices:
  • disable
  • enable
Enable/disable file filter.
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, default = 10).
ports
integer
Ports to scan for content (1 - 65535, default = 445).
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
server-credential-type
string
    Choices:
  • none
  • credential-replication
  • credential-keytab
CIFS server credential type.
server-keytab
list / elements=string
Server-Keytab.
keytab
string
Base64 encoded keytab file containing credential of the server.
password
string
Password for keytab.
principal
string
Service principal. For example, "host/[email protected]".
status
string
    Choices:
  • disable
  • enable
Enable/disable the active status of scanning for this protocol.
tcp-window-maximum
integer
Maximum dynamic TCP window size (default = 8MB).
tcp-window-minimum
integer
Minimum dynamic TCP window size (default = 128KB).
tcp-window-size
integer
Set TCP static window size (default = 256KB).
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, default = 12).
uncompressed-oversize-limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
comment
string
Optional comments.
dns
dictionary
no description
ports
integer
Ports to scan for content (1 - 65535, default = 53).
status
string
    Choices:
  • disable
  • enable
Enable/disable the active status of scanning for this protocol.
feature-set
string
    Choices:
  • proxy
  • flow
Flow/proxy feature set.
ftp
dictionary
no description
comfort-amount
integer
Amount of data to send in a transmission for client comforting (1 - 65535 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, def...
inspect-all
string
    Choices:
  • disable
  • enable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • clientcomfort
  • no-content-summary
  • 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, default = 10).
ports
integer
Ports to scan for content (1 - 65535, default = 21).
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
ssl-offloaded
string
    Choices:
  • no
  • yes
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • disable
  • enable
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 uncompres...
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, default = 12).
uncompressed-oversize-limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
http
dictionary
no description
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 - 65535 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, def...
fortinet-bar
string
    Choices:
  • disable
  • enable
Fortinet-Bar.
fortinet-bar-port
integer
Fortinet-Bar-Port.
inspect-all
string
    Choices:
  • disable
  • enable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • oversize
  • chunkedbypass
  • clientcomfort
  • no-content-summary
  • 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, default = 10).
ports
integer
Ports to scan for content (1 - 65535, default = 80).
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:
  • disable
  • enable
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, default = 0).
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
ssl-offloaded
string
    Choices:
  • no
  • yes
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • disable
  • enable
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 uncompres...
streaming-content-bypass
string
    Choices:
  • disable
  • enable
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 (default = 8MB).
tcp-window-minimum
integer
Minimum dynamic TCP window size (default = 128KB).
tcp-window-size
integer
Set TCP static window size (default = 256KB).
tcp-window-type
string
    Choices:
  • system
  • static
  • dynamic
Specify type of TCP window to use for this protocol.
tunnel-non-http
string
    Choices:
  • disable
  • enable
Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Can o...
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).
unknown-http-version
string
    Choices:
  • best-effort
  • reject
  • tunnel
How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1.
imap
dictionary
no description
inspect-all
string
    Choices:
  • disable
  • enable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • oversize
  • fragmail
  • no-content-summary
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, default = 10).
ports
integer
Ports to scan for content (1 - 65535, default = 143).
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
ssl-offloaded
string
    Choices:
  • no
  • yes
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • disable
  • enable
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, default = 12).
uncompressed-oversize-limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
mail-signature
dictionary
no description
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
no description
options
list / elements=string
    Choices:
  • fragmail
  • oversize
  • no-content-summary
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, default = 10).
ports
integer
Ports to scan for content (1 - 65535, default = 135).
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
status
string
    Choices:
  • disable
  • enable
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, default = 12).
uncompressed-oversize-limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
name
string
Name.
nntp
dictionary
no description
inspect-all
string
    Choices:
  • disable
  • enable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • oversize
  • no-content-summary
  • 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, default = 10).
ports
integer
Ports to scan for content (1 - 65535, default = 119).
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
status
string
    Choices:
  • disable
  • enable
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, default = 12).
uncompressed-oversize-limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
oversize-log
string
    Choices:
  • disable
  • enable
Enable/disable logging for antivirus oversize file blocking.
pop3
dictionary
no description
inspect-all
string
    Choices:
  • disable
  • enable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • oversize
  • fragmail
  • no-content-summary
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, default = 10).
ports
integer
Ports to scan for content (1 - 65535, default = 110).
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
ssl-offloaded
string
    Choices:
  • no
  • yes
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • disable
  • enable
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, default = 12).
uncompressed-oversize-limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
replacemsg-group
string
Name of the replacement message group to be used
rpc-over-http
string
    Choices:
  • disable
  • enable
Enable/disable inspection of RPC over HTTP.
smtp
dictionary
no description
inspect-all
string
    Choices:
  • disable
  • enable
Enable/disable the inspection of all ports for the protocol.
options
list / elements=string
    Choices:
  • oversize
  • fragmail
  • no-content-summary
  • 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, default = 10).
ports
integer
Ports to scan for content (1 - 65535, default = 25).
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
server-busy
string
    Choices:
  • disable
  • enable
Enable/disable SMTP server busy when server not available.
ssl-offloaded
string
    Choices:
  • no
  • yes
SSL decryption and encryption performed by an external device.
status
string
    Choices:
  • disable
  • enable
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, default = 12).
uncompressed-oversize-limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
ssh
dictionary
no description
comfort-amount
integer
Amount of data to send in a transmission for client comforting (1 - 65535 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, def...
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, default = 10).
scan-bzip2
string
    Choices:
  • disable
  • enable
Enable/disable scanning of BZip2 compressed files.
ssl-offloaded
string
    Choices:
  • no
  • yes
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 uncompres...
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, default = 12).
uncompressed-oversize-limit
integer
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10).
switching-protocols-log
string
    Choices:
  • disable
  • enable
Enable/disable logging for HTTP/HTTPS switching protocols.
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
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
    Choices:
  • 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: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure protocol options.
     fmgr_firewall_profileprotocoloptions:
        bypass_validation: False
        adom: ansible
        state: present
        firewall_profileprotocoloptions:
           comment: 'ansible-comment'
           name: 'ansible-test'

- name: gathering fortimanager facts
  hosts: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the profile protocol options
     fmgr_fact:
       facts:
           selector: 'firewall_profileprotocoloptions'
           params:
               adom: 'ansible'
               profile-protocol-options: ''

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)