fortinet.fortios.fortios_firewall_profile_protocol_options module – Configure protocol options in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.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.fortios.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_firewall_profile_protocol_options.
New in fortinet.fortios 2.0.0
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
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Configure protocol options. |
|
Configure CIFS protocol options. |
|
Domain for which to decrypt CIFS traffic. Source user.domain-controller.name credential-store.domain-controller.server-name. |
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (MB). |
|
Ports to scan for content (1 - 65535). |
|
Enable/disable scanning of BZip2 compressed files. Choices:
|
|
CIFS server credential type. Choices:
|
|
Server keytab. |
|
Base64 encoded keytab file containing credential of the server. |
|
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. |
|
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). |
|
Maximum in-memory uncompressed file size that can be scanned. |
|
Optional comments. |
|
Configure DNS protocol options. |
|
Ports to scan for content (1 - 65535). |
|
Enable/disable the active status of scanning for this protocol. Choices:
|
|
Configure FTP protocol options. |
|
Number of bytes to send in each transmission for client comforting (bytes). |
|
Interval between successive transmissions of data for client comforting (seconds). |
|
Enable/disable FTP redirection for explicit FTPS. Choices:
|
|
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 (MB). |
|
Ports to scan for content (1 - 65535). |
|
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 in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0). |
|
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). |
|
Maximum in-memory uncompressed file size that can be scanned. |
|
Configure HTTP protocol options. |
|
Enable/disable IP based URL rating. Choices:
|
|
Code number returned for blocked HTTP pages (non-FortiGuard only) (100 - 599). |
|
Number of bytes to send in each transmission for client comforting (bytes). |
|
Interval between successive transmissions of data for client comforting (seconds). |
|
Enable/disable Fortinet bar on HTML content. Choices:
|
|
Port for use by Fortinet Bar (1 - 65535). |
|
Enable/disable h2c HTTP connection upgrade. Choices:
|
|
Enable/disable HTTP policy check. Choices:
|
|
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 (MB). |
|
Ports to scan for content (1 - 65535). |
|
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). |
|
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 in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0). |
|
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. |
|
Minimum dynamic TCP window size. |
|
Set TCP static window size. |
|
TCP window type 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 occur if an application sends non-HTTP traffic using an HTTP destination port. Choices:
|
|
Maximum nested levels of compression that can be uncompressed and scanned (2 - 100). |
|
Maximum in-memory uncompressed file size that can be scanned. |
|
Configure the action the FortiGate unit will take on unknown content-encoding. Choices:
|
|
How to handle HTTP sessions that do not comply with HTTP 0.9, 1.0, or 1.1. Choices:
|
|
Enable/disable verification of DNS for policy matching. Choices:
|
|
Configure IMAP protocol options. |
|
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 (MB). |
|
Ports to scan for content (1 - 65535). |
|
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). |
|
Maximum in-memory uncompressed file size that can be scanned. |
|
Configure Mail signature. |
|
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:
|
|
Configure MAPI protocol options. |
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (MB). |
|
Ports to scan for content (1 - 65535). |
|
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). |
|
Maximum in-memory uncompressed file size that can be scanned. |
|
Name. |
|
Configure NNTP protocol options. |
|
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 (MB). |
|
Ports to scan for content (1 - 65535). |
|
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). |
|
Maximum in-memory uncompressed file size that can be scanned. |
|
Enable/disable logging for antivirus oversize file blocking. Choices:
|
|
Configure POP3 protocol options. |
|
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 (MB). |
|
Ports to scan for content (1 - 65535). |
|
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). |
|
Maximum in-memory uncompressed file size that can be scanned. |
|
Name of the replacement message group to be used. Source system.replacemsg-group.name. |
|
Enable/disable inspection of RPC over HTTP. Choices:
|
|
Configure SMTP protocol options. |
|
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 (MB). |
|
Ports to scan for content (1 - 65535). |
|
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). |
|
Maximum in-memory uncompressed file size that can be scanned. |
|
Configure SFTP and SCP protocol options. |
|
Number of bytes to send in each transmission for client comforting (bytes). |
|
Interval between successive transmissions of data for client comforting (seconds). |
|
One or more options that can be applied to the session. Choices:
|
|
Maximum in-memory file size that can be scanned (MB). |
|
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 in megabytes. Stream-based uncompression used only under certain conditions (unlimited = 0). |
|
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). |
|
Maximum in-memory uncompressed file size that can be scanned. |
|
Enable/disable logging for HTTP/HTTPS switching protocols. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
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 user.domain-controller.name credential-store.domain-controller.server-name)"
options: "oversize"
oversize_limit: "10"
ports: "<your_own_value>"
scan_bzip2: "enable"
server_credential_type: "none"
server_keytab:
-
keytab: "<your_own_value>"
principal: "<your_own_value>"
status: "enable"
tcp_window_maximum: "8388608"
tcp_window_minimum: "131072"
tcp_window_size: "262144"
tcp_window_type: "auto-tuning"
uncompressed_nest_limit: "12"
uncompressed_oversize_limit: "10"
comment: "Optional comments."
dns:
ports: "<your_own_value>"
status: "enable"
ftp:
comfort_amount: "1"
comfort_interval: "10"
explicit_ftp_tls: "enable"
inspect_all: "enable"
options: "clientcomfort"
oversize_limit: "10"
ports: "<your_own_value>"
scan_bzip2: "enable"
ssl_offloaded: "no"
status: "enable"
stream_based_uncompressed_limit: "0"
tcp_window_maximum: "8388608"
tcp_window_minimum: "131072"
tcp_window_size: "262144"
tcp_window_type: "auto-tuning"
uncompressed_nest_limit: "12"
uncompressed_oversize_limit: "10"
http:
address_ip_rating: "enable"
block_page_status_code: "403"
comfort_amount: "1"
comfort_interval: "10"
fortinet_bar: "enable"
fortinet_bar_port: "32767"
h2c: "enable"
http_policy: "disable"
inspect_all: "enable"
options: "clientcomfort"
oversize_limit: "10"
ports: "<your_own_value>"
post_lang: "jisx0201"
proxy_after_tcp_handshake: "enable"
range_block: "disable"
retry_count: "0"
scan_bzip2: "enable"
ssl_offloaded: "no"
status: "enable"
stream_based_uncompressed_limit: "0"
streaming_content_bypass: "enable"
strip_x_forwarded_for: "disable"
switching_protocols: "bypass"
tcp_window_maximum: "8388608"
tcp_window_minimum: "131072"
tcp_window_size: "262144"
tcp_window_type: "auto-tuning"
tunnel_non_http: "enable"
uncompressed_nest_limit: "12"
uncompressed_oversize_limit: "10"
unknown_content_encoding: "block"
unknown_http_version: "reject"
verify_dns_for_policy_matching: "enable"
imap:
inspect_all: "enable"
options: "fragmail"
oversize_limit: "10"
ports: "<your_own_value>"
proxy_after_tcp_handshake: "enable"
scan_bzip2: "enable"
ssl_offloaded: "no"
status: "enable"
uncompressed_nest_limit: "12"
uncompressed_oversize_limit: "10"
mail_signature:
signature: "<your_own_value>"
status: "disable"
mapi:
options: "fragmail"
oversize_limit: "10"
ports: "<your_own_value>"
scan_bzip2: "enable"
status: "enable"
uncompressed_nest_limit: "12"
uncompressed_oversize_limit: "10"
name: "default_name_98"
nntp:
inspect_all: "enable"
options: "oversize"
oversize_limit: "10"
ports: "<your_own_value>"
proxy_after_tcp_handshake: "enable"
scan_bzip2: "enable"
status: "enable"
uncompressed_nest_limit: "12"
uncompressed_oversize_limit: "10"
oversize_log: "disable"
pop3:
inspect_all: "enable"
options: "fragmail"
oversize_limit: "10"
ports: "<your_own_value>"
proxy_after_tcp_handshake: "enable"
scan_bzip2: "enable"
ssl_offloaded: "no"
status: "enable"
uncompressed_nest_limit: "12"
uncompressed_oversize_limit: "10"
replacemsg_group: "<your_own_value> (source system.replacemsg-group.name)"
rpc_over_http: "enable"
smtp:
inspect_all: "enable"
options: "fragmail"
oversize_limit: "10"
ports: "<your_own_value>"
proxy_after_tcp_handshake: "enable"
scan_bzip2: "enable"
server_busy: "enable"
ssl_offloaded: "no"
status: "enable"
uncompressed_nest_limit: "12"
uncompressed_oversize_limit: "10"
ssh:
comfort_amount: "1"
comfort_interval: "10"
options: "oversize"
oversize_limit: "10"
scan_bzip2: "enable"
ssl_offloaded: "no"
stream_based_uncompressed_limit: "0"
tcp_window_maximum: "8388608"
tcp_window_minimum: "131072"
tcp_window_size: "262144"
tcp_window_type: "auto-tuning"
uncompressed_nest_limit: "12"
uncompressed_oversize_limit: "10"
switching_protocols_log: "disable"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |