fmgd_firewall_profileprotocoloptions – Configure protocol options.

Added in version 1.1.0.

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 v7.x.

Requirements

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

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.4.8 -> v7.4.10, v7.6.4 -> 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
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • firewall_profileprotocoloptions - Configure protocol options. type: dict
    • cifs Cifs. type: dict more...
      • domain_controller (Alias name: domain-controller) Domain for which to decrypt cifs traffic. type: list 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 (mb). 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. 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...
      • 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 (mb). type: int more...
      • file_filter (Alias name: file-filter) File filter. type: dict more...
        • entries Entries. type: list more...
          • action Action. type: str choices: [log, block] more...
          • comment Comment. type: str more...
          • direction Direction. type: str choices: [any, incoming, outgoing] more...
          • file_type (Alias name: file-type) File type. type: list more...
          • filter Filter. type: str more...
          • protocol Protocol. type: list choices: [cifs] more...
        • log Log. type: str choices: [disable, enable] more...
        • status Status. type: str choices: [disable, enable] more...
    • comment Optional comments. type: str more...
    • dns Dns. type: dict more...
      • 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 Ftp. type: dict more...
      • comfort_amount (Alias name: comfort-amount) Number of bytes to send in each transmission for client comforting (bytes). type: int more...
      • comfort_interval (Alias name: comfort-interval) Interval between successive transmissions of data for client comforting (seconds). type: int more...
      • explicit_ftp_tls (Alias name: explicit-ftp-tls) Enable/disable ftp redirection for explicit ftps. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [clientcomfort, oversize, splice, bypass-rest-command, bypass-mode-command] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (mb). 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...
      • stream_based_uncompressed_limit (Alias name: stream-based-uncompressed-limit) Maximum stream-based uncompressed data size that will be scanned in megabytes. 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...
      • 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 (mb). 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...
    • http Http. type: dict more...
      • address_ip_rating (Alias name: address-ip-rating) Enable/disable ip based url rating. type: str choices: [disable, enable] more...
      • 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) Number of bytes to send in each transmission for client comforting (bytes). type: int more...
      • comfort_interval (Alias name: comfort-interval) Interval between successive transmissions of data for client comforting (seconds). type: int more...
      • dns_protection (Alias name: dns-protection) Enable/disable dns protection for http/https traffic. type: str choices: [disable, enable] more...
      • domain_fronting (Alias name: domain-fronting) Domain fronting. type: str choices: [monitor, block, allow, disable, enable, strict] more...
      • encrypted_file (Alias name: encrypted-file) Encrypted file. type: str choices: [block, pass, inspect] more...
      • encrypted_file_log (Alias name: encrypted-file-log) Encrypted file log. type: str choices: [disable, enable] more...
      • h2c Enable/disable h2c http connection upgrade. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, chunkedbypass, clientcomfort, servercomfort] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (mb). 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...
      • 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 in megabytes. 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. 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...
      • 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 (mb). type: int 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...
      • 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...
      • 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...
      • 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...
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] 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...
      • http_0_9 (Alias name: http-0.9) Configure action to take upon receipt of http 0. type: str choices: [block, allow] more...
    • imap Imap. type: dict more...
      • address_ip_rating (Alias name: address-ip-rating) Address ip rating. type: str choices: [disable, enable] more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, fragmail] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (mb). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 143). 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 (mb). type: int 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...
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
    • mail_signature (Alias name: mail-signature) Mail signature. type: dict more...
      • 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 Mapi. type: dict more...
      • options One or more options that can be applied to the session. type: list choices: [fragmail, oversize] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (mb). 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 (mb). type: int more...
    • name Name. type: str more...
    • nntp Nntp. type: dict more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, splice] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (mb). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 119). 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 (mb). type: int 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...
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
    • oversize_log (Alias name: oversize-log) Enable/disable logging for antivirus oversize file blocking. type: str choices: [disable, enable] more...
    • pop3 Pop3. type: dict more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, fragmail] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (mb). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 110). 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 (mb). type: int 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...
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
    • proxy_redirect (Alias name: proxy-redirect) Proxy redirect. type: dict more...
      • ports Ports. type: list more...
      • status Status. type: str choices: [disable, enable] more...
    • replacemsg_group (Alias name: replacemsg-group) Name of the replacement message group to be used. type: list more...
    • rpc_over_http (Alias name: rpc-over-http) Enable/disable inspection of rpc over http. type: str choices: [disable, enable] more...
    • smtp Smtp. type: dict more...
      • options One or more options that can be applied to the session. type: list choices: [oversize, fragmail, splice] more...
      • oversize_limit (Alias name: oversize-limit) Maximum in-memory file size that can be scanned (mb). type: int more...
      • ports Ports to scan for content (1 - 65535, default = 25). type: list 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 (mb). type: int 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...
      • inspect_all (Alias name: inspect-all) Enable/disable the inspection of all ports for the protocol. type: str choices: [disable, enable] more...
    • ssh Ssh. type: dict more...
      • comfort_amount (Alias name: comfort-amount) Number of bytes to send in each transmission for client comforting (bytes). type: int more...
      • comfort_interval (Alias name: comfort-interval) Interval between successive transmissions of data for client comforting (seconds). 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 (mb). 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...
      • stream_based_uncompressed_limit (Alias name: stream-based-uncompressed-limit) Maximum stream-based uncompressed data size that will be scanned in megabytes. 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...
      • 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 (mb). type: int more...
      • explicit_ftp_tls (Alias name: explicit-ftp-tls) Explicit ftp tls. 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) Feature set. type: str choices: [proxy, flow] more...
    • rtmp Rtmp. type: dict more...
      • http_tunnel (Alias name: http-tunnel) Enable/disable rtmp http tunnel. type: str choices: [disable, enable] more...
      • ports Ports to scan for content (1 - 65535, default = 80). type: list more...
      • rtmpt Enable/disable rtmpt. type: str choices: [disable, enable] more...
      • status Enable/disable the active status of scanning for this protocol. type: str choices: [disable, enable] 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 (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure protocol options.
      fortinet.fmgdevice.fmgd_firewall_profileprotocoloptions:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        state: present # <value in [present, absent]>
        firewall_profileprotocoloptions:
          name: "your value" # Required variable, string
          # cifs:
          #   domain_controller: <list or string>
          #   options:
          #     - "oversize"
          #   oversize_limit: <integer>
          #   ports: <list or integer>
          #   scan_bzip2: <value in [disable, enable]>
          #   server_credential_type: <value in [none, credential-replication, credential-keytab]>
          #   server_keytab:
          #     - keytab: <string>
          #       password: <list or string>
          #       principal: <string>
          #   status: <value in [disable, enable]>
          #   tcp_window_maximum: <integer>
          #   tcp_window_minimum: <integer>
          #   tcp_window_size: <integer>
          #   tcp_window_type: <value in [system, static, dynamic, ...]>
          #   uncompressed_nest_limit: <integer>
          #   uncompressed_oversize_limit: <integer>
          #   file_filter:
          #     entries:
          #       - action: <value in [log, block]>
          #         comment: <string>
          #         direction: <value in [any, incoming, outgoing]>
          #         file_type: <list or string>
          #         filter: <string>
          #         protocol:
          #           - "cifs"
          #     log: <value in [disable, enable]>
          #     status: <value in [disable, enable]>
          # comment: <string>
          # dns:
          #   ports: <list or integer>
          #   status: <value in [disable, enable]>
          # ftp:
          #   comfort_amount: <integer>
          #   comfort_interval: <integer>
          #   explicit_ftp_tls: <value in [disable, enable]>
          #   options:
          #     - "clientcomfort"
          #     - "oversize"
          #     - "splice"
          #     - "bypass-rest-command"
          #     - "bypass-mode-command"
          #   oversize_limit: <integer>
          #   ports: <list or integer>
          #   scan_bzip2: <value in [disable, enable]>
          #   ssl_offloaded: <value in [no, yes]>
          #   status: <value in [disable, enable]>
          #   stream_based_uncompressed_limit: <integer>
          #   tcp_window_maximum: <integer>
          #   tcp_window_minimum: <integer>
          #   tcp_window_size: <integer>
          #   tcp_window_type: <value in [system, static, dynamic, ...]>
          #   uncompressed_nest_limit: <integer>
          #   uncompressed_oversize_limit: <integer>
          #   inspect_all: <value in [disable, enable]>
          # http:
          #   address_ip_rating: <value in [disable, enable]>
          #   block_page_status_code: <integer>
          #   comfort_amount: <integer>
          #   comfort_interval: <integer>
          #   dns_protection: <value in [disable, enable]>
          #   domain_fronting: <value in [monitor, block, allow, ...]>
          #   encrypted_file: <value in [block, pass, inspect]>
          #   encrypted_file_log: <value in [disable, enable]>
          #   h2c: <value in [disable, enable]>
          #   options:
          #     - "oversize"
          #     - "chunkedbypass"
          #     - "clientcomfort"
          #     - "servercomfort"
          #   oversize_limit: <integer>
          #   ports: <list or integer>
          #   post_lang:
          #     - "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"
          #   range_block: <value in [disable, enable]>
          #   retry_count: <integer>
          #   scan_bzip2: <value in [disable, enable]>
          #   ssl_offloaded: <value in [no, yes]>
          #   status: <value in [disable, enable]>
          #   stream_based_uncompressed_limit: <integer>
          #   streaming_content_bypass: <value in [disable, enable]>
          #   strip_x_forwarded_for: <value in [disable, enable]>
          #   switching_protocols: <value in [bypass, block]>
          #   tcp_window_maximum: <integer>
          #   tcp_window_minimum: <integer>
          #   tcp_window_size: <integer>
          #   tcp_window_type: <value in [system, static, dynamic, ...]>
          #   tunnel_non_http: <value in [disable, enable]>
          #   uncompressed_nest_limit: <integer>
          #   uncompressed_oversize_limit: <integer>
          #   unknown_content_encoding: <value in [block, inspect, bypass]>
          #   unknown_http_version: <value in [best-effort, reject, tunnel]>
          #   verify_dns_for_policy_matching: <value in [disable, enable]>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   inspect_all: <value in [disable, enable]>
          #   fortinet_bar: <value in [disable, enable]>
          #   fortinet_bar_port: <integer>
          #   http_0_9: <value in [block, allow]>
          # imap:
          #   address_ip_rating: <value in [disable, enable]>
          #   options:
          #     - "oversize"
          #     - "fragmail"
          #   oversize_limit: <integer>
          #   ports: <list or integer>
          #   scan_bzip2: <value in [disable, enable]>
          #   ssl_offloaded: <value in [no, yes]>
          #   status: <value in [disable, enable]>
          #   uncompressed_nest_limit: <integer>
          #   uncompressed_oversize_limit: <integer>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   inspect_all: <value in [disable, enable]>
          # mail_signature:
          #   signature: <string>
          #   status: <value in [disable, enable]>
          # mapi:
          #   options:
          #     - "fragmail"
          #     - "oversize"
          #   oversize_limit: <integer>
          #   ports: <list or integer>
          #   scan_bzip2: <value in [disable, enable]>
          #   status: <value in [disable, enable]>
          #   uncompressed_nest_limit: <integer>
          #   uncompressed_oversize_limit: <integer>
          # nntp:
          #   options:
          #     - "oversize"
          #     - "splice"
          #   oversize_limit: <integer>
          #   ports: <list or integer>
          #   scan_bzip2: <value in [disable, enable]>
          #   status: <value in [disable, enable]>
          #   uncompressed_nest_limit: <integer>
          #   uncompressed_oversize_limit: <integer>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   inspect_all: <value in [disable, enable]>
          # oversize_log: <value in [disable, enable]>
          # pop3:
          #   options:
          #     - "oversize"
          #     - "fragmail"
          #   oversize_limit: <integer>
          #   ports: <list or integer>
          #   scan_bzip2: <value in [disable, enable]>
          #   ssl_offloaded: <value in [no, yes]>
          #   status: <value in [disable, enable]>
          #   uncompressed_nest_limit: <integer>
          #   uncompressed_oversize_limit: <integer>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   inspect_all: <value in [disable, enable]>
          # proxy_redirect:
          #   ports: <list or integer>
          #   status: <value in [disable, enable]>
          # replacemsg_group: <list or string>
          # rpc_over_http: <value in [disable, enable]>
          # smtp:
          #   options:
          #     - "oversize"
          #     - "fragmail"
          #     - "splice"
          #   oversize_limit: <integer>
          #   ports: <list or integer>
          #   scan_bzip2: <value in [disable, enable]>
          #   server_busy: <value in [disable, enable]>
          #   ssl_offloaded: <value in [no, yes]>
          #   status: <value in [disable, enable]>
          #   uncompressed_nest_limit: <integer>
          #   uncompressed_oversize_limit: <integer>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   inspect_all: <value in [disable, enable]>
          # ssh:
          #   comfort_amount: <integer>
          #   comfort_interval: <integer>
          #   options:
          #     - "oversize"
          #     - "clientcomfort"
          #     - "servercomfort"
          #   oversize_limit: <integer>
          #   scan_bzip2: <value in [disable, enable]>
          #   ssl_offloaded: <value in [no, yes]>
          #   stream_based_uncompressed_limit: <integer>
          #   tcp_window_maximum: <integer>
          #   tcp_window_minimum: <integer>
          #   tcp_window_size: <integer>
          #   tcp_window_type: <value in [system, static, dynamic, ...]>
          #   uncompressed_nest_limit: <integer>
          #   uncompressed_oversize_limit: <integer>
          #   explicit_ftp_tls: <value in [disable, enable]>
          # switching_protocols_log: <value in [disable, enable]>
          # feature_set: <value in [proxy, flow]>
          # rtmp:
          #   http_tunnel: <value in [disable, enable]>
          #   ports: <list or integer>
          #   rtmpt: <value in [disable, enable]>
          #   status: <value in [disable, enable]>

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)