fortinet.fortimanager.fmgr_firewall_sslsshprofile module – Configure SSL/SSH protocol options.
Note
This module is part of the fortinet.fortimanager collection (version 2.8.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:
|
|
Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blacklist. Choices:
|
|
Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blocklist. Choices:
|
|
CA certificate used by SSL Inspection. |
|
Certificate containing the key to use when re-signing server certificates for SSL inspection. |
|
Optional comments. |
|
Dot. |
|
Action based on certificate validation failure. Choices:
|
|
Action based on certificate validation timeout. Choices:
|
|
Action based on received client certificate. Choices:
|
|
Action based on server certificate is expired. Choices:
|
|
Min allowed ssl version. Choices:
|
|
Proxy traffic after the TCP 3-way handshake has been established Choices:
|
|
Enable/disable QUIC inspection Choices:
|
|
Action based on server certificate is revoked. Choices:
|
|
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Action based on the SSL cipher used being unsupported. Choices:
|
|
Action based on the SSL negotiation used being unsupported. Choices:
|
|
Action based on the SSL version used being unsupported. Choices:
|
|
Action based on server certificate is not issued by a trusted CA. Choices:
|
|
Ech outer sni. |
|
ClientHelloOuter SNI name. |
|
ClientHelloOuter SNI to be blocked. |
|
Ftps. |
|
When enabled, allows SSL sessions whose server certificate validation failed. Choices:
|
|
Action based on certificate validation failure. Choices:
|
|
Action based on certificate validation timeout. Choices:
|
|
Action based on client certificate request. Choices:
|
|
Action based on received client certificate. Choices:
|
|
Action based on server certificate is expired. Choices:
|
|
Allow or block the invalid SSL session server certificate. Choices:
|
|
Minimum SSL version to be allowed. Choices:
|
|
(list) Ports to use for scanning |
|
Action based on server certificate is revoked. Choices:
|
|
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Action based on the SSL encryption used being unsupported. Choices:
|
|
Action based on the SSL cipher used being unsupported. Choices:
|
|
Action based on the SSL negotiation used being unsupported. Choices:
|
|
Action based on the SSL version used being unsupported. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Action based on server certificate is not issued by a trusted CA. Choices:
|
|
Https. |
|
When enabled, allows SSL sessions whose server certificate validation failed. Choices:
|
|
Action based on certificate probe failure. Choices:
|
|
Action based on certificate validation failure. Choices:
|
|
Action based on certificate validation timeout. Choices:
|
|
Action based on client certificate request. Choices:
|
|
Action based on received client certificate. Choices:
|
|
Block/allow session based on existence of encrypted-client-hello. Choices:
|
|
Action based on server certificate is expired. Choices:
|
|
Allow or block the invalid SSL session server certificate. Choices:
|
|
Minimum SSL version to be allowed. Choices:
|
|
(list) Ports to use for scanning |
|
Proxy traffic after the TCP 3-way handshake has been established Choices:
|
|
Enable/disable QUIC inspection Choices:
|
|
Action based on server certificate is revoked. Choices:
|
|
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Action based on the SSL encryption used being unsupported. Choices:
|
|
Action based on the SSL cipher used being unsupported. Choices:
|
|
Action based on the SSL negotiation used being unsupported. Choices:
|
|
Action based on the SSL version used being unsupported. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Action based on server certificate is not issued by a trusted CA. Choices:
|
|
Imaps. |
|
When enabled, allows SSL sessions whose server certificate validation failed. Choices:
|
|
Action based on certificate validation failure. Choices:
|
|
Action based on certificate validation timeout. Choices:
|
|
Action based on client certificate request. Choices:
|
|
Action based on received client certificate. Choices:
|
|
Action based on server certificate is expired. Choices:
|
|
Allow or block the invalid SSL session server certificate. Choices:
|
|
Min allowed ssl version. Choices:
|
|
(list) Ports to use for scanning |
|
Proxy traffic after the TCP 3-way handshake has been established Choices:
|
|
Action based on server certificate is revoked. Choices:
|
|
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Action based on the SSL encryption used being unsupported. Choices:
|
|
Action based on the SSL cipher used being unsupported. Choices:
|
|
Action based on the SSL negotiation used being unsupported. Choices:
|
|
Action based on the SSL version used being unsupported. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Action based on server certificate is not issued by a trusted CA. Choices:
|
|
Enable/disable inspection of MAPI over HTTPS. Choices:
|
|
Name. |
|
Pop3s. |
|
When enabled, allows SSL sessions whose server certificate validation failed. Choices:
|
|
Action based on certificate validation failure. Choices:
|
|
Action based on certificate validation timeout. Choices:
|
|
Action based on client certificate request. Choices:
|
|
Action based on received client certificate. Choices:
|
|
Action based on server certificate is expired. Choices:
|
|
Allow or block the invalid SSL session server certificate. Choices:
|
|
Min allowed ssl version. Choices:
|
|
(list) Ports to use for scanning |
|
Proxy traffic after the TCP 3-way handshake has been established Choices:
|
|
Action based on server certificate is revoked. Choices:
|
|
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Action based on the SSL encryption used being unsupported. Choices:
|
|
Action based on the SSL cipher used being unsupported. Choices:
|
|
Action based on the SSL negotiation used being unsupported. Choices:
|
|
Action based on the SSL version used being unsupported. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Action based on server certificate is not issued by a trusted CA. Choices:
|
|
Enable/disable inspection of RPC over HTTPS. Choices:
|
|
(list or str) Certificate used by SSL Inspection to replace server certificate. |
|
Re-sign or replace the servers certificate. Choices:
|
|
Smtps. |
|
When enabled, allows SSL sessions whose server certificate validation failed. Choices:
|
|
Action based on certificate validation failure. Choices:
|
|
Action based on certificate validation timeout. Choices:
|
|
Action based on client certificate request. Choices:
|
|
Action based on received client certificate. Choices:
|
|
Action based on server certificate is expired. Choices:
|
|
Allow or block the invalid SSL session server certificate. Choices:
|
|
Min allowed ssl version. Choices:
|
|
(list) Ports to use for scanning |
|
Proxy traffic after the TCP 3-way handshake has been established Choices:
|
|
Action based on server certificate is revoked. Choices:
|
|
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Action based on the SSL encryption used being unsupported. Choices:
|
|
Action based on the SSL cipher used being unsupported. Choices:
|
|
Action based on the SSL negotiation used being unsupported. Choices:
|
|
Action based on the SSL version used being unsupported. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Action based on server certificate is not issued by a trusted CA. Choices:
|
|
Ssh. |
|
SSH blocking options. Choices:
|
|
Level of SSL inspection. Choices:
|
|
SSH logging options. Choices:
|
|
(list) Ports to use for scanning |
|
Proxy traffic after the TCP 3-way handshake has been established Choices:
|
|
Relative strength of encryption algorithms accepted during negotiation. Choices:
|
|
Enable/disable SSH policy check. Choices:
|
|
Enable/disable SSH tunnel policy check. Choices:
|
|
Configure protocol inspection status. Choices:
|
|
Action based on SSH version being unsupported. Choices:
|
|
Ssl. |
|
When enabled, allows SSL sessions whose server certificate validation failed. Choices:
|
|
Action based on certificate probe failure. Choices:
|
|
Action based on certificate validation failure. Choices:
|
|
Action based on certificate validation timeout. Choices:
|
|
Action based on client certificate request. Choices:
|
|
Action based on received client certificate. Choices:
|
|
Block/allow session based on existence of encrypted-client-hello. Choices:
|
|
Action based on server certificate is expired. Choices:
|
|
Level of SSL inspection. Choices:
|
|
Allow or block the invalid SSL session server certificate. Choices:
|
|
Minimum SSL version to be allowed. Choices:
|
|
Action based on server certificate is revoked. Choices:
|
|
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate. Choices:
|
|
Action based on the SSL encryption used being unsupported. Choices:
|
|
Action based on the SSL cipher used being unsupported. Choices:
|
|
Action based on the SSL negotiation used being unsupported. Choices:
|
|
Action based on the SSL version used being unsupported. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. Choices:
|
|
Action based on server certificate is not issued by a trusted CA. Choices:
|
|
Enable/disable logging SSL anomalies. Choices:
|
|
Enable/disable logging of SSL anomalies. Choices:
|
|
Ssl exempt. |
|
IPv4 address object. |
|
IPv6 address object. |
|
FortiGuard category ID. |
|
ID number. |
|
Exempt servers by regular expression. |
|
Type of address object Choices:
|
|
Exempt servers by wildcard FQDN. |
|
Enable/disable IP based URL rating. Choices:
|
|
Enable/disable logging SSL exemptions. Choices:
|
|
Enable/disable logging SSL exemptions. Choices:
|
|
Enable/disable logging of TLS handshakes. Choices:
|
|
Enable/disable SSL server certificate validation logging. Choices:
|
|
Enable/disable logging SSL negotiation. Choices:
|
|
Ssl server. |
|
Action based on client certificate request during the FTPS handshake. Choices:
|
|
Action based on received client certificate during the FTPS handshake. Choices:
|
|
Action based on client certificate request during the HTTPS handshake. Choices:
|
|
Action based on received client certificate during the HTTPS handshake. Choices:
|
|
SSL server ID. |
|
Action based on client certificate request during the IMAPS handshake. Choices:
|
|
Action based on received client certificate during the IMAPS handshake. Choices:
|
|
IPv4 address of the SSL server. |
|
Action based on client certificate request during the POP3S handshake. Choices:
|
|
Action based on received client certificate during the POP3S handshake. Choices:
|
|
Action based on client certificate request during the SMTPS handshake. Choices:
|
|
Action based on received client certificate during the SMTPS handshake. Choices:
|
|
Action based on client certificate request during an SSL protocol handshake. Choices:
|
|
Action based on received client certificate during an SSL protocol handshake. Choices:
|
|
Enable/disable logging of server certificate information. Choices:
|
|
Configure ALPN option. Choices:
|
|
Untrusted CA certificate used by SSL Inspection. |
|
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 |