fortinet.fortimanager.fmgr_firewall_profileprotocoloptions module – Configure protocol options.
Note
This module is part of the fortinet.fortimanager collection (version 2.1.5).
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 |
Comments |
|---|---|
the parameter (adom) in requested url |
|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
Enable/Disable logging for task Choices:
|
|
the top level parameters set |
|
no description |
|
Domain for which to decrypt CIFS traffic. |
|
no description |
|
Entries. |
|
Action taken for matched file. Choices:
|
|
Comment. |
|
Match files transmitted in the sessions originating or reply direction. Choices:
|
|
Select file type. |
|
Add a file filter. |
|
Protocols to apply with. Choices:
|
|
Enable/disable file filter logging. Choices:
|
|
Enable/disable file filter. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
|
Ports to scan for content (1 - 65535, default = 445). |
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
CIFS server credential type. Choices:
|
|
Server-Keytab. |
|
Base64 encoded keytab file containing credential of the server. |
|
Password for keytab. |
|
Service principal. For example, “host/cifsserver.example.com@example.com”. |
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum dynamic TCP window size (default = 8MB). |
|
Minimum dynamic TCP window size (default = 128KB). |
|
Set TCP static window size (default = 256KB). |
|
Specify type of TCP window to use for this protocol. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
|
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
|
Optional comments. |
|
no description |
|
Ports to scan for content (1 - 65535, default = 53). |
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Flow/proxy feature set. Choices:
|
|
no description |
|
Amount of data to send in a transmission for client comforting (1 - 65535 bytes, default = 1). |
|
Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, def… |
|
Enable/disable the inspection of all ports for the protocol. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
|
Ports to scan for content (1 - 65535, default = 21). |
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
SSL decryption and encryption performed by an external device. Choices:
|
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based uncompres… |
|
Maximum dynamic TCP window size. |
|
Minimum dynamic TCP window size. |
|
Set TCP static window size. |
|
TCP window type to use for this protocol. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
|
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
|
no description |
|
Code number returned for blocked HTTP pages (non-FortiGuard only) (100 - 599, default = 403). |
|
Amount of data to send in a transmission for client comforting (1 - 65535 bytes, default = 1). |
|
Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, def… |
|
Fortinet-Bar. Choices:
|
|
Fortinet-Bar-Port. |
|
Enable/disable the inspection of all ports for the protocol. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
|
Ports to scan for content (1 - 65535, default = 80). |
|
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). Choices:
|
|
Proxy traffic after the TCP 3-way handshake has been established (not before). Choices:
|
|
Enable/disable blocking of partial downloads. Choices:
|
|
Number of attempts to retry HTTP connection (0 - 100, default = 0). |
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
SSL decryption and encryption performed by an external device. Choices:
|
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based uncompres… |
|
Enable/disable bypassing of streaming content from buffering. Choices:
|
|
Enable/disable stripping of HTTP X-Forwarded-For header. Choices:
|
|
Bypass from scanning, or block a connection that attempts to switch protocol. Choices:
|
|
Maximum dynamic TCP window size (default = 8MB). |
|
Minimum dynamic TCP window size (default = 128KB). |
|
Set TCP static window size (default = 256KB). |
|
Specify type of TCP window to use for this protocol. Choices:
|
|
Configure how to process non-HTTP traffic when a profile configured for HTTP traffic accepts a non-HTTP session. Can o… Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
|
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
|
How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1. Choices:
|
|
no description |
|
Enable/disable the inspection of all ports for the protocol. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
|
Ports to scan for content (1 - 65535, default = 143). |
|
Proxy traffic after the TCP 3-way handshake has been established (not before). Choices:
|
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
SSL decryption and encryption performed by an external device. Choices:
|
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
|
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
|
no description |
|
Email signature to be added to outgoing email (if the signature contains spaces, enclose with quotation marks). |
|
Enable/disable adding an email signature to SMTP email messages as they pass through the FortiGate. Choices:
|
|
no description |
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
|
Ports to scan for content (1 - 65535, default = 135). |
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
|
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
|
Name. |
|
no description |
|
Enable/disable the inspection of all ports for the protocol. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
|
Ports to scan for content (1 - 65535, default = 119). |
|
Proxy traffic after the TCP 3-way handshake has been established (not before). Choices:
|
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
|
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
|
Enable/disable logging for antivirus oversize file blocking. Choices:
|
|
no description |
|
Enable/disable the inspection of all ports for the protocol. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
|
Ports to scan for content (1 - 65535, default = 110). |
|
Proxy traffic after the TCP 3-way handshake has been established (not before). Choices:
|
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
SSL decryption and encryption performed by an external device. Choices:
|
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
|
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
|
Name of the replacement message group to be used |
|
Enable/disable inspection of RPC over HTTP. Choices:
|
|
no description |
|
Enable/disable the inspection of all ports for the protocol. Choices:
|
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
|
Ports to scan for content (1 - 65535, default = 25). |
|
Proxy traffic after the TCP 3-way handshake has been established (not before). Choices:
|
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
Enable/disable SMTP server busy when server not available. Choices:
|
|
SSL decryption and encryption performed by an external device. Choices:
|
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
|
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
|
no description |
|
Amount of data to send in a transmission for client comforting (1 - 65535 bytes, default = 1). |
|
Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, def… |
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (1 - 383 MB, default = 10). |
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
SSL decryption and encryption performed by an external device. Choices:
|
|
Maximum stream-based uncompressed data size that will be scanned (MB, 0 = unlimited (default). Stream-based uncompres… |
|
Maximum dynamic TCP window size. |
|
Minimum dynamic TCP window size. |
|
Set TCP static window size. |
|
TCP window type to use for this protocol. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). |
|
Maximum in-memory uncompressed file size that can be scanned (0 - 383 MB, 0 = unlimited, default = 10). |
|
Enable/disable logging for HTTP/HTTPS switching protocols. Choices:
|
|
The overridden method for the underlying Json RPC request Choices:
|
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the directive to create, update or delete an object Choices:
|
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
the maximum time in seconds to wait for other user to release the workspace lock Default: 300 |
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 |
Description |
|---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)