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 |
---|---|
The token to access FortiManager without using username and password. |
|
The parameter (adom) in requested url. |
|
Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. Choices:
|
|
Enable/Disable logging for task. Choices:
|
|
The top level parameters set. |
|
Enable/disable exempting servers by FortiGuard allowlist. Choices:
|
|
Deprecated, please rename it to block_blacklisted_certificates. Enable/disable blocking SSL-based botnet communication by … Choices:
|
|
Deprecated, please rename it to block_blocklisted_certificates. Enable/disable blocking SSL-based botnet communication by … Choices:
|
|
CA certificate used by SSL Inspection. |
|
Certificate containing the key to use when re-signing server certificates for SSL inspection. |
|
Optional comments. |
|
Dot. |
|
Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure. Choices:
|
|
Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout. Choices:
|
|
Deprecated, please rename it to client_certificate. Action based on received client certificate. Choices:
|
|
Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired. Choices:
|
|
Deprecated, please rename it to min_allowed_ssl_version. Min allowed ssl version. Choices:
|
|
Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es… Choices:
|
|
Enable/disable QUIC inspection Choices:
|
|
Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked. Choices:
|
|
Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA… Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp… Choices:
|
|
Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported. Choices:
|
|
Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust… Choices:
|
|
Deprecated, please rename it to ech_outer_sni. Ech outer sni. |
|
ClientHelloOuter SNI name. |
|
ClientHelloOuter SNI to be blocked. |
|
Ftps. |
|
Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific… Choices:
|
|
Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure. Choices:
|
|
Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout. Choices:
|
|
Deprecated, please rename it to client_cert_request. Action based on client certificate request. Choices:
|
|
Deprecated, please rename it to client_certificate. Action based on received client certificate. Choices:
|
|
Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired. Choices:
|
|
Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate. Choices:
|
|
Deprecated, please rename it to min_allowed_ssl_version. Minimum SSL version to be allowed. Choices:
|
|
(list) Ports to use for scanning |
|
Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked. Choices:
|
|
Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA… Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp… Choices:
|
|
Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported. Choices:
|
|
Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust… Choices:
|
|
Https. |
|
Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific… Choices:
|
|
Deprecated, please rename it to cert_probe_failure. Action based on certificate probe failure. Choices:
|
|
Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure. Choices:
|
|
Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout. Choices:
|
|
Deprecated, please rename it to client_cert_request. Action based on client certificate request. Choices:
|
|
Deprecated, please rename it to client_certificate. Action based on received client certificate. Choices:
|
|
Deprecated, please rename it to encrypted_client_hello. Block/allow session based on existence of encrypted-client… Choices:
|
|
Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired. Choices:
|
|
Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate. Choices:
|
|
Deprecated, please rename it to min_allowed_ssl_version. Minimum SSL version to be allowed. Choices:
|
|
(list) Ports to use for scanning |
|
Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es… Choices:
|
|
Enable/disable QUIC inspection Choices:
|
|
Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked. Choices:
|
|
Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA… Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp… Choices:
|
|
Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported. Choices:
|
|
Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust… Choices:
|
|
Imaps. |
|
Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific… Choices:
|
|
Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure. Choices:
|
|
Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout. Choices:
|
|
Deprecated, please rename it to client_cert_request. Action based on client certificate request. Choices:
|
|
Deprecated, please rename it to client_certificate. Action based on received client certificate. Choices:
|
|
Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired. Choices:
|
|
Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate. Choices:
|
|
Deprecated, please rename it to min_allowed_ssl_version. Min allowed ssl version. Choices:
|
|
(list) Ports to use for scanning |
|
Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es… Choices:
|
|
Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked. Choices:
|
|
Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA… Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp… Choices:
|
|
Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported. Choices:
|
|
Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust… Choices:
|
|
Deprecated, please rename it to mapi_over_https. Enable/disable inspection of MAPI over HTTPS. Choices:
|
|
Name. |
|
Pop3s. |
|
Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific… Choices:
|
|
Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure. Choices:
|
|
Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout. Choices:
|
|
Deprecated, please rename it to client_cert_request. Action based on client certificate request. Choices:
|
|
Deprecated, please rename it to client_certificate. Action based on received client certificate. Choices:
|
|
Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired. Choices:
|
|
Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate. Choices:
|
|
Deprecated, please rename it to min_allowed_ssl_version. Min allowed ssl version. Choices:
|
|
(list) Ports to use for scanning |
|
Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es… Choices:
|
|
Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked. Choices:
|
|
Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA… Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp… Choices:
|
|
Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported. Choices:
|
|
Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust… Choices:
|
|
Deprecated, please rename it to rpc_over_https. Enable/disable inspection of RPC over HTTPS. Choices:
|
|
(list or str) Deprecated, please rename it to server_cert. Certificate used by SSL Inspection to replace server certificate. |
|
Deprecated, please rename it to server_cert_mode. Re-sign or replace the servers certificate. Choices:
|
|
Smtps. |
|
Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific… Choices:
|
|
Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure. Choices:
|
|
Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout. Choices:
|
|
Deprecated, please rename it to client_cert_request. Action based on client certificate request. Choices:
|
|
Deprecated, please rename it to client_certificate. Action based on received client certificate. Choices:
|
|
Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired. Choices:
|
|
Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate. Choices:
|
|
Deprecated, please rename it to min_allowed_ssl_version. Min allowed ssl version. Choices:
|
|
(list) Ports to use for scanning |
|
Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es… Choices:
|
|
Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked. Choices:
|
|
Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA… Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp… Choices:
|
|
Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported. Choices:
|
|
Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust… Choices:
|
|
Ssh. |
|
SSH blocking options. Choices:
|
|
Deprecated, please rename it to inspect_all. Level of SSL inspection. Choices:
|
|
SSH logging options. Choices:
|
|
(list) Ports to use for scanning |
|
Deprecated, please rename it to proxy_after_tcp_handshake. Proxy traffic after the TCP 3-way handshake has been es… Choices:
|
|
Deprecated, please rename it to ssh_algorithm. Relative strength of encryption algorithms accepted during negotiation. Choices:
|
|
Deprecated, please rename it to ssh_policy_check. Enable/disable SSH policy check. Choices:
|
|
Deprecated, please rename it to ssh_tun_policy_check. Enable/disable SSH tunnel policy check. Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Deprecated, please rename it to unsupported_version. Action based on SSH version being unsupported. Choices:
|
|
Ssl. |
|
Deprecated, please rename it to allow_invalid_server_cert. When enabled, allows SSL sessions whose server certific… Choices:
|
|
Deprecated, please rename it to cert_probe_failure. Action based on certificate probe failure. Choices:
|
|
Deprecated, please rename it to cert_validation_failure. Action based on certificate validation failure. Choices:
|
|
Deprecated, please rename it to cert_validation_timeout. Action based on certificate validation timeout. Choices:
|
|
Deprecated, please rename it to client_cert_request. Action based on client certificate request. Choices:
|
|
Deprecated, please rename it to client_certificate. Action based on received client certificate. Choices:
|
|
Deprecated, please rename it to encrypted_client_hello. Block/allow session based on existence of encrypted-client… Choices:
|
|
Deprecated, please rename it to expired_server_cert. Action based on server certificate is expired. Choices:
|
|
Deprecated, please rename it to inspect_all. Level of SSL inspection. Choices:
|
|
Deprecated, please rename it to invalid_server_cert. Allow or block the invalid SSL session server certificate. Choices:
|
|
Deprecated, please rename it to min_allowed_ssl_version. Minimum SSL version to be allowed. Choices:
|
|
Deprecated, please rename it to revoked_server_cert. Action based on server certificate is revoked. Choices:
|
|
Deprecated, please rename it to sni_server_cert_check. Check the SNI in the client hello message with the CN or SA… Choices:
|
|
Deprecated, please rename it to unsupported_ssl. Action based on the SSL encryption used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_cipher. Action based on the SSL cipher used being unsupported. Choices:
|
|
Deprecated, please rename it to unsupported_ssl_negotiation. Action based on the SSL negotiation used being unsupp… Choices:
|
|
Deprecated, please rename it to unsupported_ssl_version. Action based on the SSL version used being unsupported. Choices:
|
|
Deprecated, please rename it to untrusted_cert. Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Deprecated, please rename it to untrusted_server_cert. Action based on server certificate is not issued by a trust… Choices:
|
|
Deprecated, please rename it to ssl_anomalies_log. Enable/disable logging SSL anomalies. Choices:
|
|
Deprecated, please rename it to ssl_anomaly_log. Enable/disable logging of SSL anomalies. Choices:
|
|
Deprecated, please rename it to ssl_exempt. Ssl exempt. |
|
IPv4 address object. |
|
IPv6 address object. |
|
Deprecated, please rename it to fortiguard_category. FortiGuard category ID. |
|
ID number. |
|
Exempt servers by regular expression. |
|
Type of address object Choices:
|
|
Deprecated, please rename it to wildcard_fqdn. Exempt servers by wildcard FQDN. |
|
Deprecated, please rename it to ssl_exemption_ip_rating. Enable/disable IP based URL rating. Choices:
|
|
Deprecated, please rename it to ssl_exemption_log. Enable/disable logging SSL exemptions. Choices:
|
|
Deprecated, please rename it to ssl_exemptions_log. Enable/disable logging SSL exemptions. Choices:
|
|
Deprecated, please rename it to ssl_handshake_log. Enable/disable logging of TLS handshakes. Choices:
|
|
Deprecated, please rename it to ssl_invalid_server_cert_log. Enable/disable SSL server certificate validation logging. Choices:
|
|
Deprecated, please rename it to ssl_negotiation_log. Enable/disable logging SSL negotiation. Choices:
|
|
Deprecated, please rename it to ssl_server. Ssl server. |
|
Deprecated, please rename it to ftps_client_cert_request. Action based on client certificate request during the FT… Choices:
|
|
Deprecated, please rename it to ftps_client_certificate. Action based on received client certificate during the FT… Choices:
|
|
Deprecated, please rename it to https_client_cert_request. Action based on client certificate request during the H… Choices:
|
|
Deprecated, please rename it to https_client_certificate. Action based on received client certificate during the H… Choices:
|
|
SSL server ID. |
|
Deprecated, please rename it to imaps_client_cert_request. Action based on client certificate request during the I… Choices:
|
|
Deprecated, please rename it to imaps_client_certificate. Action based on received client certificate during the I… Choices:
|
|
IPv4 address of the SSL server. |
|
Deprecated, please rename it to pop3s_client_cert_request. Action based on client certificate request during the P… Choices:
|
|
Deprecated, please rename it to pop3s_client_certificate. Action based on received client certificate during the P… Choices:
|
|
Deprecated, please rename it to smtps_client_cert_request. Action based on client certificate request during the S… Choices:
|
|
Deprecated, please rename it to smtps_client_certificate. Action based on received client certificate during the S… Choices:
|
|
Deprecated, please rename it to ssl_other_client_cert_request. Action based on client certificate request during a… Choices:
|
|
Deprecated, please rename it to ssl_other_client_certificate. Action based on received client certificate during a… Choices:
|
|
Deprecated, please rename it to ssl_server_cert_log. Enable/disable logging of server certificate information. Choices:
|
|
Deprecated, please rename it to supported_alpn. Configure ALPN option. Choices:
|
|
Deprecated, please rename it to untrusted_caname. Untrusted CA certificate used by SSL Inspection. |
|
Deprecated, please rename it to use_ssl_server. Enable/disable the use of SSL server table for SSL offloading. Choices:
|
|
Enable/disable exempting servers by FortiGuard whitelist. Choices:
|
|
Authenticate Ansible client with forticloud API access token. |
|
The overridden method for the underlying Json RPC request. Choices:
|
|
The rc codes list with which the conditions to fail will be overriden. |
|
The rc codes list with which the conditions to succeed will be overriden. |
|
The directive to create, update or delete an object. Choices:
|
|
The adom to lock for FortiManager running in workspace mode, the value can be global and others including root. |
|
The maximum time in seconds to wait for other user to release the workspace lock. Default: |
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 |
---|---|
The result of the request. Returned: always |
|
The full url requested. Returned: always Sample: |
|
The status of api request. Returned: always Sample: |
|
The api response. Returned: always |
|
The descriptive message of the api response. Returned: always Sample: |
|
The information of the target system. Returned: always |
|
The status the request. Returned: always Sample: |
|
Warning if the parameters used in the playbook are not supported by the current FortiManager version. Returned: complex |