fortinet.fortimanager.fmgr_firewall_sslsshprofile module – Configure SSL/SSH protocol options.

Note

This module is part of the fortinet.fortimanager collection (version 2.7.0).

You might already have this collection installed if you are using the ansible package. It is not included in ansible-core. To check whether it is installed, run ansible-galaxy collection list.

To install it, use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_sslsshprofile.

New in fortinet.fortimanager 1.0.0

Synopsis

  • This module is able to configure a FortiManager device.

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

Parameters

Parameter

Comments

access_token

string

The token to access FortiManager without using username and password.

adom

string / required

The parameter (adom) in requested url.

bypass_validation

boolean

Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters.

Choices:

  • false ← (default)

  • true

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)

  • true

firewall_sslsshprofile

dictionary

The top level parameters set.

allowlist

string

Enable/disable exempting servers by FortiGuard allowlist.

Choices:

  • "disable"

  • "enable"

block-blacklisted-certificates

string

Deprecated, please rename it to block_blacklisted_certificates. Enable/disable blocking SSL-based botnet communication by …

Choices:

  • "disable"

  • "enable"

block-blocklisted-certificates

string

Deprecated, please rename it to block_blocklisted_certificates. Enable/disable blocking SSL-based botnet communication by …

Choices:

  • "disable"

  • "enable"

caname

string

CA certificate used by SSL Inspection.

certname

string

Certificate containing the key to use when re-signing server certificates for SSL inspection.

comment

string

Optional comments.

dot

dictionary

Dot.

cert-validation-failure

string

Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure.

Choices:

  • "allow"

  • "block"

  • "ignore"

cert-validation-timeout

string

Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout.

Choices:

  • "allow"

  • "block"

  • "ignore"

client-certificate

string

Deprecated, please rename it to client_certificate. Action based on received client certificate.

Choices:

  • "bypass"

  • "inspect"

  • "block"

expired-server-cert

string

Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired.

Choices:

  • "allow"

  • "block"

  • "ignore"

min-allowed-ssl-version

string

Deprecated, please rename it to min_allowed_ssl_version. Min allowed ssl version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

quic

string

Enable/disable QUIC inspection

Choices:

  • "disable"

  • "enable"

  • "bypass"

  • "block"

  • "inspect"

revoked-server-cert

string

Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked.

Choices:

  • "allow"

  • "block"

  • "ignore"

sni-server-cert-check

string

Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA…

Choices:

  • "enable"

  • "strict"

  • "disable"

status

string

Configure protocol inspection status.

Choices:

  • "disable"

  • "deep-inspection"

unsupported-ssl-cipher

string

Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported.

Choices:

  • "block"

  • "allow"

unsupported-ssl-negotiation

string

Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp…

Choices:

  • "block"

  • "allow"

unsupported-ssl-version

string

Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported.

Choices:

  • "block"

  • "allow"

  • "inspect"

untrusted-server-cert

string

Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust…

Choices:

  • "allow"

  • "block"

  • "ignore"

ech-outer-sni

list / elements=dictionary

Deprecated, please rename it to ech_outer_sni. Ech outer sni.

name

string

ClientHelloOuter SNI name.

sni

string

ClientHelloOuter SNI to be blocked.

ftps

dictionary

Ftps.

allow-invalid-server-cert

string

Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific…

Choices:

  • "disable"

  • "enable"

cert-validation-failure

string

Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure.

Choices:

  • "allow"

  • "block"

  • "ignore"

cert-validation-timeout

string

Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout.

Choices:

  • "allow"

  • "block"

  • "ignore"

client-cert-request

string

Deprecated, please rename it to client_cert_request. Action based on client certificate request.

Choices:

  • "bypass"

  • "inspect"

  • "block"

client-certificate

string

Deprecated, please rename it to client_certificate. Action based on received client certificate.

Choices:

  • "bypass"

  • "inspect"

  • "block"

expired-server-cert

string

Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired.

Choices:

  • "allow"

  • "block"

  • "ignore"

invalid-server-cert

string

Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate.

Choices:

  • "allow"

  • "block"

min-allowed-ssl-version

string

Deprecated, please rename it to min_allowed_ssl_version. Minimum SSL version to be allowed.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ports

any

(list) Ports to use for scanning

revoked-server-cert

string

Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked.

Choices:

  • "allow"

  • "block"

  • "ignore"

sni-server-cert-check

string

Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA…

Choices:

  • "disable"

  • "enable"

  • "strict"

status

string

Configure protocol inspection status.

Choices:

  • "disable"

  • "deep-inspection"

unsupported-ssl

string

Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported.

Choices:

  • "bypass"

  • "inspect"

  • "block"

unsupported-ssl-cipher

string

Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported.

Choices:

  • "allow"

  • "block"

unsupported-ssl-negotiation

string

Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp…

Choices:

  • "allow"

  • "block"

unsupported-ssl-version

string

Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported.

Choices:

  • "block"

  • "allow"

  • "inspect"

untrusted-cert

string

Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate.

Choices:

  • "allow"

  • "block"

  • "ignore"

untrusted-server-cert

string

Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust…

Choices:

  • "allow"

  • "block"

  • "ignore"

https

dictionary

Https.

allow-invalid-server-cert

string

Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific…

Choices:

  • "disable"

  • "enable"

cert-probe-failure

string

Deprecated, please rename it to cert_probe_failure. Action based on certificate probe failure.

Choices:

  • "block"

  • "allow"

cert-validation-failure

string

Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure.

Choices:

  • "allow"

  • "block"

  • "ignore"

cert-validation-timeout

string

Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout.

Choices:

  • "allow"

  • "block"

  • "ignore"

client-cert-request

string

Deprecated, please rename it to client_cert_request. Action based on client certificate request.

Choices:

  • "bypass"

  • "inspect"

  • "block"

client-certificate

string

Deprecated, please rename it to client_certificate. Action based on received client certificate.

Choices:

  • "bypass"

  • "inspect"

  • "block"

encrypted-client-hello

string

Deprecated, please rename it to encrypted_client_hello. Block/allow session based on existence of encrypted-client…

Choices:

  • "block"

  • "allow"

expired-server-cert

string

Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired.

Choices:

  • "allow"

  • "block"

  • "ignore"

invalid-server-cert

string

Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate.

Choices:

  • "allow"

  • "block"

min-allowed-ssl-version

string

Deprecated, please rename it to min_allowed_ssl_version. Minimum SSL version to be allowed.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ports

any

(list) Ports to use for scanning

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

quic

string

Enable/disable QUIC inspection

Choices:

  • "disable"

  • "enable"

  • "bypass"

  • "block"

  • "inspect"

revoked-server-cert

string

Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked.

Choices:

  • "allow"

  • "block"

  • "ignore"

sni-server-cert-check

string

Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA…

Choices:

  • "disable"

  • "enable"

  • "strict"

status

string

Configure protocol inspection status.

Choices:

  • "disable"

  • "certificate-inspection"

  • "deep-inspection"

unsupported-ssl

string

Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported.

Choices:

  • "bypass"

  • "inspect"

  • "block"

unsupported-ssl-cipher

string

Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported.

Choices:

  • "allow"

  • "block"

unsupported-ssl-negotiation

string

Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp…

Choices:

  • "allow"

  • "block"

unsupported-ssl-version

string

Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported.

Choices:

  • "block"

  • "allow"

  • "inspect"

untrusted-cert

string

Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate.

Choices:

  • "allow"

  • "block"

  • "ignore"

untrusted-server-cert

string

Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust…

Choices:

  • "allow"

  • "block"

  • "ignore"

imaps

dictionary

Imaps.

allow-invalid-server-cert

string

Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific…

Choices:

  • "disable"

  • "enable"

cert-validation-failure

string

Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure.

Choices:

  • "allow"

  • "block"

  • "ignore"

cert-validation-timeout

string

Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout.

Choices:

  • "allow"

  • "block"

  • "ignore"

client-cert-request

string

Deprecated, please rename it to client_cert_request. Action based on client certificate request.

Choices:

  • "bypass"

  • "inspect"

  • "block"

client-certificate

string

Deprecated, please rename it to client_certificate. Action based on received client certificate.

Choices:

  • "bypass"

  • "inspect"

  • "block"

expired-server-cert

string

Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired.

Choices:

  • "allow"

  • "block"

  • "ignore"

invalid-server-cert

string

Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate.

Choices:

  • "allow"

  • "block"

min-allowed-ssl-version

string

Deprecated, please rename it to min_allowed_ssl_version. Min allowed ssl version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ports

any

(list) Ports to use for scanning

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

revoked-server-cert

string

Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked.

Choices:

  • "allow"

  • "block"

  • "ignore"

sni-server-cert-check

string

Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA…

Choices:

  • "disable"

  • "enable"

  • "strict"

status

string

Configure protocol inspection status.

Choices:

  • "disable"

  • "deep-inspection"

unsupported-ssl

string

Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported.

Choices:

  • "bypass"

  • "inspect"

  • "block"

unsupported-ssl-cipher

string

Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported.

Choices:

  • "allow"

  • "block"

unsupported-ssl-negotiation

string

Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp…

Choices:

  • "allow"

  • "block"

unsupported-ssl-version

string

Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported.

Choices:

  • "block"

  • "allow"

  • "inspect"

untrusted-cert

string

Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate.

Choices:

  • "allow"

  • "block"

  • "ignore"

untrusted-server-cert

string

Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust…

Choices:

  • "allow"

  • "block"

  • "ignore"

mapi-over-https

string

Deprecated, please rename it to mapi_over_https. Enable/disable inspection of MAPI over HTTPS.

Choices:

  • "disable"

  • "enable"

name

string / required

Name.

pop3s

dictionary

Pop3s.

allow-invalid-server-cert

string

Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific…

Choices:

  • "disable"

  • "enable"

cert-validation-failure

string

Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure.

Choices:

  • "allow"

  • "block"

  • "ignore"

cert-validation-timeout

string

Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout.

Choices:

  • "allow"

  • "block"

  • "ignore"

client-cert-request

string

Deprecated, please rename it to client_cert_request. Action based on client certificate request.

Choices:

  • "bypass"

  • "inspect"

  • "block"

client-certificate

string

Deprecated, please rename it to client_certificate. Action based on received client certificate.

Choices:

  • "bypass"

  • "inspect"

  • "block"

expired-server-cert

string

Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired.

Choices:

  • "allow"

  • "block"

  • "ignore"

invalid-server-cert

string

Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate.

Choices:

  • "allow"

  • "block"

min-allowed-ssl-version

string

Deprecated, please rename it to min_allowed_ssl_version. Min allowed ssl version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ports

any

(list) Ports to use for scanning

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

revoked-server-cert

string

Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked.

Choices:

  • "allow"

  • "block"

  • "ignore"

sni-server-cert-check

string

Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA…

Choices:

  • "disable"

  • "enable"

  • "strict"

status

string

Configure protocol inspection status.

Choices:

  • "disable"

  • "deep-inspection"

unsupported-ssl

string

Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported.

Choices:

  • "bypass"

  • "inspect"

  • "block"

unsupported-ssl-cipher

string

Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported.

Choices:

  • "allow"

  • "block"

unsupported-ssl-negotiation

string

Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp…

Choices:

  • "allow"

  • "block"

unsupported-ssl-version

string

Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported.

Choices:

  • "block"

  • "allow"

  • "inspect"

untrusted-cert

string

Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate.

Choices:

  • "allow"

  • "block"

  • "ignore"

untrusted-server-cert

string

Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust…

Choices:

  • "allow"

  • "block"

  • "ignore"

rpc-over-https

string

Deprecated, please rename it to rpc_over_https. Enable/disable inspection of RPC over HTTPS.

Choices:

  • "disable"

  • "enable"

server-cert

any

(list or str) Deprecated, please rename it to server_cert. Certificate used by SSL Inspection to replace server certificate.

server-cert-mode

string

Deprecated, please rename it to server_cert_mode. Re-sign or replace the servers certificate.

Choices:

  • "re-sign"

  • "replace"

smtps

dictionary

Smtps.

allow-invalid-server-cert

string

Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific…

Choices:

  • "disable"

  • "enable"

cert-validation-failure

string

Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure.

Choices:

  • "allow"

  • "block"

  • "ignore"

cert-validation-timeout

string

Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout.

Choices:

  • "allow"

  • "block"

  • "ignore"

client-cert-request

string

Deprecated, please rename it to client_cert_request. Action based on client certificate request.

Choices:

  • "bypass"

  • "inspect"

  • "block"

client-certificate

string

Deprecated, please rename it to client_certificate. Action based on received client certificate.

Choices:

  • "bypass"

  • "inspect"

  • "block"

expired-server-cert

string

Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired.

Choices:

  • "allow"

  • "block"

  • "ignore"

invalid-server-cert

string

Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate.

Choices:

  • "allow"

  • "block"

min-allowed-ssl-version

string

Deprecated, please rename it to min_allowed_ssl_version. Min allowed ssl version.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

ports

any

(list) Ports to use for scanning

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

revoked-server-cert

string

Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked.

Choices:

  • "allow"

  • "block"

  • "ignore"

sni-server-cert-check

string

Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA…

Choices:

  • "disable"

  • "enable"

  • "strict"

status

string

Configure protocol inspection status.

Choices:

  • "disable"

  • "deep-inspection"

unsupported-ssl

string

Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported.

Choices:

  • "bypass"

  • "inspect"

  • "block"

unsupported-ssl-cipher

string

Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported.

Choices:

  • "allow"

  • "block"

unsupported-ssl-negotiation

string

Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp…

Choices:

  • "allow"

  • "block"

unsupported-ssl-version

string

Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported.

Choices:

  • "block"

  • "allow"

  • "inspect"

untrusted-cert

string

Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate.

Choices:

  • "allow"

  • "block"

  • "ignore"

untrusted-server-cert

string

Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust…

Choices:

  • "allow"

  • "block"

  • "ignore"

ssh

dictionary

Ssh.

block

list / elements=string

SSH blocking options.

Choices:

  • "x11-filter"

  • "ssh-shell"

  • "exec"

  • "port-forward"

inspect-all

string

Deprecated, please rename it to inspect_all. Level of SSL inspection.

Choices:

  • "disable"

  • "deep-inspection"

log

list / elements=string

SSH logging options.

Choices:

  • "x11-filter"

  • "ssh-shell"

  • "exec"

  • "port-forward"

ports

any

(list) Ports to use for scanning

proxy-after-tcp-handshake

string

Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es…

Choices:

  • "disable"

  • "enable"

ssh-algorithm

string

Deprecated, please rename it to ssh_algorithm. Relative strength of encryption algorithms accepted during negotiation.

Choices:

  • "compatible"

  • "high-encryption"

ssh-policy-check

string

Deprecated, please rename it to ssh_policy_check. Enable/disable SSH policy check.

Choices:

  • "disable"

  • "enable"

ssh-tun-policy-check

string

Deprecated, please rename it to ssh_tun_policy_check. Enable/disable SSH tunnel policy check.

Choices:

  • "disable"

  • "enable"

status

string

Configure protocol inspection status.

Choices:

  • "disable"

  • "deep-inspection"

unsupported-version

string

Deprecated, please rename it to unsupported_version. Action based on SSH version being unsupported.

Choices:

  • "block"

  • "bypass"

ssl

dictionary

Ssl.

allow-invalid-server-cert

string

Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific…

Choices:

  • "disable"

  • "enable"

cert-probe-failure

string

Deprecated, please rename it to cert_probe_failure. Action based on certificate probe failure.

Choices:

  • "block"

  • "allow"

cert-validation-failure

string

Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure.

Choices:

  • "allow"

  • "block"

  • "ignore"

cert-validation-timeout

string

Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout.

Choices:

  • "allow"

  • "block"

  • "ignore"

client-cert-request

string

Deprecated, please rename it to client_cert_request. Action based on client certificate request.

Choices:

  • "bypass"

  • "inspect"

  • "block"

client-certificate

string

Deprecated, please rename it to client_certificate. Action based on received client certificate.

Choices:

  • "bypass"

  • "inspect"

  • "block"

encrypted-client-hello

string

Deprecated, please rename it to encrypted_client_hello. Block/allow session based on existence of encrypted-client…

Choices:

  • "block"

  • "allow"

expired-server-cert

string

Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired.

Choices:

  • "allow"

  • "block"

  • "ignore"

inspect-all

string

Deprecated, please rename it to inspect_all. Level of SSL inspection.

Choices:

  • "disable"

  • "certificate-inspection"

  • "deep-inspection"

invalid-server-cert

string

Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate.

Choices:

  • "allow"

  • "block"

min-allowed-ssl-version

string

Deprecated, please rename it to min_allowed_ssl_version. Minimum SSL version to be allowed.

Choices:

  • "ssl-3.0"

  • "tls-1.0"

  • "tls-1.1"

  • "tls-1.2"

  • "tls-1.3"

revoked-server-cert

string

Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked.

Choices:

  • "allow"

  • "block"

  • "ignore"

sni-server-cert-check

string

Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA…

Choices:

  • "disable"

  • "enable"

  • "strict"

unsupported-ssl

string

Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported.

Choices:

  • "bypass"

  • "inspect"

  • "block"

unsupported-ssl-cipher

string

Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported.

Choices:

  • "allow"

  • "block"

unsupported-ssl-negotiation

string

Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp…

Choices:

  • "allow"

  • "block"

unsupported-ssl-version

string

Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported.

Choices:

  • "block"

  • "allow"

  • "inspect"

untrusted-cert

string

Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate.

Choices:

  • "allow"

  • "block"

  • "ignore"

untrusted-server-cert

string

Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust…

Choices:

  • "allow"

  • "block"

  • "ignore"

ssl-anomalies-log

string

Deprecated, please rename it to ssl_anomalies_log. Enable/disable logging SSL anomalies.

Choices:

  • "disable"

  • "enable"

ssl-anomaly-log

string

Deprecated, please rename it to ssl_anomaly_log. Enable/disable logging of SSL anomalies.

Choices:

  • "disable"

  • "enable"

ssl-exempt

list / elements=dictionary

Deprecated, please rename it to ssl_exempt. Ssl exempt.

address

string

IPv4 address object.

address6

string

IPv6 address object.

fortiguard-category

string

Deprecated, please rename it to fortiguard_category. FortiGuard category ID.

id

integer

ID number.

regex

string

Exempt servers by regular expression.

type

string

Type of address object

Choices:

  • "fortiguard-category"

  • "address"

  • "address6"

  • "wildcard-fqdn"

  • "regex"

  • "finger-print"

wildcard-fqdn

string

Deprecated, please rename it to wildcard_fqdn. Exempt servers by wildcard FQDN.

ssl-exemption-ip-rating

string

Deprecated, please rename it to ssl_exemption_ip_rating. Enable/disable IP based URL rating.

Choices:

  • "disable"

  • "enable"

ssl-exemption-log

string

Deprecated, please rename it to ssl_exemption_log. Enable/disable logging SSL exemptions.

Choices:

  • "disable"

  • "enable"

ssl-exemptions-log

string

Deprecated, please rename it to ssl_exemptions_log. Enable/disable logging SSL exemptions.

Choices:

  • "disable"

  • "enable"

ssl-handshake-log

string

Deprecated, please rename it to ssl_handshake_log. Enable/disable logging of TLS handshakes.

Choices:

  • "disable"

  • "enable"

ssl-invalid-server-cert-log

string

Deprecated, please rename it to ssl_invalid_server_cert_log. Enable/disable SSL server certificate validation logging.

Choices:

  • "disable"

  • "enable"

ssl-negotiation-log

string

Deprecated, please rename it to ssl_negotiation_log. Enable/disable logging SSL negotiation.

Choices:

  • "disable"

  • "enable"

ssl-server

list / elements=dictionary

Deprecated, please rename it to ssl_server. Ssl server.

ftps-client-cert-request

string

Deprecated, please rename it to ftps_client_cert_request. Action based on client certificate request during the FT…

Choices:

  • "bypass"

  • "inspect"

  • "block"

ftps-client-certificate

string

Deprecated, please rename it to ftps_client_certificate. Action based on received client certificate during the FT…

Choices:

  • "bypass"

  • "inspect"

  • "block"

https-client-cert-request

string

Deprecated, please rename it to https_client_cert_request. Action based on client certificate request during the H…

Choices:

  • "bypass"

  • "inspect"

  • "block"

https-client-certificate

string

Deprecated, please rename it to https_client_certificate. Action based on received client certificate during the H…

Choices:

  • "bypass"

  • "inspect"

  • "block"

id

integer

SSL server ID.

imaps-client-cert-request

string

Deprecated, please rename it to imaps_client_cert_request. Action based on client certificate request during the I…

Choices:

  • "bypass"

  • "inspect"

  • "block"

imaps-client-certificate

string

Deprecated, please rename it to imaps_client_certificate. Action based on received client certificate during the I…

Choices:

  • "bypass"

  • "inspect"

  • "block"

ip

string

IPv4 address of the SSL server.

pop3s-client-cert-request

string

Deprecated, please rename it to pop3s_client_cert_request. Action based on client certificate request during the P…

Choices:

  • "bypass"

  • "inspect"

  • "block"

pop3s-client-certificate

string

Deprecated, please rename it to pop3s_client_certificate. Action based on received client certificate during the P…

Choices:

  • "bypass"

  • "inspect"

  • "block"

smtps-client-cert-request

string

Deprecated, please rename it to smtps_client_cert_request. Action based on client certificate request during the S…

Choices:

  • "bypass"

  • "inspect"

  • "block"

smtps-client-certificate

string

Deprecated, please rename it to smtps_client_certificate. Action based on received client certificate during the S…

Choices:

  • "bypass"

  • "inspect"

  • "block"

ssl-other-client-cert-request

string

Deprecated, please rename it to ssl_other_client_cert_request. Action based on client certificate request during a…

Choices:

  • "bypass"

  • "inspect"

  • "block"

ssl-other-client-certificate

string

Deprecated, please rename it to ssl_other_client_certificate. Action based on received client certificate during a…

Choices:

  • "bypass"

  • "inspect"

  • "block"

ssl-server-cert-log

string

Deprecated, please rename it to ssl_server_cert_log. Enable/disable logging of server certificate information.

Choices:

  • "disable"

  • "enable"

supported-alpn

string

Deprecated, please rename it to supported_alpn. Configure ALPN option.

Choices:

  • "none"

  • "http1-1"

  • "http2"

  • "all"

untrusted-caname

string

Deprecated, please rename it to untrusted_caname. Untrusted CA certificate used by SSL Inspection.

use-ssl-server

string

Deprecated, please rename it to use_ssl_server. Enable/disable the use of SSL server table for SSL offloading.

Choices:

  • "disable"

  • "enable"

whitelist

string

Enable/disable exempting servers by FortiGuard whitelist.

Choices:

  • "disable"

  • "enable"

forticloud_access_token

string

Authenticate Ansible client with forticloud API access token.

proposed_method

string

The overridden method for the underlying Json RPC request.

Choices:

  • "update"

  • "set"

  • "add"

rc_failed

list / elements=integer

The rc codes list with which the conditions to fail will be overriden.

rc_succeeded

list / elements=integer

The rc codes list with which the conditions to succeed will be overriden.

state

string / required

The directive to create, update or delete an object.

Choices:

  • "present"

  • "absent"

workspace_locking_adom

string

The adom to lock for FortiManager running in workspace mode, the value can be global and others including root.

workspace_locking_timeout

integer

The maximum time in seconds to wait for other user to release the workspace lock.

Default: 300

Notes

Note

  • Starting in version 2.4.0, all input arguments are named using the underscore naming convention (snake_case). Please change the arguments such as “var-name” to “var_name”. Old argument names are still available yet you will receive deprecation warnings. You can ignore this warning by setting deprecation_warnings=False in ansible.cfg.

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state present directive.

  • To delete an object, use state absent directive.

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook
  hosts: fortimanagers
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure SSL/SSH protocol options.
      fortinet.fortimanager.fmgr_firewall_sslsshprofile:
        bypass_validation: false
        adom: ansible
        state: present
        firewall_sslsshprofile:
          comment: "ansible-comment1"
          mapi-over-https: disable # <value in [disable, enable]>
          name: "ansible-test"
          use-ssl-server: disable # <value in [disable, enable]>
          whitelist: enable # <value in [disable, enable]>

- name: Gathering fortimanager facts
  hosts: fortimanagers
  gather_facts: false
  connection: httpapi
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Retrieve all the SSL/SSH protocol options
      fortinet.fortimanager.fmgr_fact:
        facts:
          selector: "firewall_sslsshprofile"
          params:
            adom: "ansible"
            ssl-ssh-profile: "your_value"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key

Description

meta

dictionary

The result of the request.

Returned: always

request_url

string

The full url requested.

Returned: always

Sample: "/sys/login/user"

response_code

integer

The status of api request.

Returned: always

Sample: 0

response_data

list / elements=string

The api response.

Returned: always

response_message

string

The descriptive message of the api response.

Returned: always

Sample: "OK."

system_information

dictionary

The information of the target system.

Returned: always

rc

integer

The status the request.

Returned: always

Sample: 0

version_check_warning

list / elements=string

Warning if the parameters used in the playbook are not supported by the current FortiManager version.

Returned: complex

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)