Skip to content

Latest commit

 

History

History
3895 lines (3851 loc) · 182 KB

fortios_firewall_ssl_ssh_profile.rst

File metadata and controls

3895 lines (3851 loc) · 182 KB
source:fortios_firewall_ssl_ssh_profile.py
orphan:

fortios_firewall_ssl_ssh_profile -- Configure SSL/SSH protocol options in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

  • This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall feature and ssl_ssh_profile category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0

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

  • ansible>=2.14

Using member operation to add an element to an existing object.


Supported Version Ranges
fortios_firewall_ssl_ssh_profile v6.0.0 -> latest

  • access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • vdom - 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. type: str default: root
  • member_path - Member attribute path to operate on. type: str
  • member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
  • state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
  • firewall_ssl_ssh_profile - Configure SSL/SSH protocol options. type: dict more...
    Supported Version Ranges
    firewall_ssl_ssh_profile v6.0.0 -> latest
    • allowlist - Enable/disable exempting servers by FortiGuard allowlist. type: str choices: enable, disable more...
      Supported Version Ranges
      allowlist v7.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • block_blacklisted_certificates - Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blacklist. type: str choices: disable, enable more...
      Supported Version Ranges
      block_blacklisted_certificates v6.2.0 -> v6.4.4
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • block_blocklisted_certificates - Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blocklist. type: str choices: disable, enable more...
      Supported Version Ranges
      block_blocklisted_certificates v7.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • caname - CA certificate used by SSL Inspection. Source vpn.certificate.local.name. type: str more...
      Supported Version Ranges
      caname v6.0.0 -> latest
    • comment - Optional comments. type: str more...
      Supported Version Ranges
      comment v6.0.0 -> latest
    • dot - Configure DNS over TLS options. type: dict more...
      Supported Version Ranges
      dot v7.0.0 -> latest
      • cert_validation_failure - Action based on certificate validation failure. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_failure v7.0.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • cert_validation_timeout - Action based on certificate validation timeout. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_timeout v7.0.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • client_certificate - Action based on received client certificate. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_certificate v7.0.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • expired_server_cert - Action based on server certificate is expired. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        expired_server_cert v7.0.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • proxy_after_tcp_handshake - Proxy traffic after the TCP 3-way handshake has been established (not before). type: str choices: enable, disable more...
        Supported Version Ranges
        proxy_after_tcp_handshake v7.0.0 -> latest
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • quic - Enable/disable QUIC inspection . type: str choices: disable, enable more...
        Supported Version Ranges
        quic v7.4.1 -> latest
        [disable] v6.0.0 -> latest
        [enable] v6.0.0 -> latest
      • revoked_server_cert - Action based on server certificate is revoked. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        revoked_server_cert v7.0.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • sni_server_cert_check - Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. type: str choices: enable, strict, disable more...
        Supported Version Ranges
        sni_server_cert_check v7.0.0 -> latest
        [enable] v6.0.0 -> latest
        [strict] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • status - Configure protocol inspection status. type: str choices: disable, deep-inspection more...
        Supported Version Ranges
        status v7.0.0 -> latest
        [disable] v6.0.0 -> latest
        [deep-inspection] v6.0.0 -> latest
      • unsupported_ssl_cipher - Action based on the SSL cipher used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_cipher v7.0.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_negotiation - Action based on the SSL negotiation used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_negotiation v7.0.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_version - Action based on the SSL version used being unsupported. type: str choices: allow, block, inspect more...
        Supported Version Ranges
        unsupported_ssl_version v7.0.1 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [inspect] v7.0.1 -> v7.0.3
      • untrusted_server_cert - Action based on server certificate is not issued by a trusted CA. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_server_cert v7.0.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
    • ftps - Configure FTPS options. type: dict more...
      Supported Version Ranges
      ftps v6.0.0 -> latest
      • allow_invalid_server_cert - When enabled, allows SSL sessions whose server certificate validation failed. type: str choices: enable, disable more...
        Supported Version Ranges
        allow_invalid_server_cert v6.0.0 -> v6.0.11
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • cert_validation_failure - Action based on certificate validation failure. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_failure v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • cert_validation_timeout - Action based on certificate validation timeout. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_timeout v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • client_cert_request - Action based on client certificate request. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • client_certificate - Action based on received client certificate. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • expired_server_cert - Action based on server certificate is expired. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        expired_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • invalid_server_cert - Allow or block the invalid SSL session server certificate. type: str choices: allow, block more...
        Supported Version Ranges
        invalid_server_cert v6.2.0 -> v6.2.7
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • min_allowed_ssl_version - Minimum SSL version to be allowed. type: str choices: ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3 more...
        Supported Version Ranges
        min_allowed_ssl_version v7.0.4 -> latest
        [ssl-3.0] v6.0.0 -> latest
        [tls-1.0] v6.0.0 -> latest
        [tls-1.1] v6.0.0 -> latest
        [tls-1.2] v6.0.0 -> latest
        [tls-1.3] v6.0.0 -> latest
      • ports - Ports to use for scanning (1 - 65535). type: list
      • revoked_server_cert - Action based on server certificate is revoked. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        revoked_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • sni_server_cert_check - Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. type: str choices: enable, strict, disable more...
        Supported Version Ranges
        sni_server_cert_check v6.2.0 -> latest
        [enable] v6.0.0 -> latest
        [strict] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • status - Configure protocol inspection status. type: str choices: disable, deep-inspection more...
        Supported Version Ranges
        status v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [deep-inspection] v6.0.0 -> latest
      • unsupported_ssl - Action based on the SSL encryption used being unsupported. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        unsupported_ssl v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_cipher - Action based on the SSL cipher used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_cipher v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_negotiation - Action based on the SSL negotiation used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_negotiation v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_version - Action based on the SSL version used being unsupported. type: str choices: allow, block, inspect more...
        Supported Version Ranges
        unsupported_ssl_version v7.0.1 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [inspect] v7.0.1 -> v7.0.3
      • untrusted_cert - Allow, ignore, or block the untrusted SSL session server certificate. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_cert v6.0.0 -> v6.0.11
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • untrusted_server_cert - Action based on server certificate is not issued by a trusted CA. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_server_cert v6.2.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
    • https - Configure HTTPS options. type: dict more...
      Supported Version Ranges
      https v6.0.0 -> latest
      • allow_invalid_server_cert - When enabled, allows SSL sessions whose server certificate validation failed. type: str choices: enable, disable more...
        Supported Version Ranges
        allow_invalid_server_cert v6.0.0 -> v6.0.11
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • cert_probe_failure - Action based on certificate probe failure. type: str choices: allow, block more...
        Supported Version Ranges
        cert_probe_failure v7.0.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • cert_validation_failure - Action based on certificate validation failure. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_failure v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • cert_validation_timeout - Action based on certificate validation timeout. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_timeout v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • client_cert_request - Action based on client certificate request. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • client_certificate - Action based on received client certificate. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • expired_server_cert - Action based on server certificate is expired. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        expired_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • invalid_server_cert - Allow or block the invalid SSL session server certificate. type: str choices: allow, block more...
        Supported Version Ranges
        invalid_server_cert v6.2.0 -> v6.2.7
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • min_allowed_ssl_version - Minimum SSL version to be allowed. type: str choices: ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3 more...
        Supported Version Ranges
        min_allowed_ssl_version v7.0.4 -> latest
        [ssl-3.0] v6.0.0 -> latest
        [tls-1.0] v6.0.0 -> latest
        [tls-1.1] v6.0.0 -> latest
        [tls-1.2] v6.0.0 -> latest
        [tls-1.3] v6.0.0 -> latest
      • ports - Ports to use for scanning (1 - 65535). type: list
      • proxy_after_tcp_handshake - Proxy traffic after the TCP 3-way handshake has been established (not before). type: str choices: enable, disable more...
        Supported Version Ranges
        proxy_after_tcp_handshake v6.4.0 -> latest
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • quic - Enable/disable QUIC inspection . type: str choices: disable, enable more...
        Supported Version Ranges
        quic v7.4.1 -> latest
        [disable] v6.0.0 -> latest
        [enable] v6.0.0 -> latest
      • revoked_server_cert - Action based on server certificate is revoked. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        revoked_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • sni_server_cert_check - Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. type: str choices: enable, strict, disable more...
        Supported Version Ranges
        sni_server_cert_check v6.2.0 -> latest
        [enable] v6.0.0 -> latest
        [strict] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • status - Configure protocol inspection status. type: str choices: disable, certificate-inspection, deep-inspection more...
        Supported Version Ranges
        status v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [certificate-inspection] v6.0.0 -> latest
        [deep-inspection] v6.0.0 -> latest
      • unsupported_ssl - Action based on the SSL encryption used being unsupported. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        unsupported_ssl v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_cipher - Action based on the SSL cipher used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_cipher v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_negotiation - Action based on the SSL negotiation used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_negotiation v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_version - Action based on the SSL version used being unsupported. type: str choices: allow, block, inspect more...
        Supported Version Ranges
        unsupported_ssl_version v7.0.1 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [inspect] v7.0.1 -> v7.0.3
      • untrusted_cert - Allow, ignore, or block the untrusted SSL session server certificate. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_cert v6.0.0 -> v6.0.11
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • untrusted_server_cert - Action based on server certificate is not issued by a trusted CA. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_server_cert v6.2.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
    • imaps - Configure IMAPS options. type: dict more...
      Supported Version Ranges
      imaps v6.0.0 -> latest
      • allow_invalid_server_cert - When enabled, allows SSL sessions whose server certificate validation failed. type: str choices: enable, disable more...
        Supported Version Ranges
        allow_invalid_server_cert v6.0.0 -> v6.0.11
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • cert_validation_failure - Action based on certificate validation failure. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_failure v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • cert_validation_timeout - Action based on certificate validation timeout. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_timeout v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • client_cert_request - Action based on client certificate request. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • client_certificate - Action based on received client certificate. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • expired_server_cert - Action based on server certificate is expired. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        expired_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • invalid_server_cert - Allow or block the invalid SSL session server certificate. type: str choices: allow, block more...
        Supported Version Ranges
        invalid_server_cert v6.2.0 -> v6.2.7
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • ports - Ports to use for scanning (1 - 65535). type: list
      • proxy_after_tcp_handshake - Proxy traffic after the TCP 3-way handshake has been established (not before). type: str choices: enable, disable more...
        Supported Version Ranges
        proxy_after_tcp_handshake v6.4.0 -> latest
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • revoked_server_cert - Action based on server certificate is revoked. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        revoked_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • sni_server_cert_check - Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. type: str choices: enable, strict, disable more...
        Supported Version Ranges
        sni_server_cert_check v6.2.0 -> latest
        [enable] v6.0.0 -> latest
        [strict] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • status - Configure protocol inspection status. type: str choices: disable, deep-inspection more...
        Supported Version Ranges
        status v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [deep-inspection] v6.0.0 -> latest
      • unsupported_ssl - Action based on the SSL encryption used being unsupported. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        unsupported_ssl v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_cipher - Action based on the SSL cipher used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_cipher v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_negotiation - Action based on the SSL negotiation used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_negotiation v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_version - Action based on the SSL version used being unsupported. type: str choices: allow, block, inspect more...
        Supported Version Ranges
        unsupported_ssl_version v7.0.1 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [inspect] v7.0.1 -> v7.0.3
      • untrusted_cert - Allow, ignore, or block the untrusted SSL session server certificate. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_cert v6.0.0 -> v6.0.11
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • untrusted_server_cert - Action based on server certificate is not issued by a trusted CA. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_server_cert v6.2.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
    • mapi_over_https - Enable/disable inspection of MAPI over HTTPS. type: str choices: enable, disable more...
      Supported Version Ranges
      mapi_over_https v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • name - Name. type: str required: true more...
      Supported Version Ranges
      name v6.0.0 -> latest
    • pop3s - Configure POP3S options. type: dict more...
      Supported Version Ranges
      pop3s v6.0.0 -> latest
      • allow_invalid_server_cert - When enabled, allows SSL sessions whose server certificate validation failed. type: str choices: enable, disable more...
        Supported Version Ranges
        allow_invalid_server_cert v6.0.0 -> v6.0.11
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • cert_validation_failure - Action based on certificate validation failure. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_failure v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • cert_validation_timeout - Action based on certificate validation timeout. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_timeout v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • client_cert_request - Action based on client certificate request. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • client_certificate - Action based on received client certificate. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • expired_server_cert - Action based on server certificate is expired. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        expired_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • invalid_server_cert - Allow or block the invalid SSL session server certificate. type: str choices: allow, block more...
        Supported Version Ranges
        invalid_server_cert v6.2.0 -> v6.2.7
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • ports - Ports to use for scanning (1 - 65535). type: list
      • proxy_after_tcp_handshake - Proxy traffic after the TCP 3-way handshake has been established (not before). type: str choices: enable, disable more...
        Supported Version Ranges
        proxy_after_tcp_handshake v6.4.0 -> latest
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • revoked_server_cert - Action based on server certificate is revoked. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        revoked_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • sni_server_cert_check - Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. type: str choices: enable, strict, disable more...
        Supported Version Ranges
        sni_server_cert_check v6.2.0 -> latest
        [enable] v6.0.0 -> latest
        [strict] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • status - Configure protocol inspection status. type: str choices: disable, deep-inspection more...
        Supported Version Ranges
        status v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [deep-inspection] v6.0.0 -> latest
      • unsupported_ssl - Action based on the SSL encryption used being unsupported. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        unsupported_ssl v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_cipher - Action based on the SSL cipher used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_cipher v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_negotiation - Action based on the SSL negotiation used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_negotiation v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_version - Action based on the SSL version used being unsupported. type: str choices: allow, block, inspect more...
        Supported Version Ranges
        unsupported_ssl_version v7.0.1 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [inspect] v7.0.1 -> v7.0.3
      • untrusted_cert - Allow, ignore, or block the untrusted SSL session server certificate. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_cert v6.0.0 -> v6.0.11
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • untrusted_server_cert - Action based on server certificate is not issued by a trusted CA. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_server_cert v6.2.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
    • rpc_over_https - Enable/disable inspection of RPC over HTTPS. type: str choices: enable, disable more...
      Supported Version Ranges
      rpc_over_https v6.0.0 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • server_cert - Certificate used by SSL Inspection to replace server certificate. Source vpn.certificate.local.name. type: list member_path: server_cert:name more...
      Supported Version Ranges
      server_cert v6.0.0 -> latest
      • name - Certificate list. Source vpn.certificate.local.name. type: str required: true more...
        Supported Version Ranges
        name v7.0.0 -> latest
    • server_cert_mode - Re-sign or replace the server"s certificate. type: str choices: re-sign, replace more...
      Supported Version Ranges
      server_cert_mode v6.0.0 -> latest
      [re-sign] v6.0.0 -> latest
      [replace] v6.0.0 -> latest
    • smtps - Configure SMTPS options. type: dict more...
      Supported Version Ranges
      smtps v6.0.0 -> latest
      • allow_invalid_server_cert - When enabled, allows SSL sessions whose server certificate validation failed. type: str choices: enable, disable more...
        Supported Version Ranges
        allow_invalid_server_cert v6.0.0 -> v6.0.11
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • cert_validation_failure - Action based on certificate validation failure. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_failure v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • cert_validation_timeout - Action based on certificate validation timeout. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_timeout v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • client_cert_request - Action based on client certificate request. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • client_certificate - Action based on received client certificate. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • expired_server_cert - Action based on server certificate is expired. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        expired_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • invalid_server_cert - Allow or block the invalid SSL session server certificate. type: str choices: allow, block more...
        Supported Version Ranges
        invalid_server_cert v6.2.0 -> v6.2.7
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • ports - Ports to use for scanning (1 - 65535). type: list
      • proxy_after_tcp_handshake - Proxy traffic after the TCP 3-way handshake has been established (not before). type: str choices: enable, disable more...
        Supported Version Ranges
        proxy_after_tcp_handshake v6.4.0 -> latest
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • revoked_server_cert - Action based on server certificate is revoked. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        revoked_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • sni_server_cert_check - Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. type: str choices: enable, strict, disable more...
        Supported Version Ranges
        sni_server_cert_check v6.2.0 -> latest
        [enable] v6.0.0 -> latest
        [strict] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • status - Configure protocol inspection status. type: str choices: disable, deep-inspection more...
        Supported Version Ranges
        status v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [deep-inspection] v6.0.0 -> latest
      • unsupported_ssl - Action based on the SSL encryption used being unsupported. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        unsupported_ssl v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_cipher - Action based on the SSL cipher used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_cipher v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_negotiation - Action based on the SSL negotiation used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_negotiation v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_version - Action based on the SSL version used being unsupported. type: str choices: allow, block, inspect more...
        Supported Version Ranges
        unsupported_ssl_version v7.0.1 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [inspect] v7.0.1 -> v7.0.3
      • untrusted_cert - Allow, ignore, or block the untrusted SSL session server certificate. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_cert v6.0.0 -> v6.0.11
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • untrusted_server_cert - Action based on server certificate is not issued by a trusted CA. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_server_cert v6.2.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
    • ssh - Configure SSH options. type: dict more...
      Supported Version Ranges
      ssh v6.0.0 -> latest
      • inspect_all - Level of SSL inspection. type: str choices: disable, deep-inspection more...
        Supported Version Ranges
        inspect_all v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [deep-inspection] v6.0.0 -> latest
      • ports - Ports to use for scanning (1 - 65535). type: list
      • proxy_after_tcp_handshake - Proxy traffic after the TCP 3-way handshake has been established (not before). type: str choices: enable, disable more...
        Supported Version Ranges
        proxy_after_tcp_handshake v6.4.0 -> latest
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • ssh_algorithm - Relative strength of encryption algorithms accepted during negotiation. type: str choices: compatible, high-encryption more...
        Supported Version Ranges
        ssh_algorithm v6.0.0 -> latest
        [compatible] v6.0.0 -> latest
        [high-encryption] v6.0.0 -> latest
      • ssh_policy_check - Enable/disable SSH policy check. type: str choices: disable, enable more...
        Supported Version Ranges
        ssh_policy_check v6.0.0 -> v6.0.11
        [disable] v6.0.0 -> latest
        [enable] v6.0.0 -> latest
      • ssh_tun_policy_check - Enable/disable SSH tunnel policy check. type: str choices: disable, enable more...
        Supported Version Ranges
        ssh_tun_policy_check v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [enable] v6.0.0 -> latest
      • status - Configure protocol inspection status. type: str choices: disable, deep-inspection more...
        Supported Version Ranges
        status v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [deep-inspection] v6.0.0 -> latest
      • unsupported_version - Action based on SSH version being unsupported. type: str choices: bypass, block more...
        Supported Version Ranges
        unsupported_version v6.0.0 -> latest
        [bypass] v6.0.0 -> latest
        [block] v6.0.0 -> latest
    • ssl - Configure SSL options. type: dict more...
      Supported Version Ranges
      ssl v6.0.0 -> latest
      • allow_invalid_server_cert - When enabled, allows SSL sessions whose server certificate validation failed. type: str choices: enable, disable more...
        Supported Version Ranges
        allow_invalid_server_cert v6.0.0 -> v6.0.11
        [enable] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • cert_probe_failure - Action based on certificate probe failure. type: str choices: allow, block more...
        Supported Version Ranges
        cert_probe_failure v7.0.1 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • cert_validation_failure - Action based on certificate validation failure. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_failure v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • cert_validation_timeout - Action based on certificate validation timeout. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        cert_validation_timeout v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • client_cert_request - Action based on client certificate request. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • client_certificate - Action based on received client certificate. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • expired_server_cert - Action based on server certificate is expired. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        expired_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • inspect_all - Level of SSL inspection. type: str choices: disable, certificate-inspection, deep-inspection more...
        Supported Version Ranges
        inspect_all v6.0.0 -> latest
        [disable] v6.0.0 -> latest
        [certificate-inspection] v6.0.0 -> latest
        [deep-inspection] v6.0.0 -> latest
      • invalid_server_cert - Allow or block the invalid SSL session server certificate. type: str choices: allow, block more...
        Supported Version Ranges
        invalid_server_cert v6.2.0 -> v6.2.7
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • min_allowed_ssl_version - Minimum SSL version to be allowed. type: str choices: ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3 more...
        Supported Version Ranges
        min_allowed_ssl_version v7.0.4 -> latest
        [ssl-3.0] v6.0.0 -> latest
        [tls-1.0] v6.0.0 -> latest
        [tls-1.1] v6.0.0 -> latest
        [tls-1.2] v6.0.0 -> latest
        [tls-1.3] v6.0.0 -> latest
      • revoked_server_cert - Action based on server certificate is revoked. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        revoked_server_cert v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • sni_server_cert_check - Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. type: str choices: enable, strict, disable more...
        Supported Version Ranges
        sni_server_cert_check v6.2.0 -> latest
        [enable] v6.0.0 -> latest
        [strict] v6.0.0 -> latest
        [disable] v6.0.0 -> latest
      • unsupported_ssl - Action based on the SSL encryption used being unsupported. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        unsupported_ssl v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_cipher - Action based on the SSL cipher used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_cipher v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_negotiation - Action based on the SSL negotiation used being unsupported. type: str choices: allow, block more...
        Supported Version Ranges
        unsupported_ssl_negotiation v6.4.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • unsupported_ssl_version - Action based on the SSL version used being unsupported. type: str choices: allow, block, inspect more...
        Supported Version Ranges
        unsupported_ssl_version v7.0.1 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [inspect] v7.0.1 -> v7.0.3
      • untrusted_cert - Allow, ignore, or block the untrusted SSL session server certificate. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_cert v6.0.0 -> v6.0.11
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
      • untrusted_server_cert - Action based on server certificate is not issued by a trusted CA. type: str choices: allow, block, ignore more...
        Supported Version Ranges
        untrusted_server_cert v6.2.0 -> latest
        [allow] v6.0.0 -> latest
        [block] v6.0.0 -> latest
        [ignore] v6.0.0 -> latest
    • ssl_anomalies_log - Enable/disable logging SSL anomalies. type: str choices: disable, enable more...
      Supported Version Ranges
      ssl_anomalies_log v6.0.0 -> v7.0.1
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • ssl_anomaly_log - Enable/disable logging of SSL anomalies. type: str choices: disable, enable more...
      Supported Version Ranges
      ssl_anomaly_log v7.0.2 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • ssl_exempt - Servers to exempt from SSL inspection. type: list member_path: ssl_exempt:id more...
      Supported Version Ranges
      ssl_exempt v6.0.0 -> latest
      • address - IPv4 address object. Source firewall.address.name firewall.addrgrp.name. type: str more...
        Supported Version Ranges
        address v6.0.0 -> latest
      • address6 - IPv6 address object. Source firewall.address6.name firewall.addrgrp6.name. type: str more...
        Supported Version Ranges
        address6 v6.0.0 -> latest
      • fortiguard_category - FortiGuard category ID. type: int more...
        Supported Version Ranges
        fortiguard_category v6.0.0 -> latest
      • id - ID number. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> latest
      • regex - Exempt servers by regular expression. type: str more...
        Supported Version Ranges
        regex v6.0.0 -> latest
      • type - Type of address object (IPv4 or IPv6) or FortiGuard category. type: str choices: fortiguard-category, address, address6, wildcard-fqdn, regex more...
        Supported Version Ranges
        type v6.0.0 -> latest
        [fortiguard-category] v6.0.0 -> latest
        [address] v6.0.0 -> latest
        [address6] v6.0.0 -> latest
        [wildcard-fqdn] v6.0.0 -> latest
        [regex] v6.0.0 -> latest
      • wildcard_fqdn - Exempt servers by wildcard FQDN. Source firewall.wildcard-fqdn.custom.name firewall.wildcard-fqdn.group.name. type: str more...
        Supported Version Ranges
        wildcard_fqdn v6.0.0 -> latest
    • ssl_exemption_ip_rating - Enable/disable IP based URL rating. type: str choices: enable, disable more...
      Supported Version Ranges
      ssl_exemption_ip_rating v7.0.6 -> latest
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest
    • ssl_exemption_log - Enable/disable logging of SSL exemptions. type: str choices: disable, enable more...
      Supported Version Ranges
      ssl_exemption_log v7.0.2 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • ssl_exemptions_log - Enable/disable logging SSL exemptions. type: str choices: disable, enable more...
      Supported Version Ranges
      ssl_exemptions_log v6.0.0 -> v7.0.1
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • ssl_handshake_log - Enable/disable logging of TLS handshakes. type: str choices: disable, enable more...
      Supported Version Ranges
      ssl_handshake_log v7.0.1 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • ssl_negotiation_log - Enable/disable logging of SSL negotiation events. type: str choices: disable, enable more...
      Supported Version Ranges
      ssl_negotiation_log v6.4.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • ssl_server - SSL server settings used for client certificate request. type: list member_path: ssl_server:id more...
      Supported Version Ranges
      ssl_server v6.0.0 -> latest
      • ftps_client_cert_request - Action based on client certificate request during the FTPS handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        ftps_client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • ftps_client_certificate - Action based on received client certificate during the FTPS handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        ftps_client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • https_client_cert_request - Action based on client certificate request during the HTTPS handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        https_client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • https_client_certificate - Action based on received client certificate during the HTTPS handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        https_client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • id - SSL server ID. see Notes. type: int required: true more...
        Supported Version Ranges
        id v6.0.0 -> latest
      • imaps_client_cert_request - Action based on client certificate request during the IMAPS handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        imaps_client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • imaps_client_certificate - Action based on received client certificate during the IMAPS handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        imaps_client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • ip - IPv4 address of the SSL server. type: str more...
        Supported Version Ranges
        ip v6.0.0 -> latest
      • pop3s_client_cert_request - Action based on client certificate request during the POP3S handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        pop3s_client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • pop3s_client_certificate - Action based on received client certificate during the POP3S handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        pop3s_client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • smtps_client_cert_request - Action based on client certificate request during the SMTPS handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        smtps_client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • smtps_client_certificate - Action based on received client certificate during the SMTPS handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        smtps_client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • ssl_other_client_cert_request - Action based on client certificate request during an SSL protocol handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        ssl_other_client_cert_request v6.0.0 -> v6.2.7
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
      • ssl_other_client_certificate - Action based on received client certificate during an SSL protocol handshake. type: str choices: bypass, inspect, block more...
        Supported Version Ranges
        ssl_other_client_certificate v6.4.0 -> latest
        [bypass] v6.0.0 -> latest
        [inspect] v6.0.0 -> latest
        [block] v6.0.0 -> latest
    • ssl_server_cert_log - Enable/disable logging of server certificate information. type: str choices: disable, enable more...
      Supported Version Ranges
      ssl_server_cert_log v7.0.1 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • supported_alpn - Configure ALPN option. type: str choices: http1-1, http2, all, none more...
      Supported Version Ranges
      supported_alpn v7.0.0 -> latest
      [http1-1] v6.0.0 -> latest
      [http2] v6.0.0 -> latest
      [all] v6.0.0 -> latest
      [none] v6.0.0 -> latest
    • untrusted_caname - Untrusted CA certificate used by SSL Inspection. Source vpn.certificate.local.name. type: str more...
      Supported Version Ranges
      untrusted_caname v6.0.0 -> latest
    • use_ssl_server - Enable/disable the use of SSL server table for SSL offloading. type: str choices: disable, enable more...
      Supported Version Ranges
      use_ssl_server v6.0.0 -> latest
      [disable] v6.0.0 -> latest
      [enable] v6.0.0 -> latest
    • whitelist - Enable/disable exempting servers by FortiGuard whitelist. type: str choices: enable, disable more...
      Supported Version Ranges
      whitelist v6.0.0 -> v6.4.4
      [enable] v6.0.0 -> latest
      [disable] v6.0.0 -> latest

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- name: Configure SSL/SSH protocol options.
  fortinet.fortios.fortios_firewall_ssl_ssh_profile:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_ssl_ssh_profile:
          allowlist: "enable"
          block_blacklisted_certificates: "disable"
          block_blocklisted_certificates: "disable"
          caname: "<your_own_value> (source vpn.certificate.local.name)"
          comment: "Optional comments."
          dot:
              cert_validation_failure: "allow"
              cert_validation_timeout: "allow"
              client_certificate: "bypass"
              expired_server_cert: "allow"
              proxy_after_tcp_handshake: "enable"
              quic: "disable"
              revoked_server_cert: "allow"
              sni_server_cert_check: "enable"
              status: "disable"
              unsupported_ssl_cipher: "allow"
              unsupported_ssl_negotiation: "allow"
              unsupported_ssl_version: "allow"
              untrusted_server_cert: "allow"
          ftps:
              allow_invalid_server_cert: "enable"
              cert_validation_failure: "allow"
              cert_validation_timeout: "allow"
              client_cert_request: "bypass"
              client_certificate: "bypass"
              expired_server_cert: "allow"
              invalid_server_cert: "allow"
              min_allowed_ssl_version: "ssl-3.0"
              ports: "<your_own_value>"
              revoked_server_cert: "allow"
              sni_server_cert_check: "enable"
              status: "disable"
              unsupported_ssl: "bypass"
              unsupported_ssl_cipher: "allow"
              unsupported_ssl_negotiation: "allow"
              unsupported_ssl_version: "allow"
              untrusted_cert: "allow"
              untrusted_server_cert: "allow"
          https:
              allow_invalid_server_cert: "enable"
              cert_probe_failure: "allow"
              cert_validation_failure: "allow"
              cert_validation_timeout: "allow"
              client_cert_request: "bypass"
              client_certificate: "bypass"
              expired_server_cert: "allow"
              invalid_server_cert: "allow"
              min_allowed_ssl_version: "ssl-3.0"
              ports: "<your_own_value>"
              proxy_after_tcp_handshake: "enable"
              quic: "disable"
              revoked_server_cert: "allow"
              sni_server_cert_check: "enable"
              status: "disable"
              unsupported_ssl: "bypass"
              unsupported_ssl_cipher: "allow"
              unsupported_ssl_negotiation: "allow"
              unsupported_ssl_version: "allow"
              untrusted_cert: "allow"
              untrusted_server_cert: "allow"
          imaps:
              allow_invalid_server_cert: "enable"
              cert_validation_failure: "allow"
              cert_validation_timeout: "allow"
              client_cert_request: "bypass"
              client_certificate: "bypass"
              expired_server_cert: "allow"
              invalid_server_cert: "allow"
              ports: "<your_own_value>"
              proxy_after_tcp_handshake: "enable"
              revoked_server_cert: "allow"
              sni_server_cert_check: "enable"
              status: "disable"
              unsupported_ssl: "bypass"
              unsupported_ssl_cipher: "allow"
              unsupported_ssl_negotiation: "allow"
              unsupported_ssl_version: "allow"
              untrusted_cert: "allow"
              untrusted_server_cert: "allow"
          mapi_over_https: "enable"
          name: "default_name_83"
          pop3s:
              allow_invalid_server_cert: "enable"
              cert_validation_failure: "allow"
              cert_validation_timeout: "allow"
              client_cert_request: "bypass"
              client_certificate: "bypass"
              expired_server_cert: "allow"
              invalid_server_cert: "allow"
              ports: "<your_own_value>"
              proxy_after_tcp_handshake: "enable"
              revoked_server_cert: "allow"
              sni_server_cert_check: "enable"
              status: "disable"
              unsupported_ssl: "bypass"
              unsupported_ssl_cipher: "allow"
              unsupported_ssl_negotiation: "allow"
              unsupported_ssl_version: "allow"
              untrusted_cert: "allow"
              untrusted_server_cert: "allow"
          rpc_over_https: "enable"
          server_cert:
              -
                  name: "default_name_105 (source vpn.certificate.local.name)"
          server_cert_mode: "re-sign"
          smtps:
              allow_invalid_server_cert: "enable"
              cert_validation_failure: "allow"
              cert_validation_timeout: "allow"
              client_cert_request: "bypass"
              client_certificate: "bypass"
              expired_server_cert: "allow"
              invalid_server_cert: "allow"
              ports: "<your_own_value>"
              proxy_after_tcp_handshake: "enable"
              revoked_server_cert: "allow"
              sni_server_cert_check: "enable"
              status: "disable"
              unsupported_ssl: "bypass"
              unsupported_ssl_cipher: "allow"
              unsupported_ssl_negotiation: "allow"
              unsupported_ssl_version: "allow"
              untrusted_cert: "allow"
              untrusted_server_cert: "allow"
          ssh:
              inspect_all: "disable"
              ports: "<your_own_value>"
              proxy_after_tcp_handshake: "enable"
              ssh_algorithm: "compatible"
              ssh_policy_check: "disable"
              ssh_tun_policy_check: "disable"
              status: "disable"
              unsupported_version: "bypass"
          ssl:
              allow_invalid_server_cert: "enable"
              cert_probe_failure: "allow"
              cert_validation_failure: "allow"
              cert_validation_timeout: "allow"
              client_cert_request: "bypass"
              client_certificate: "bypass"
              expired_server_cert: "allow"
              inspect_all: "disable"
              invalid_server_cert: "allow"
              min_allowed_ssl_version: "ssl-3.0"
              revoked_server_cert: "allow"
              sni_server_cert_check: "enable"
              unsupported_ssl: "bypass"
              unsupported_ssl_cipher: "allow"
              unsupported_ssl_negotiation: "allow"
              unsupported_ssl_version: "allow"
              untrusted_cert: "allow"
              untrusted_server_cert: "allow"
          ssl_anomalies_log: "disable"
          ssl_anomaly_log: "disable"
          ssl_exempt:
              -
                  address: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
                  address6: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
                  fortiguard_category: "0"
                  id: "160"
                  regex: "<your_own_value>"
                  type: "fortiguard-category"
                  wildcard_fqdn: "<your_own_value> (source firewall.wildcard-fqdn.custom.name firewall.wildcard-fqdn.group.name)"
          ssl_exemption_ip_rating: "enable"
          ssl_exemption_log: "disable"
          ssl_exemptions_log: "disable"
          ssl_handshake_log: "disable"
          ssl_negotiation_log: "disable"
          ssl_server:
              -
                  ftps_client_cert_request: "bypass"
                  ftps_client_certificate: "bypass"
                  https_client_cert_request: "bypass"
                  https_client_certificate: "bypass"
                  id: "174"
                  imaps_client_cert_request: "bypass"
                  imaps_client_certificate: "bypass"
                  ip: "<your_own_value>"
                  pop3s_client_cert_request: "bypass"
                  pop3s_client_certificate: "bypass"
                  smtps_client_cert_request: "bypass"
                  smtps_client_certificate: "bypass"
                  ssl_other_client_cert_request: "bypass"
                  ssl_other_client_certificate: "bypass"
          ssl_server_cert_log: "disable"
          supported_alpn: "http1-1"
          untrusted_caname: "<your_own_value> (source vpn.certificate.local.name)"
          use_ssl_server: "disable"
          whitelist: "enable"

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:

  • build - Build number of the fortigate image returned: always type: str sample: 1547
  • http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
  • http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
  • mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
  • name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
  • path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
  • revision - Internal revision number returned: always type: str sample: 17.0.2.10658
  • serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
  • status - Indication of the operation's result returned: always type: str sample: success
  • vdom - Virtual domain used returned: always type: str sample: root
  • version - Version of the FortiGate returned: always type: str sample: v5.6.3
  • This module is not guaranteed to have a backwards compatible interface.
  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.