fmgd_firewall_sslsshprofile – Configure SSL/SSH 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_sslsshprofile - Configure SSL/SSH protocol options. type: dict
    • allowlist Enable/disable exempting servers by fortiguard allowlist. type: str choices: [disable, enable] more...
    • block_blocklisted_certificates (Alias name: block-blocklisted-certificates) Enable/disable blocking ssl-based botnet communication by fortiguard certificate blocklist. type: str choices: [disable, enable] more...
    • caname Ca certificate used by ssl inspection. type: list more...
    • comment Optional comments. type: str more...
    • dot Dot. type: dict more...
      • cert_validation_failure (Alias name: cert-validation-failure) Action based on certificate validation failure. type: str choices: [allow, block, ignore] more...
      • cert_validation_timeout (Alias name: cert-validation-timeout) Action based on certificate validation timeout. type: str choices: [allow, block, ignore] more...
      • client_certificate (Alias name: client-certificate) Action based on received client certificate. type: str choices: [bypass, inspect, block, bypass-on-cert-req] more...
      • expired_server_cert (Alias name: expired-server-cert) Action based on server certificate is expired. type: str choices: [allow, block, ignore] 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...
      • quic Quic inspection status (default = inspect). type: str choices: [bypass, block, inspect] more...
      • revoked_server_cert (Alias name: revoked-server-cert) Action based on server certificate is revoked. type: str choices: [allow, block, ignore] more...
      • sni_server_cert_check (Alias name: 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...
      • status Configure protocol inspection status. type: str choices: [disable, deep-inspection] more...
      • unsupported_ssl_cipher (Alias name: unsupported-ssl-cipher) Action based on the ssl cipher used being unsupported. type: str choices: [block, allow] more...
      • unsupported_ssl_negotiation (Alias name: unsupported-ssl-negotiation) Action based on the ssl negotiation used being unsupported. type: str choices: [block, allow] more...
      • unsupported_ssl_version (Alias name: unsupported-ssl-version) Action based on the ssl version used being unsupported. type: str choices: [block, allow, inspect] more...
      • untrusted_server_cert (Alias name: untrusted-server-cert) Action based on server certificate is not issued by a trusted ca. type: str choices: [allow, block, ignore] more...
      • min_allowed_ssl_version (Alias name: min-allowed-ssl-version) Min allowed ssl version. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • udp_not_quic (Alias name: udp-not-quic) Action to be taken when matched udp packet is not quic. type: str choices: [block, allow] more...
    • ech_outer_sni (Alias name: ech-outer-sni) Ech outer sni. type: list more...
      • name Clienthelloouter sni name. type: str more...
      • sni Clienthelloouter sni to be blocked. type: str more...
    • ftps Ftps. type: dict more...
      • cert_validation_failure (Alias name: cert-validation-failure) Action based on certificate validation failure. type: str choices: [allow, block, ignore] more...
      • cert_validation_timeout (Alias name: cert-validation-timeout) Action based on certificate validation timeout. type: str choices: [allow, block, ignore] more...
      • client_certificate (Alias name: client-certificate) Action based on received client certificate. type: str choices: [bypass, inspect, block, bypass-on-cert-req] more...
      • expired_server_cert (Alias name: expired-server-cert) Action based on server certificate is expired. type: str choices: [allow, block, ignore] more...
      • min_allowed_ssl_version (Alias name: 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...
      • ports Ports to use for scanning (1 - 65535, default = 443). type: list more...
      • revoked_server_cert (Alias name: revoked-server-cert) Action based on server certificate is revoked. type: str choices: [allow, block, ignore] more...
      • sni_server_cert_check (Alias name: 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: [disable, enable, strict] more...
      • status Configure protocol inspection status. type: str choices: [disable, deep-inspection] more...
      • unsupported_ssl_cipher (Alias name: unsupported-ssl-cipher) Action based on the ssl cipher used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_negotiation (Alias name: unsupported-ssl-negotiation) Action based on the ssl negotiation used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_version (Alias name: unsupported-ssl-version) Action based on the ssl version used being unsupported. type: str choices: [block, allow, inspect] more...
      • untrusted_server_cert (Alias name: untrusted-server-cert) Action based on server certificate is not issued by a trusted ca. type: str choices: [allow, block, ignore] more...
      • client_cert_request (Alias name: client-cert-request) Action based on client certificate request. type: str choices: [bypass, inspect, block] more...
      • invalid_server_cert (Alias name: invalid-server-cert) Allow or block the invalid ssl session server certificate. type: str choices: [allow, block] more...
      • unsupported_ssl (Alias name: unsupported-ssl) Action based on the ssl encryption used being unsupported. type: str choices: [bypass, inspect, block] more...
      • untrusted_cert (Alias name: untrusted-cert) Allow, ignore, or block the untrusted ssl session server certificate. type: str choices: [allow, block, ignore] more...
      • allow_invalid_server_cert (Alias name: allow-invalid-server-cert) When enabled, allows ssl sessions whose server certificate validation failed. type: str choices: [disable, enable] more...
    • https Https. type: dict more...
      • cert_probe_failure (Alias name: cert-probe-failure) Action based on certificate probe failure. type: str choices: [block, allow] more...
      • cert_validation_failure (Alias name: cert-validation-failure) Action based on certificate validation failure. type: str choices: [allow, block, ignore] more...
      • cert_validation_timeout (Alias name: cert-validation-timeout) Action based on certificate validation timeout. type: str choices: [allow, block, ignore] more...
      • client_certificate (Alias name: client-certificate) Action based on received client certificate. type: str choices: [bypass, inspect, block, bypass-on-cert-req] more...
      • encrypted_client_hello (Alias name: encrypted-client-hello) Block/allow session based on existence of encrypted-client-hello. type: str choices: [block, allow] more...
      • expired_server_cert (Alias name: expired-server-cert) Action based on server certificate is expired. type: str choices: [allow, block, ignore] more...
      • min_allowed_ssl_version (Alias name: 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...
      • ports Ports to use for scanning (1 - 65535, default = 443). type: list more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • quic Quic inspection status (default = inspect). type: str choices: [bypass, block, inspect] more...
      • revoked_server_cert (Alias name: revoked-server-cert) Action based on server certificate is revoked. type: str choices: [allow, block, ignore] more...
      • sni_server_cert_check (Alias name: 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: [disable, enable, strict] more...
      • status Configure protocol inspection status. type: str choices: [disable, certificate-inspection, deep-inspection] more...
      • unsupported_ssl_cipher (Alias name: unsupported-ssl-cipher) Action based on the ssl cipher used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_negotiation (Alias name: unsupported-ssl-negotiation) Action based on the ssl negotiation used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_version (Alias name: unsupported-ssl-version) Action based on the ssl version used being unsupported. type: str choices: [block, allow, inspect] more...
      • untrusted_server_cert (Alias name: untrusted-server-cert) Action based on server certificate is not issued by a trusted ca. type: str choices: [allow, block, ignore] more...
      • client_cert_request (Alias name: client-cert-request) Action based on client certificate request. type: str choices: [bypass, inspect, block] more...
      • invalid_server_cert (Alias name: invalid-server-cert) Allow or block the invalid ssl session server certificate. type: str choices: [allow, block] more...
      • unsupported_ssl (Alias name: unsupported-ssl) Action based on the ssl encryption used being unsupported. type: str choices: [bypass, inspect, block] more...
      • untrusted_cert (Alias name: untrusted-cert) Allow, ignore, or block the untrusted ssl session server certificate. type: str choices: [allow, block, ignore] more...
      • allow_invalid_server_cert (Alias name: allow-invalid-server-cert) When enabled, allows ssl sessions whose server certificate validation failed. type: str choices: [disable, enable] more...
      • udp_not_quic (Alias name: udp-not-quic) Action to be taken when matched udp packet is not quic. type: str choices: [block, allow] more...
    • imaps Imaps. type: dict more...
      • cert_validation_failure (Alias name: cert-validation-failure) Action based on certificate validation failure. type: str choices: [allow, block, ignore] more...
      • cert_validation_timeout (Alias name: cert-validation-timeout) Action based on certificate validation timeout. type: str choices: [allow, block, ignore] more...
      • client_certificate (Alias name: client-certificate) Action based on received client certificate. type: str choices: [bypass, inspect, block, bypass-on-cert-req] more...
      • expired_server_cert (Alias name: expired-server-cert) Action based on server certificate is expired. type: str choices: [allow, block, ignore] more...
      • ports Ports to use for scanning (1 - 65535, default = 443). type: list more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • revoked_server_cert (Alias name: revoked-server-cert) Action based on server certificate is revoked. type: str choices: [allow, block, ignore] more...
      • sni_server_cert_check (Alias name: 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: [disable, enable, strict] more...
      • status Configure protocol inspection status. type: str choices: [disable, deep-inspection] more...
      • unsupported_ssl_cipher (Alias name: unsupported-ssl-cipher) Action based on the ssl cipher used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_negotiation (Alias name: unsupported-ssl-negotiation) Action based on the ssl negotiation used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_version (Alias name: unsupported-ssl-version) Action based on the ssl version used being unsupported. type: str choices: [block, allow, inspect] more...
      • untrusted_server_cert (Alias name: untrusted-server-cert) Action based on server certificate is not issued by a trusted ca. type: str choices: [allow, block, ignore] more...
      • min_allowed_ssl_version (Alias name: min-allowed-ssl-version) Min allowed ssl version. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • client_cert_request (Alias name: client-cert-request) Action based on client certificate request. type: str choices: [bypass, inspect, block] more...
      • invalid_server_cert (Alias name: invalid-server-cert) Allow or block the invalid ssl session server certificate. type: str choices: [allow, block] more...
      • unsupported_ssl (Alias name: unsupported-ssl) Action based on the ssl encryption used being unsupported. type: str choices: [bypass, inspect, block] more...
      • untrusted_cert (Alias name: untrusted-cert) Allow, ignore, or block the untrusted ssl session server certificate. type: str choices: [allow, block, ignore] more...
      • allow_invalid_server_cert (Alias name: allow-invalid-server-cert) When enabled, allows ssl sessions whose server certificate validation failed. type: str choices: [disable, enable] more...
    • mapi_over_https (Alias name: mapi-over-https) Enable/disable inspection of mapi over https. type: str choices: [disable, enable] more...
    • name Name. type: str more...
    • pop3s Pop3s. type: dict more...
      • cert_validation_failure (Alias name: cert-validation-failure) Action based on certificate validation failure. type: str choices: [allow, block, ignore] more...
      • cert_validation_timeout (Alias name: cert-validation-timeout) Action based on certificate validation timeout. type: str choices: [allow, block, ignore] more...
      • client_certificate (Alias name: client-certificate) Action based on received client certificate. type: str choices: [bypass, inspect, block, bypass-on-cert-req] more...
      • expired_server_cert (Alias name: expired-server-cert) Action based on server certificate is expired. type: str choices: [allow, block, ignore] more...
      • ports Ports to use for scanning (1 - 65535, default = 443). type: list more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • revoked_server_cert (Alias name: revoked-server-cert) Action based on server certificate is revoked. type: str choices: [allow, block, ignore] more...
      • sni_server_cert_check (Alias name: 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: [disable, enable, strict] more...
      • status Configure protocol inspection status. type: str choices: [disable, deep-inspection] more...
      • unsupported_ssl_cipher (Alias name: unsupported-ssl-cipher) Action based on the ssl cipher used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_negotiation (Alias name: unsupported-ssl-negotiation) Action based on the ssl negotiation used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_version (Alias name: unsupported-ssl-version) Action based on the ssl version used being unsupported. type: str choices: [block, allow, inspect] more...
      • untrusted_server_cert (Alias name: untrusted-server-cert) Action based on server certificate is not issued by a trusted ca. type: str choices: [allow, block, ignore] more...
      • min_allowed_ssl_version (Alias name: min-allowed-ssl-version) Min allowed ssl version. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • client_cert_request (Alias name: client-cert-request) Action based on client certificate request. type: str choices: [bypass, inspect, block] more...
      • invalid_server_cert (Alias name: invalid-server-cert) Allow or block the invalid ssl session server certificate. type: str choices: [allow, block] more...
      • unsupported_ssl (Alias name: unsupported-ssl) Action based on the ssl encryption used being unsupported. type: str choices: [bypass, inspect, block] more...
      • untrusted_cert (Alias name: untrusted-cert) Allow, ignore, or block the untrusted ssl session server certificate. type: str choices: [allow, block, ignore] more...
      • allow_invalid_server_cert (Alias name: allow-invalid-server-cert) When enabled, allows ssl sessions whose server certificate validation failed. type: str choices: [disable, enable] more...
    • rpc_over_https (Alias name: rpc-over-https) Enable/disable inspection of rpc over https. type: str choices: [disable, enable] more...
    • server_cert (Alias name: server-cert) Certificate used by ssl inspection to replace server certificate. type: list more...
    • server_cert_mode (Alias name: server-cert-mode) Re-sign or replace the servers certificate. type: str choices: [re-sign, replace] more...
    • smtps Smtps. type: dict more...
      • cert_validation_failure (Alias name: cert-validation-failure) Action based on certificate validation failure. type: str choices: [allow, block, ignore] more...
      • cert_validation_timeout (Alias name: cert-validation-timeout) Action based on certificate validation timeout. type: str choices: [allow, block, ignore] more...
      • client_certificate (Alias name: client-certificate) Action based on received client certificate. type: str choices: [bypass, inspect, block, bypass-on-cert-req] more...
      • expired_server_cert (Alias name: expired-server-cert) Action based on server certificate is expired. type: str choices: [allow, block, ignore] more...
      • ports Ports to use for scanning (1 - 65535, default = 443). type: list more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • revoked_server_cert (Alias name: revoked-server-cert) Action based on server certificate is revoked. type: str choices: [allow, block, ignore] more...
      • sni_server_cert_check (Alias name: 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: [disable, enable, strict] more...
      • status Configure protocol inspection status. type: str choices: [disable, deep-inspection] more...
      • unsupported_ssl_cipher (Alias name: unsupported-ssl-cipher) Action based on the ssl cipher used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_negotiation (Alias name: unsupported-ssl-negotiation) Action based on the ssl negotiation used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_version (Alias name: unsupported-ssl-version) Action based on the ssl version used being unsupported. type: str choices: [block, allow, inspect] more...
      • untrusted_server_cert (Alias name: untrusted-server-cert) Action based on server certificate is not issued by a trusted ca. type: str choices: [allow, block, ignore] more...
      • min_allowed_ssl_version (Alias name: min-allowed-ssl-version) Min allowed ssl version. type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3] more...
      • client_cert_request (Alias name: client-cert-request) Action based on client certificate request. type: str choices: [bypass, inspect, block] more...
      • invalid_server_cert (Alias name: invalid-server-cert) Allow or block the invalid ssl session server certificate. type: str choices: [allow, block] more...
      • unsupported_ssl (Alias name: unsupported-ssl) Action based on the ssl encryption used being unsupported. type: str choices: [bypass, inspect, block] more...
      • untrusted_cert (Alias name: untrusted-cert) Allow, ignore, or block the untrusted ssl session server certificate. type: str choices: [allow, block, ignore] more...
      • allow_invalid_server_cert (Alias name: allow-invalid-server-cert) When enabled, allows ssl sessions whose server certificate validation failed. type: str choices: [disable, enable] more...
    • ssh Ssh. type: dict more...
      • ports Ports to use for scanning (1 - 65535, default = 443). type: list more...
      • proxy_after_tcp_handshake (Alias name: proxy-after-tcp-handshake) Proxy traffic after the tcp 3-way handshake has been established (not before). type: str choices: [disable, enable] more...
      • ssh_algorithm (Alias name: ssh-algorithm) Relative strength of encryption algorithms accepted during negotiation. type: str choices: [compatible, high-encryption] more...
      • ssh_tun_policy_check (Alias name: ssh-tun-policy-check) Enable/disable ssh tunnel policy check. type: str choices: [disable, enable] more...
      • status Configure protocol inspection status. type: str choices: [disable, deep-inspection] more...
      • unsupported_version (Alias name: unsupported-version) Action based on ssh version being unsupported. type: str choices: [block, bypass] more...
      • inspect_all (Alias name: inspect-all) Level of ssl inspection. type: str choices: [disable, deep-inspection] more...
    • ssl Ssl. type: dict more...
      • cert_probe_failure (Alias name: cert-probe-failure) Action based on certificate probe failure. type: str choices: [block, allow] more...
      • cert_validation_failure (Alias name: cert-validation-failure) Action based on certificate validation failure. type: str choices: [allow, block, ignore] more...
      • cert_validation_timeout (Alias name: cert-validation-timeout) Action based on certificate validation timeout. type: str choices: [allow, block, ignore] more...
      • client_certificate (Alias name: client-certificate) Action based on received client certificate. type: str choices: [bypass, inspect, block, bypass-on-cert-req] more...
      • encrypted_client_hello (Alias name: encrypted-client-hello) Block/allow session based on existence of encrypted-client-hello. type: str choices: [block, allow] more...
      • expired_server_cert (Alias name: expired-server-cert) Action based on server certificate is expired. type: str choices: [allow, block, ignore] more...
      • inspect_all (Alias name: inspect-all) Level of ssl inspection. type: str choices: [disable, certificate-inspection, deep-inspection] more...
      • min_allowed_ssl_version (Alias name: 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...
      • revoked_server_cert (Alias name: revoked-server-cert) Action based on server certificate is revoked. type: str choices: [allow, block, ignore] more...
      • sni_server_cert_check (Alias name: 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: [disable, enable, strict] more...
      • unsupported_ssl_cipher (Alias name: unsupported-ssl-cipher) Action based on the ssl cipher used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_negotiation (Alias name: unsupported-ssl-negotiation) Action based on the ssl negotiation used being unsupported. type: str choices: [allow, block] more...
      • unsupported_ssl_version (Alias name: unsupported-ssl-version) Action based on the ssl version used being unsupported. type: str choices: [block, allow, inspect] more...
      • untrusted_server_cert (Alias name: untrusted-server-cert) Action based on server certificate is not issued by a trusted ca. type: str choices: [allow, block, ignore] more...
      • client_cert_request (Alias name: client-cert-request) Action based on client certificate request. type: str choices: [bypass, inspect, block] more...
      • invalid_server_cert (Alias name: invalid-server-cert) Allow or block the invalid ssl session server certificate. type: str choices: [allow, block] more...
      • unsupported_ssl (Alias name: unsupported-ssl) Action based on the ssl encryption used being unsupported. type: str choices: [bypass, inspect, block] more...
      • untrusted_cert (Alias name: untrusted-cert) Allow, ignore, or block the untrusted ssl session server certificate. type: str choices: [allow, block, ignore] more...
      • allow_invalid_server_cert (Alias name: allow-invalid-server-cert) When enabled, allows ssl sessions whose server certificate validation failed. type: str choices: [disable, enable] more...
    • ssl_anomaly_log (Alias name: ssl-anomaly-log) Enable/disable logging of ssl anomalies. type: str choices: [disable, enable] more...
    • ssl_client_certificate (Alias name: ssl-client-certificate) Ssl client certificate. type: dict more...
      • caname Caname. type: list more...
      • cert Cert. type: list more...
      • keyring_list (Alias name: keyring-list) Keyring list. type: list more...
      • status Status. type: str choices: [do-not-offer, keyring-list, ca-sign, static] more...
    • ssl_exempt (Alias name: ssl-exempt) Ssl exempt. type: list more...
      • address Ipv4 address object. type: list more...
      • address6 Ipv6 address object. type: list more...
      • finger_print_category (Alias name: finger-print-category) Finger print platform. type: str choices: [unknown, firefox, chrome, safari, edge, ie, android, ios, windows] more...
      • fortiguard_category (Alias name: fortiguard-category) Fortiguard category id. type: list more...
      • id Id number. type: int more...
      • regex Exempt servers by regular expression. type: str more...
      • type Type of address object (ipv4 or ipv6) or fortiguard category. type: str choices: [fortiguard-category, address, address6, wildcard-fqdn, regex, finger-print] more...
      • wildcard_fqdn (Alias name: wildcard-fqdn) Exempt servers by wildcard fqdn. type: list more...
    • ssl_exemption_ip_rating (Alias name: ssl-exemption-ip-rating) Enable/disable ip based url rating. type: str choices: [disable, enable] more...
    • ssl_exemption_log (Alias name: ssl-exemption-log) Enable/disable logging of ssl exemptions. type: str choices: [disable, enable] more...
    • ssl_handshake_log (Alias name: ssl-handshake-log) Enable/disable logging of tls handshakes. type: str choices: [disable, enable] more...
    • ssl_negotiation_log (Alias name: ssl-negotiation-log) Enable/disable logging of ssl negotiation events. type: str choices: [disable, enable] more...
    • ssl_server (Alias name: ssl-server) Ssl server. type: list more...
      • ftps_client_certificate (Alias name: ftps-client-certificate) Action based on received client certificate during the ftps handshake. type: str choices: [bypass, inspect, block] more...
      • https_client_certificate (Alias name: https-client-certificate) Action based on received client certificate during the https handshake. type: str choices: [bypass, inspect, block] more...
      • id Ssl server id. type: int more...
      • imaps_client_certificate (Alias name: imaps-client-certificate) Action based on received client certificate during the imaps handshake. type: str choices: [bypass, inspect, block] more...
      • ip Ipv4 address of the ssl server. type: str more...
      • pop3s_client_certificate (Alias name: pop3s-client-certificate) Action based on received client certificate during the pop3s handshake. type: str choices: [bypass, inspect, block] more...
      • smtps_client_certificate (Alias name: smtps-client-certificate) Action based on received client certificate during the smtps handshake. type: str choices: [bypass, inspect, block] more...
      • ssl_other_client_certificate (Alias name: ssl-other-client-certificate) Action based on received client certificate during an ssl protocol handshake. type: str choices: [bypass, inspect, block] more...
      • smtps_client_cert_request (Alias name: smtps-client-cert-request) Action based on client certificate request during the smtps handshake. type: str choices: [bypass, inspect, block] more...
      • imaps_client_cert_request (Alias name: imaps-client-cert-request) Action based on client certificate request during the imaps handshake. type: str choices: [bypass, inspect, block] more...
      • ssl_other_client_cert_request (Alias name: ssl-other-client-cert-request) Action based on client certificate request during an ssl protocol handshake. type: str choices: [bypass, inspect, block] more...
      • ftps_client_cert_request (Alias name: ftps-client-cert-request) Action based on client certificate request during the ftps handshake. type: str choices: [bypass, inspect, block] more...
      • https_client_cert_request (Alias name: https-client-cert-request) Action based on client certificate request during the https handshake. type: str choices: [bypass, inspect, block] more...
      • pop3s_client_cert_request (Alias name: pop3s-client-cert-request) Action based on client certificate request during the pop3s handshake. type: str choices: [bypass, inspect, block] more...
    • ssl_server_cert_log (Alias name: ssl-server-cert-log) Enable/disable logging of server certificate information. type: str choices: [disable, enable] more...
    • supported_alpn (Alias name: supported-alpn) Configure alpn option. type: str choices: [none, http1-1, http2, all] more...
    • untrusted_caname (Alias name: untrusted-caname) Untrusted ca certificate used by ssl inspection. type: list more...
    • use_ssl_server (Alias name: use-ssl-server) Enable/disable the use of ssl server table for ssl offloading. type: str choices: [disable, enable] more...
    • ssl_exemptions_log (Alias name: ssl-exemptions-log) Enable/disable logging ssl exemptions. type: str choices: [disable, enable] more...
    • ssl_anomalies_log (Alias name: ssl-anomalies-log) Enable/disable logging ssl anomalies. type: str choices: [disable, enable] more...
    • whitelist Enable/disable exempting servers by fortiguard whitelist. type: str choices: [disable, enable] more...
    • block_blacklisted_certificates (Alias name: block-blacklisted-certificates) Enable/disable blocking ssl-based botnet communication by fortiguard certificate blacklist. 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 SSL/SSH protocol options.
      fortinet.fmgdevice.fmgd_firewall_sslsshprofile:
        # 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_sslsshprofile:
          name: "your value" # Required variable, string
          # allowlist: <value in [disable, enable]>
          # block_blocklisted_certificates: <value in [disable, enable]>
          # caname: <list or string>
          # comment: <string>
          # dot:
          #   cert_validation_failure: <value in [allow, block, ignore]>
          #   cert_validation_timeout: <value in [allow, block, ignore]>
          #   client_certificate: <value in [bypass, inspect, block, ...]>
          #   expired_server_cert: <value in [allow, block, ignore]>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   quic: <value in [bypass, block, inspect]>
          #   revoked_server_cert: <value in [allow, block, ignore]>
          #   sni_server_cert_check: <value in [enable, strict, disable]>
          #   status: <value in [disable, deep-inspection]>
          #   unsupported_ssl_cipher: <value in [block, allow]>
          #   unsupported_ssl_negotiation: <value in [block, allow]>
          #   unsupported_ssl_version: <value in [block, allow, inspect]>
          #   untrusted_server_cert: <value in [allow, block, ignore]>
          #   min_allowed_ssl_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          #   udp_not_quic: <value in [block, allow]>
          # ech_outer_sni:
          #   - name: <string>
          #     sni: <string>
          # ftps:
          #   cert_validation_failure: <value in [allow, block, ignore]>
          #   cert_validation_timeout: <value in [allow, block, ignore]>
          #   client_certificate: <value in [bypass, inspect, block, ...]>
          #   expired_server_cert: <value in [allow, block, ignore]>
          #   min_allowed_ssl_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          #   ports: <list or integer>
          #   revoked_server_cert: <value in [allow, block, ignore]>
          #   sni_server_cert_check: <value in [disable, enable, strict]>
          #   status: <value in [disable, deep-inspection]>
          #   unsupported_ssl_cipher: <value in [allow, block]>
          #   unsupported_ssl_negotiation: <value in [allow, block]>
          #   unsupported_ssl_version: <value in [block, allow, inspect]>
          #   untrusted_server_cert: <value in [allow, block, ignore]>
          #   client_cert_request: <value in [bypass, inspect, block]>
          #   invalid_server_cert: <value in [allow, block]>
          #   unsupported_ssl: <value in [bypass, inspect, block]>
          #   untrusted_cert: <value in [allow, block, ignore]>
          #   allow_invalid_server_cert: <value in [disable, enable]>
          # https:
          #   cert_probe_failure: <value in [block, allow]>
          #   cert_validation_failure: <value in [allow, block, ignore]>
          #   cert_validation_timeout: <value in [allow, block, ignore]>
          #   client_certificate: <value in [bypass, inspect, block, ...]>
          #   encrypted_client_hello: <value in [block, allow]>
          #   expired_server_cert: <value in [allow, block, ignore]>
          #   min_allowed_ssl_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          #   ports: <list or integer>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   quic: <value in [bypass, block, inspect]>
          #   revoked_server_cert: <value in [allow, block, ignore]>
          #   sni_server_cert_check: <value in [disable, enable, strict]>
          #   status: <value in [disable, certificate-inspection, deep-inspection]>
          #   unsupported_ssl_cipher: <value in [allow, block]>
          #   unsupported_ssl_negotiation: <value in [allow, block]>
          #   unsupported_ssl_version: <value in [block, allow, inspect]>
          #   untrusted_server_cert: <value in [allow, block, ignore]>
          #   client_cert_request: <value in [bypass, inspect, block]>
          #   invalid_server_cert: <value in [allow, block]>
          #   unsupported_ssl: <value in [bypass, inspect, block]>
          #   untrusted_cert: <value in [allow, block, ignore]>
          #   allow_invalid_server_cert: <value in [disable, enable]>
          #   udp_not_quic: <value in [block, allow]>
          # imaps:
          #   cert_validation_failure: <value in [allow, block, ignore]>
          #   cert_validation_timeout: <value in [allow, block, ignore]>
          #   client_certificate: <value in [bypass, inspect, block, ...]>
          #   expired_server_cert: <value in [allow, block, ignore]>
          #   ports: <list or integer>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   revoked_server_cert: <value in [allow, block, ignore]>
          #   sni_server_cert_check: <value in [disable, enable, strict]>
          #   status: <value in [disable, deep-inspection]>
          #   unsupported_ssl_cipher: <value in [allow, block]>
          #   unsupported_ssl_negotiation: <value in [allow, block]>
          #   unsupported_ssl_version: <value in [block, allow, inspect]>
          #   untrusted_server_cert: <value in [allow, block, ignore]>
          #   min_allowed_ssl_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          #   client_cert_request: <value in [bypass, inspect, block]>
          #   invalid_server_cert: <value in [allow, block]>
          #   unsupported_ssl: <value in [bypass, inspect, block]>
          #   untrusted_cert: <value in [allow, block, ignore]>
          #   allow_invalid_server_cert: <value in [disable, enable]>
          # mapi_over_https: <value in [disable, enable]>
          # pop3s:
          #   cert_validation_failure: <value in [allow, block, ignore]>
          #   cert_validation_timeout: <value in [allow, block, ignore]>
          #   client_certificate: <value in [bypass, inspect, block, ...]>
          #   expired_server_cert: <value in [allow, block, ignore]>
          #   ports: <list or integer>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   revoked_server_cert: <value in [allow, block, ignore]>
          #   sni_server_cert_check: <value in [disable, enable, strict]>
          #   status: <value in [disable, deep-inspection]>
          #   unsupported_ssl_cipher: <value in [allow, block]>
          #   unsupported_ssl_negotiation: <value in [allow, block]>
          #   unsupported_ssl_version: <value in [block, allow, inspect]>
          #   untrusted_server_cert: <value in [allow, block, ignore]>
          #   min_allowed_ssl_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          #   client_cert_request: <value in [bypass, inspect, block]>
          #   invalid_server_cert: <value in [allow, block]>
          #   unsupported_ssl: <value in [bypass, inspect, block]>
          #   untrusted_cert: <value in [allow, block, ignore]>
          #   allow_invalid_server_cert: <value in [disable, enable]>
          # rpc_over_https: <value in [disable, enable]>
          # server_cert: <list or string>
          # server_cert_mode: <value in [re-sign, replace]>
          # smtps:
          #   cert_validation_failure: <value in [allow, block, ignore]>
          #   cert_validation_timeout: <value in [allow, block, ignore]>
          #   client_certificate: <value in [bypass, inspect, block, ...]>
          #   expired_server_cert: <value in [allow, block, ignore]>
          #   ports: <list or integer>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   revoked_server_cert: <value in [allow, block, ignore]>
          #   sni_server_cert_check: <value in [disable, enable, strict]>
          #   status: <value in [disable, deep-inspection]>
          #   unsupported_ssl_cipher: <value in [allow, block]>
          #   unsupported_ssl_negotiation: <value in [allow, block]>
          #   unsupported_ssl_version: <value in [block, allow, inspect]>
          #   untrusted_server_cert: <value in [allow, block, ignore]>
          #   min_allowed_ssl_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          #   client_cert_request: <value in [bypass, inspect, block]>
          #   invalid_server_cert: <value in [allow, block]>
          #   unsupported_ssl: <value in [bypass, inspect, block]>
          #   untrusted_cert: <value in [allow, block, ignore]>
          #   allow_invalid_server_cert: <value in [disable, enable]>
          # ssh:
          #   ports: <list or integer>
          #   proxy_after_tcp_handshake: <value in [disable, enable]>
          #   ssh_algorithm: <value in [compatible, high-encryption]>
          #   ssh_tun_policy_check: <value in [disable, enable]>
          #   status: <value in [disable, deep-inspection]>
          #   unsupported_version: <value in [block, bypass]>
          #   inspect_all: <value in [disable, deep-inspection]>
          # ssl:
          #   cert_probe_failure: <value in [block, allow]>
          #   cert_validation_failure: <value in [allow, block, ignore]>
          #   cert_validation_timeout: <value in [allow, block, ignore]>
          #   client_certificate: <value in [bypass, inspect, block, ...]>
          #   encrypted_client_hello: <value in [block, allow]>
          #   expired_server_cert: <value in [allow, block, ignore]>
          #   inspect_all: <value in [disable, certificate-inspection, deep-inspection]>
          #   min_allowed_ssl_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
          #   revoked_server_cert: <value in [allow, block, ignore]>
          #   sni_server_cert_check: <value in [disable, enable, strict]>
          #   unsupported_ssl_cipher: <value in [allow, block]>
          #   unsupported_ssl_negotiation: <value in [allow, block]>
          #   unsupported_ssl_version: <value in [block, allow, inspect]>
          #   untrusted_server_cert: <value in [allow, block, ignore]>
          #   client_cert_request: <value in [bypass, inspect, block]>
          #   invalid_server_cert: <value in [allow, block]>
          #   unsupported_ssl: <value in [bypass, inspect, block]>
          #   untrusted_cert: <value in [allow, block, ignore]>
          #   allow_invalid_server_cert: <value in [disable, enable]>
          # ssl_anomaly_log: <value in [disable, enable]>
          # ssl_client_certificate:
          #   caname: <list or string>
          #   cert: <list or string>
          #   keyring_list: <list or string>
          #   status: <value in [do-not-offer, keyring-list, ca-sign, ...]>
          # ssl_exempt:
          #   - address: <list or string>
          #     address6: <list or string>
          #     finger_print_category: <value in [unknown, firefox, chrome, ...]>
          #     fortiguard_category: <list or string>
          #     id: <integer>
          #     regex: <string>
          #     type: <value in [fortiguard-category, address, address6, ...]>
          #     wildcard_fqdn: <list or string>
          # ssl_exemption_ip_rating: <value in [disable, enable]>
          # ssl_exemption_log: <value in [disable, enable]>
          # ssl_handshake_log: <value in [disable, enable]>
          # ssl_negotiation_log: <value in [disable, enable]>
          # ssl_server:
          #   - ftps_client_certificate: <value in [bypass, inspect, block]>
          #     https_client_certificate: <value in [bypass, inspect, block]>
          #     id: <integer>
          #     imaps_client_certificate: <value in [bypass, inspect, block]>
          #     ip: <string>
          #     pop3s_client_certificate: <value in [bypass, inspect, block]>
          #     smtps_client_certificate: <value in [bypass, inspect, block]>
          #     ssl_other_client_certificate: <value in [bypass, inspect, block]>
          #     smtps_client_cert_request: <value in [bypass, inspect, block]>
          #     imaps_client_cert_request: <value in [bypass, inspect, block]>
          #     ssl_other_client_cert_request: <value in [bypass, inspect, block]>
          #     ftps_client_cert_request: <value in [bypass, inspect, block]>
          #     https_client_cert_request: <value in [bypass, inspect, block]>
          #     pop3s_client_cert_request: <value in [bypass, inspect, block]>
          # ssl_server_cert_log: <value in [disable, enable]>
          # supported_alpn: <value in [none, http1-1, http2, ...]>
          # untrusted_caname: <list or string>
          # use_ssl_server: <value in [disable, enable]>
          # ssl_exemptions_log: <value in [disable, enable]>
          # ssl_anomalies_log: <value in [disable, enable]>
          # whitelist: <value in [disable, enable]>
          # block_blacklisted_certificates: <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)