community.fortios.fmgr_secprof_ssl_ssh module – Manage SSL and SSH security profiles in FortiManager
Note
This module is part of the community.fortios collection (version 1.0.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 community.fortios
.
To use it in a playbook, specify: community.fortios.fmgr_secprof_ssl_ssh
.
Parameters
Parameter |
Comments |
---|---|
The ADOM the configuration should belong to. Default: “root” |
|
CA certificate used by SSL Inspection. |
|
Optional comments. |
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
When enabled, allows SSL sessions whose server certificate validation failed. choice | disable | Disable setting. choice | enable | Enable setting. Choices:
|
|
Action based on client certificate request failure. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Ports to use for scanning (1 - 65535, default = 443). |
|
Configure protocol inspection status. choice | disable | Disable. choice | deep-inspection | Full SSL inspection. Choices:
|
|
Action based on the SSL encryption used being unsupported. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. choice | allow | Allow the untrusted server certificate. choice | block | Block the connection when an untrusted server certificate is detected. choice | ignore | Always take the server certificate as trusted. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
When enabled, allows SSL sessions whose server certificate validation failed. choice | disable | Disable setting. choice | enable | Enable setting. Choices:
|
|
Action based on client certificate request failure. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Ports to use for scanning (1 - 65535, default = 443). |
|
Configure protocol inspection status. choice | disable | Disable. choice | certificate-inspection | Inspect SSL handshake only. choice | deep-inspection | Full SSL inspection. Choices:
|
|
Action based on the SSL encryption used being unsupported. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. choice | allow | Allow the untrusted server certificate. choice | block | Block the connection when an untrusted server certificate is detected. choice | ignore | Always take the server certificate as trusted. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
When enabled, allows SSL sessions whose server certificate validation failed. choice | disable | Disable setting. choice | enable | Enable setting. Choices:
|
|
Action based on client certificate request failure. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Ports to use for scanning (1 - 65535, default = 443). |
|
Configure protocol inspection status. choice | disable | Disable. choice | deep-inspection | Full SSL inspection. Choices:
|
|
Action based on the SSL encryption used being unsupported. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. choice | allow | Allow the untrusted server certificate. choice | block | Block the connection when an untrusted server certificate is detected. choice | ignore | Always take the server certificate as trusted. Choices:
|
|
Enable/disable inspection of MAPI over HTTPS. choice | disable | Disable inspection of MAPI over HTTPS. choice | enable | Enable inspection of MAPI over HTTPS. Choices:
|
|
Sets one of three modes for managing the object. Allows use of soft-adds instead of overwriting existing values Choices:
|
|
Name. |
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
When enabled, allows SSL sessions whose server certificate validation failed. choice | disable | Disable setting. choice | enable | Enable setting. Choices:
|
|
Action based on client certificate request failure. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Ports to use for scanning (1 - 65535, default = 443). |
|
Configure protocol inspection status. choice | disable | Disable. choice | deep-inspection | Full SSL inspection. Choices:
|
|
Action based on the SSL encryption used being unsupported. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. choice | allow | Allow the untrusted server certificate. choice | block | Block the connection when an untrusted server certificate is detected. choice | ignore | Always take the server certificate as trusted. Choices:
|
|
Enable/disable inspection of RPC over HTTPS. choice | disable | Disable inspection of RPC over HTTPS. choice | enable | Enable inspection of RPC over HTTPS. Choices:
|
|
Certificate used by SSL Inspection to replace server certificate. |
|
Re-sign or replace the server’s certificate. choice | re-sign | Multiple clients connecting to multiple servers. choice | replace | Protect an SSL server. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
When enabled, allows SSL sessions whose server certificate validation failed. choice | disable | Disable setting. choice | enable | Enable setting. Choices:
|
|
Action based on client certificate request failure. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Ports to use for scanning (1 - 65535, default = 443). |
|
Configure protocol inspection status. choice | disable | Disable. choice | deep-inspection | Full SSL inspection. Choices:
|
|
Action based on the SSL encryption used being unsupported. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. choice | allow | Allow the untrusted server certificate. choice | block | Block the connection when an untrusted server certificate is detected. choice | ignore | Always take the server certificate as trusted. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Level of SSL inspection. choice | disable | Disable. choice | deep-inspection | Full SSL inspection. Choices:
|
|
Ports to use for scanning (1 - 65535, default = 443). |
|
Relative strength of encryption algorithms accepted during negotiation. choice | compatible | Allow a broader set of encryption algorithms for best compatibility. choice | high-encryption | Allow only AES-CTR, AES-GCM ciphers and high encryption algorithms. Choices:
|
|
Enable/disable SSH policy check. choice | disable | Disable SSH policy check. choice | enable | Enable SSH policy check. Choices:
|
|
Enable/disable SSH tunnel policy check. choice | disable | Disable SSH tunnel policy check. choice | enable | Enable SSH tunnel policy check. Choices:
|
|
Configure protocol inspection status. choice | disable | Disable. choice | deep-inspection | Full SSL inspection. Choices:
|
|
Action based on SSH version being unsupported. choice | block | Block. choice | bypass | Bypass. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
When enabled, allows SSL sessions whose server certificate validation failed. choice | disable | Disable setting. choice | enable | Enable setting. Choices:
|
|
Enable/disable logging SSL anomalies. choice | disable | Disable logging SSL anomalies. choice | enable | Enable logging SSL anomalies. Choices:
|
|
Action based on client certificate request failure. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
IPv4 address object. |
|
IPv6 address object. |
|
FortiGuard category ID. |
|
Exempt servers by regular expression. |
|
Type of address object (IPv4 or IPv6) or FortiGuard category. choice | fortiguard-category | FortiGuard category. choice | address | Firewall IPv4 address. choice | address6 | Firewall IPv6 address. choice | wildcard-fqdn | Fully Qualified Domain Name with wildcard characters. choice | regex | Regular expression FQDN. Choices:
|
|
Exempt servers by wildcard FQDN. |
|
Enable/disable logging SSL exemptions. choice | disable | Disable logging SSL exemptions. choice | enable | Enable logging SSL exemptions. Choices:
|
|
Level of SSL inspection. choice | disable | Disable. choice | certificate-inspection | Inspect SSL handshake only. choice | deep-inspection | Full SSL inspection. Choices:
|
|
EXPERTS ONLY! KNOWLEDGE OF FMGR JSON API IS REQUIRED! List of multiple child objects to be added. Expects a list of dictionaries. Dictionaries must use FortiManager API parameters, not the ansible ones listed below. If submitted, all other prefixed sub-parameters ARE IGNORED. This object is MUTUALLY EXCLUSIVE with its options. We expect that you know what you are doing with these list parameters, and are leveraging the JSON API Guide. WHEN IN DOUBT, USE THE SUB OPTIONS BELOW INSTEAD TO CREATE OBJECTS WITH MULTIPLE TASKS |
|
Action based on client certificate request failure during the FTPS handshake. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Action based on client certificate request failure during the HTTPS handshake. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Action based on client certificate request failure during the IMAPS handshake. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
IPv4 address of the SSL server. |
|
Action based on client certificate request failure during the POP3S handshake. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Action based on client certificate request failure during the SMTPS handshake. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Action based on client certificate request failure during an SSL protocol handshake. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Action based on the SSL encryption used being unsupported. choice | bypass | Bypass. choice | inspect | Inspect. choice | block | Block. Choices:
|
|
Allow, ignore, or block the untrusted SSL session server certificate. choice | allow | Allow the untrusted server certificate. choice | block | Block the connection when an untrusted server certificate is detected. choice | ignore | Always take the server certificate as trusted. Choices:
|
|
Untrusted CA certificate used by SSL Inspection. |
|
Enable/disable the use of SSL server table for SSL offloading. choice | disable | Don’t use SSL server configuration. choice | enable | Use SSL server configuration. Choices:
|
|
Enable/disable exempting servers by FortiGuard whitelist. choice | disable | Disable setting. choice | enable | Enable setting. Choices:
|
Notes
Note
Full Documentation at https://ftnt-ansible-docs.readthedocs.io/en/latest/.
Examples
- name: DELETE Profile
community.fortios.fmgr_secprof_ssl_ssh:
name: Ansible_SSL_SSH_Profile
mode: delete
- name: CREATE Profile
community.fortios.fmgr_secprof_ssl_ssh:
name: Ansible_SSL_SSH_Profile
comment: "Created by Ansible Module TEST"
mode: set
mapi_over_https: enable
rpc_over_https: enable
server_cert_mode: replace
ssl_anomalies_log: enable
ssl_exemptions_log: enable
use_ssl_server: enable
whitelist: enable
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
full API response, includes status code and message Returned: always |
Authors
Luke Weighall (@lweighall)
Andrew Welsh (@Ghilli3)
Jim Huber (@p4r4n0y1ng)