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

Note

This plugin is part of the fortinet.fortimanager collection (version 2.1.4).

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 version 2.10: of fortinet.fortimanager

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 Choices/Defaults Comments
adom
string / required
the parameter (adom) in requested url
bypass_validation
boolean
    Choices:
  • no ←
  • yes
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task
firewall_sslsshprofile
dictionary
the top level parameters set
allowlist
string
    Choices:
  • disable
  • enable
Enable/disable exempting servers by FortiGuard allowlist.
block-blacklisted-certificates
string
    Choices:
  • disable
  • enable
Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blacklist.
block-blocklisted-certificates
string
    Choices:
  • disable
  • enable
Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blocklist.
caname
string
CA certificate used by SSL Inspection.
comment
string
Optional comments.
dot
dictionary
no description
cert-validation-failure
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation failure.
cert-validation-timeout
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation timeout.
client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate.
expired-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is expired.
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
revoked-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is revoked.
sni-server-cert-check
string
    Choices:
  • enable
  • strict
  • disable
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.
status
string
    Choices:
  • disable
  • deep-inspection
Configure protocol inspection status.
unsupported-ssl-cipher
string
    Choices:
  • block
  • allow
Action based on the SSL cipher used being unsupported.
unsupported-ssl-negotiation
string
    Choices:
  • block
  • allow
Action based on the SSL negotiation used being unsupported.
untrusted-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is not issued by a trusted CA.
ftps
dictionary
no description
cert-validation-failure
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation failure.
cert-validation-timeout
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation timeout.
client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate.
expired-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is expired.
ports
integer
Ports to use for scanning (1 - 65535, default = 443).
revoked-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is revoked.
sni-server-cert-check
string
    Choices:
  • disable
  • enable
  • strict
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.
status
string
    Choices:
  • disable
  • deep-inspection
Configure protocol inspection status.
unsupported-ssl-cipher
string
    Choices:
  • allow
  • block
Action based on the SSL cipher used being unsupported.
unsupported-ssl-negotiation
string
    Choices:
  • allow
  • block
Action based on the SSL negotiation used being unsupported.
untrusted-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is not issued by a trusted CA.
https
dictionary
no description
cert-probe-failure
string
    Choices:
  • block
  • allow
Action based on certificate probe failure.
cert-validation-failure
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation failure.
cert-validation-timeout
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation timeout.
client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate.
expired-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is expired.
ports
integer
Ports to use for scanning (1 - 65535, default = 443).
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
revoked-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is revoked.
sni-server-cert-check
string
    Choices:
  • disable
  • enable
  • strict
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.
status
string
    Choices:
  • disable
  • certificate-inspection
  • deep-inspection
Configure protocol inspection status.
unsupported-ssl-cipher
string
    Choices:
  • allow
  • block
Action based on the SSL cipher used being unsupported.
unsupported-ssl-negotiation
string
    Choices:
  • allow
  • block
Action based on the SSL negotiation used being unsupported.
untrusted-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is not issued by a trusted CA.
imaps
dictionary
no description
cert-validation-failure
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation failure.
cert-validation-timeout
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation timeout.
client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate.
expired-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is expired.
ports
integer
Ports to use for scanning (1 - 65535, default = 443).
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
revoked-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is revoked.
sni-server-cert-check
string
    Choices:
  • disable
  • enable
  • strict
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.
status
string
    Choices:
  • disable
  • deep-inspection
Configure protocol inspection status.
unsupported-ssl-cipher
string
    Choices:
  • allow
  • block
Action based on the SSL cipher used being unsupported.
unsupported-ssl-negotiation
string
    Choices:
  • allow
  • block
Action based on the SSL negotiation used being unsupported.
untrusted-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is not issued by a trusted CA.
mapi-over-https
string
    Choices:
  • disable
  • enable
Enable/disable inspection of MAPI over HTTPS.
name
string
Name.
pop3s
dictionary
no description
cert-validation-failure
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation failure.
cert-validation-timeout
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation timeout.
client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate.
expired-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is expired.
ports
integer
Ports to use for scanning (1 - 65535, default = 443).
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
revoked-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is revoked.
sni-server-cert-check
string
    Choices:
  • disable
  • enable
  • strict
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.
status
string
    Choices:
  • disable
  • deep-inspection
Configure protocol inspection status.
unsupported-ssl-cipher
string
    Choices:
  • allow
  • block
Action based on the SSL cipher used being unsupported.
unsupported-ssl-negotiation
string
    Choices:
  • allow
  • block
Action based on the SSL negotiation used being unsupported.
untrusted-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is not issued by a trusted CA.
rpc-over-https
string
    Choices:
  • disable
  • enable
Enable/disable inspection of RPC over HTTPS.
server-cert
string
Certificate used by SSL Inspection to replace server certificate.
server-cert-mode
string
    Choices:
  • re-sign
  • replace
Re-sign or replace the servers certificate.
smtps
dictionary
no description
cert-validation-failure
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation failure.
cert-validation-timeout
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation timeout.
client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate.
expired-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is expired.
ports
integer
Ports to use for scanning (1 - 65535, default = 443).
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
revoked-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is revoked.
sni-server-cert-check
string
    Choices:
  • disable
  • enable
  • strict
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.
status
string
    Choices:
  • disable
  • deep-inspection
Configure protocol inspection status.
unsupported-ssl-cipher
string
    Choices:
  • allow
  • block
Action based on the SSL cipher used being unsupported.
unsupported-ssl-negotiation
string
    Choices:
  • allow
  • block
Action based on the SSL negotiation used being unsupported.
untrusted-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is not issued by a trusted CA.
ssh
dictionary
no description
inspect-all
string
    Choices:
  • disable
  • deep-inspection
Level of SSL inspection.
ports
integer
Ports to use for scanning (1 - 65535, default = 443).
proxy-after-tcp-handshake
string
    Choices:
  • disable
  • enable
Proxy traffic after the TCP 3-way handshake has been established (not before).
ssh-algorithm
string
    Choices:
  • compatible
  • high-encryption
Relative strength of encryption algorithms accepted during negotiation.
ssh-tun-policy-check
string
    Choices:
  • disable
  • enable
Enable/disable SSH tunnel policy check.
status
string
    Choices:
  • disable
  • deep-inspection
Configure protocol inspection status.
unsupported-version
string
    Choices:
  • block
  • bypass
Action based on SSH version being unsupported.
ssl
dictionary
no description
cert-validation-failure
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation failure.
cert-validation-timeout
string
    Choices:
  • allow
  • block
  • ignore
Action based on certificate validation timeout.
client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate.
expired-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is expired.
inspect-all
string
    Choices:
  • disable
  • certificate-inspection
  • deep-inspection
Level of SSL inspection.
revoked-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is revoked.
sni-server-cert-check
string
    Choices:
  • disable
  • enable
  • strict
Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.
unsupported-ssl-cipher
string
    Choices:
  • allow
  • block
Action based on the SSL cipher used being unsupported.
unsupported-ssl-negotiation
string
    Choices:
  • allow
  • block
Action based on the SSL negotiation used being unsupported.
untrusted-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Action based on server certificate is not issued by a trusted CA.
ssl-anomalies-log
string
    Choices:
  • disable
  • enable
Enable/disable logging SSL anomalies.
ssl-exempt
list / elements=string
Ssl-Exempt.
address
string
IPv4 address object.
address6
string
IPv6 address object.
fortiguard-category
string
FortiGuard category ID.
id
integer
ID number.
regex
string
Exempt servers by regular expression.
type
string
    Choices:
  • fortiguard-category
  • address
  • address6
  • wildcard-fqdn
  • regex
Type of address object (IPv4 or IPv6) or FortiGuard category.
wildcard-fqdn
string
Exempt servers by wildcard FQDN.
ssl-exemptions-log
string
    Choices:
  • disable
  • enable
Enable/disable logging SSL exemptions.
ssl-negotiation-log
string
    Choices:
  • disable
  • enable
Enable/disable logging SSL negotiation.
ssl-server
list / elements=string
Ssl-Server.
ftps-client-cert-request
string
    Choices:
  • bypass
  • inspect
  • block
Action based on client certificate request during the FTPS handshake.
ftps-client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate during the FTPS handshake.
https-client-cert-request
string
    Choices:
  • bypass
  • inspect
  • block
Action based on client certificate request during the HTTPS handshake.
https-client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate during the HTTPS handshake.
id
integer
SSL server ID.
imaps-client-cert-request
string
    Choices:
  • bypass
  • inspect
  • block
Action based on client certificate request during the IMAPS handshake.
imaps-client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate during the IMAPS handshake.
ip
string
IPv4 address of the SSL server.
pop3s-client-cert-request
string
    Choices:
  • bypass
  • inspect
  • block
Action based on client certificate request during the POP3S handshake.
pop3s-client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate during the POP3S handshake.
smtps-client-cert-request
string
    Choices:
  • bypass
  • inspect
  • block
Action based on client certificate request during the SMTPS handshake.
smtps-client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate during the SMTPS handshake.
ssl-other-client-cert-request
string
    Choices:
  • bypass
  • inspect
  • block
Action based on client certificate request during an SSL protocol handshake.
ssl-other-client-certificate
string
    Choices:
  • bypass
  • inspect
  • block
Action based on received client certificate during an SSL protocol handshake.
supported-alpn
string
    Choices:
  • none
  • http1-1
  • http2
  • all
Configure ALPN option.
untrusted-caname
string
Untrusted CA certificate used by SSL Inspection.
use-ssl-server
string
    Choices:
  • disable
  • enable
Enable/disable the use of SSL server table for SSL offloading.
whitelist
string
    Choices:
  • disable
  • enable
Enable/disable exempting servers by FortiGuard whitelist.
proposed_method
string
    Choices:
  • update
  • set
  • add
The overridden method for the underlying Json RPC request
rc_failed
list / elements=string
the rc codes list with which the conditions to fail will be overriden
rc_succeeded
list / elements=string
the rc codes list with which the conditions to succeed will be overriden
state
string / required
    Choices:
  • present
  • absent
the directive to create, update or delete an object
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
Default:
300
the maximum time in seconds to wait for other user to release the workspace lock

Notes

Note

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

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

  • To delete an object, use state absent directive.

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

Examples

- hosts: fortimanager00
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure SSL/SSH protocol options.
     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: fortimanager00
  gather_facts: no
  connection: httpapi
  collections:
    - fortinet.fortimanager
  vars:
    ansible_httpapi_use_ssl: True
    ansible_httpapi_validate_certs: False
    ansible_httpapi_port: 443
  tasks:
   - name: retrieve all the SSL/SSH protocol options
     fmgr_fact:
       facts:
           selector: 'firewall_sslsshprofile'
           params:
               adom: 'ansible'
               ssl-ssh-profile: ''

Return Values

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

Key Returned Description
request_url
string
always
The full url requested

Sample:
/sys/login/user
response_code
integer
always
The status of api request

response_message
string
always
The descriptive message of the api response

Sample:
OK.


Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)