fmgr_firewall_profileprotocoloptions – Configure protocol options.

Added in version 2.0.0.

Warning

Starting in version 3.0.0, all input arguments will be named using the underscore naming convention (snake_case).

  • Argument name before 3.0.0: var-name, var name, var.name

  • New argument name starting in 3.0.0: var_name

FortiManager Ansible v2.4+ supports both previous argument name and new underscore name. You will receive deprecation warnings if you keep using the previous argument name. You can ignore the warning by setting deprecation_warnings=False in ansible.cfg.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v6.x and v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.15.0

FortiManager Version Compatibility

Supported Version Ranges: v6.0.0 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • state - The directive to create, update or delete an object type: str required: true choices: present, absent
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • adom - The parameter in requested url type: str required: true
  • firewall_profileprotocoloptions - Configure protocol options. type: dict
    • comment Optional comments. type: str more...
    • name Name. type: str more...
    • oversize_log (Alias name: oversize-log) Enable/disable logging for antivirus oversize file blocking. type: str choices: [disable, enable] more...
    • replacemsg_group (Alias name: replacemsg-group) Name of the replacement message group to be used type: str more...
    • rpc_over_http (Alias name: rpc-over-http) Enable/disable inspection of rpc over http. type: str choices: [disable, enable] more...
    • switching_protocols_log (Alias name: switching-protocols-log) Enable/disable logging for http/https switching protocols. type: str choices: [disable, enable] more...
    • feature_set (Alias name: feature-set) Flow/proxy feature set. type: str choices: [proxy, flow] more...
    • cifs type: dict
      • domain_controller (Alias name: domain-controller) Domain for which to decrypt cifs traffic. type: str more...
      • file_filter (Alias name: file-filter) type: dict
        • entries Entries. type: list more...
          • action Action taken for matched file. type: str choices: [log, block] more...
          • comment Comment. type: str more...
          • direction Match files transmitted in the sessions originating or reply direction. type: str choices: [any, incoming, outgoing] more...
          • file_type (Alias name: file-type) Select file type. type: list more...
          • filter Add a file filter. type: str more...
          • protocol Protocols to apply with. type: list choices: [cifs] more...
        • log Enable/disable file filter logging. type: str choices: [disable, enable] more...
        • status Enable/disable file filter. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [oversize] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 445). type: list more...
      • scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable] more...
      • server_credential_type (Alias name: server-credential-type) Cifs server credential type. type: str choices: [none, credential-replication, credential-keytab] more...
      • server_keytab (Alias name: server-keytab) Server-keytab. type: list more...
        • keytab Base64 encoded keytab file containing credential of the server. type: str more...
        • password Password for keytab. type: list more...
        • principal Service principal. type: str more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
      • tcp_window_maximum (Alias name: tcp-window-maximum) Maximum dynamic tcp window size (default = 8mb). type: int more...
      • tcp_window_minimum (Alias name: tcp-window-minimum) Minimum dynamic tcp window size (default = 128kb). type: int more...
      • tcp_window_size (Alias name: tcp-window-size) Set tcp static window size (default = 256kb). type: int more...
      • tcp_window_type (Alias name: tcp-window-type) Specify type of tcp window to use for this protocol. type: str choices: [system, static, dynamic, auto-tuning] more...
      • uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
      • uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int more...
    • dns type: dict
      • ports Ports to scan for content (1 - 65535, default = 53). type: list more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
    • ftp type: dict
      • comfort_amount (Alias name: comfort-amount) Amount of data to send in a transmission for client comforting (1 - 65535 bytes, default = 1). type: int more...
      • comfort_interval (Alias name: comfort-interval) Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, default = 10). type: int more...
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [clientcomfort, no-content-summary, oversize, splice, bypass-rest-command, bypass-mode-command] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 21). type: list more...
      • scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable] more...
      • ssl_offloaded (Alias name: ssl-offloaded) Ssl decryption and encryption performed by an external device. type: str choices: [no, yes] more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
      • uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
      • uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int more...
      • stream_based_uncompressed_limit (Alias name: stream-based-uncompressed-limit) Maximum stream-based uncompressed data size that will be scanned (mb, 0 = unlimited (default). type: int more...
      • tcp_window_maximum (Alias name: tcp-window-maximum) Maximum dynamic tcp window size. type: int more...
      • tcp_window_minimum (Alias name: tcp-window-minimum) Minimum dynamic tcp window size. type: int more...
      • tcp_window_size (Alias name: tcp-window-size) Set tcp static window size. type: int more...
      • tcp_window_type (Alias name: tcp-window-type) Tcp window type to use for this protocol. type: str choices: [system, static, dynamic, auto-tuning] more...
      • explicit_ftp_tls (Alias name: explicit-ftp-tls) Enable/disable ftp redirection for explicit ftps. type: str choices: [disable, enable] more...
    • http type: dict
      • block_page_status_code (Alias name: block-page-status-code) Code number returned for blocked http pages (non-fortiguard only) (100 - 599, default = 403). type: int more...
      • comfort_amount (Alias name: comfort-amount) Amount of data to send in a transmission for client comforting (1 - 65535 bytes, default = 1). type: int more...
      • comfort_interval (Alias name: comfort-interval) Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, default = 10). type: int more...
      • fortinet_bar (Alias name: fortinet-bar) Enable/disable fortinet bar on html content. type: str choices: [disable, enable] more...
      • fortinet_bar_port (Alias name: fortinet-bar-port) Port for use by fortinet bar (1 - 65535, default = 8011). type: int more...
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, chunkedbypass, clientcomfort, no-content-summary, servercomfort] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 80). type: list more...
      • post_lang (Alias name: post-lang) 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). type: list 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] more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • range_block (Alias name: range-block) Enable/disable blocking of partial downloads. type: str choices: [disable, enable] more...
      • retry_count (Alias name: retry-count) Number of attempts to retry http connection (0 - 100, default = 0). type: int more...
      • scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable] more...
      • ssl_offloaded (Alias name: ssl-offloaded) Ssl decryption and encryption performed by an external device. type: str choices: [no, yes] more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
      • stream_based_uncompressed_limit (Alias name: stream-based-uncompressed-limit) Maximum stream-based uncompressed data size that will be scanned (mb, 0 = unlimited (default). type: int more...
      • streaming_content_bypass (Alias name: streaming-content-bypass) Enable/disable bypassing of streaming content from buffering. type: str choices: [disable, enable] more...
      • strip_x_forwarded_for (Alias name: strip-x-forwarded-for) Enable/disable stripping of http x-forwarded-for header. type: str choices: [disable, enable] more...
      • switching_protocols (Alias name: switching-protocols) Bypass from scanning, or block a connection that attempts to switch protocol. type: str choices: [bypass, block] more...
      • tcp_window_maximum (Alias name: tcp-window-maximum) Maximum dynamic tcp window size (default = 8mb). type: int more...
      • tcp_window_minimum (Alias name: tcp-window-minimum) Minimum dynamic tcp window size (default = 128kb). type: int more...
      • tcp_window_size (Alias name: tcp-window-size) Set tcp static window size (default = 256kb). type: int more...
      • tcp_window_type (Alias name: tcp-window-type) Specify type of tcp window to use for this protocol. type: str choices: [system, static, dynamic, auto-tuning] more...
      • tunnel_non_http (Alias name: tunnel-non-http) Configure how to process non-http traffic when a profile configured for http traffic accepts a non-http session. type: str choices: [disable, enable] more...
      • uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
      • uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int more...
      • unknown_http_version (Alias name: unknown-http-version) How to handle http sessions that do not comply with http 0. type: str choices: [best-effort, reject, tunnel] more...
      • http_policy (Alias name: http-policy) Enable/disable http policy check. type: str choices: [disable, enable] more...
      • address_ip_rating (Alias name: address-ip-rating) Enable/disable ip based url rating. type: str choices: [disable, enable] more...
      • h2c Enable/disable h2c http connection upgrade. type: str choices: [disable, enable] more...
      • verify_dns_for_policy_matching (Alias name: verify-dns-for-policy-matching) Enable/disable verification of dns for policy matching. type: str choices: [disable, enable] more...
      • unknown_content_encoding (Alias name: unknown-content-encoding) Configure the action the fortigate unit will take on unknown content-encoding. type: str choices: [block, inspect, bypass] more...
    • imap type: dict
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, fragmail, no-content-summary] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 143). type: list more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable] more...
      • ssl_offloaded (Alias name: ssl-offloaded) Ssl decryption and encryption performed by an external device. type: str choices: [no, yes] more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
      • uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
      • uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int more...
    • mail_signature (Alias name: mail-signature) type: dict
      • signature Email signature to be added to outgoing email (if the signature contains spaces, enclose with quotation marks). type: str more...
      • status Enable/disable adding an email signature to smtp email messages as they pass through the fortigate. type: str choices: [disable, enable] more...
    • mapi type: dict
      • options One or more options that can be applied to the session. type: list choices: [fragmail, oversize, no-content-summary] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 135). type: list more...
      • scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable] more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
      • uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
      • uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int more...
    • nntp type: dict
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, no-content-summary, splice] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 119). type: list more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable] more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
      • uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
      • uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int more...
    • pop3 type: dict
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, fragmail, no-content-summary] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 110). type: list more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable] more...
      • ssl_offloaded (Alias name: ssl-offloaded) Ssl decryption and encryption performed by an external device. type: str choices: [no, yes] more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
      • uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
      • uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int more...
    • smtp type: dict
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, fragmail, no-content-summary, splice] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 25). type: list more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable] more...
      • server_busy (Alias name: server-busy) Enable/disable smtp server busy when server not available. type: str choices: [disable, enable] more...
      • ssl_offloaded (Alias name: ssl-offloaded) Ssl decryption and encryption performed by an external device. type: str choices: [no, yes] more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] more...
      • uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
      • uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int more...
    • ssh type: dict
      • comfort_amount (Alias name: comfort-amount) Amount of data to send in a transmission for client comforting (1 - 65535 bytes, default = 1). type: int more...
      • comfort_interval (Alias name: comfort-interval) Period of time between start, or last transmission, and the next client comfort transmission of data (1 - 900 sec, default = 10). type: int more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, clientcomfort, servercomfort] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (1 - 383 mb, default = 10). type: int more...
      • scan_bzip2 (Alias name: scan-bzip2) Enable/disable scanning of bzip2 compressed files. type: str choices: [disable, enable] more...
      • uncompressed_nest_limit (Alias name: uncompressed-nest-limit) Maximum nested levels of compression that can be uncompressed and scanned (2 - 100, default = 12). type: int more...
      • uncompressed_oversize_limit (Alias name: uncompressed-oversize-limit) Maximum in-memory uncompressed file size that can be scanned (0 - 383 mb, 0 = unlimited, default = 10). type: int more...
      • ssl_offloaded (Alias name: ssl-offloaded) Ssl decryption and encryption performed by an external device. type: str choices: [no, yes] more...
      • stream_based_uncompressed_limit (Alias name: stream-based-uncompressed-limit) Maximum stream-based uncompressed data size that will be scanned (mb, 0 = unlimited (default). type: int more...
      • tcp_window_maximum (Alias name: tcp-window-maximum) Maximum dynamic tcp window size. type: int more...
      • tcp_window_minimum (Alias name: tcp-window-minimum) Minimum dynamic tcp window size. type: int more...
      • tcp_window_size (Alias name: tcp-window-size) Set tcp static window size. type: int more...
      • tcp_window_type (Alias name: tcp-window-type) Tcp window type to use for this protocol. type: str choices: [system, static, dynamic, auto-tuning] more...

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

- 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: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)