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

Note

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

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

Comments

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:

  • no ← (default)

  • yes

enable_log

boolean

Enable/Disable logging for task

Choices:

  • no ← (default)

  • yes

firewall_sslsshprofile

dictionary

the top level parameters set

allowlist

string

Enable/disable exempting servers by FortiGuard allowlist.

Choices:

  • disable

  • enable

block-blacklisted-certificates

string

Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blacklist.

Choices:

  • disable

  • enable

block-blocklisted-certificates

string

Enable/disable blocking SSL-based botnet communication by FortiGuard certificate blocklist.

Choices:

  • disable

  • enable

caname

string

CA certificate used by SSL Inspection.

comment

string

Optional comments.

dot

dictionary

no description

cert-validation-failure

string

Action based on certificate validation failure.

Choices:

  • allow

  • block

  • ignore

cert-validation-timeout

string

Action based on certificate validation timeout.

Choices:

  • allow

  • block

  • ignore

client-certificate

string

Action based on received client certificate.

Choices:

  • bypass

  • inspect

  • block

expired-server-cert

string

Action based on server certificate is expired.

Choices:

  • allow

  • block

  • ignore

proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established (not before).

Choices:

  • disable

  • enable

revoked-server-cert

string

Action based on server certificate is revoked.

Choices:

  • allow

  • block

  • ignore

sni-server-cert-check

string

Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.

Choices:

  • enable

  • strict

  • disable

status

string

Configure protocol inspection status.

Choices:

  • disable

  • deep-inspection

unsupported-ssl-cipher

string

Action based on the SSL cipher used being unsupported.

Choices:

  • block

  • allow

unsupported-ssl-negotiation

string

Action based on the SSL negotiation used being unsupported.

Choices:

  • block

  • allow

untrusted-server-cert

string

Action based on server certificate is not issued by a trusted CA.

Choices:

  • allow

  • block

  • ignore

ftps

dictionary

no description

cert-validation-failure

string

Action based on certificate validation failure.

Choices:

  • allow

  • block

  • ignore

cert-validation-timeout

string

Action based on certificate validation timeout.

Choices:

  • allow

  • block

  • ignore

client-certificate

string

Action based on received client certificate.

Choices:

  • bypass

  • inspect

  • block

expired-server-cert

string

Action based on server certificate is expired.

Choices:

  • allow

  • block

  • ignore

ports

integer

Ports to use for scanning (1 - 65535, default = 443).

revoked-server-cert

string

Action based on server certificate is revoked.

Choices:

  • allow

  • block

  • ignore

sni-server-cert-check

string

Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.

Choices:

  • disable

  • enable

  • strict

status

string

Configure protocol inspection status.

Choices:

  • disable

  • deep-inspection

unsupported-ssl-cipher

string

Action based on the SSL cipher used being unsupported.

Choices:

  • allow

  • block

unsupported-ssl-negotiation

string

Action based on the SSL negotiation used being unsupported.

Choices:

  • allow

  • block

untrusted-server-cert

string

Action based on server certificate is not issued by a trusted CA.

Choices:

  • allow

  • block

  • ignore

https

dictionary

no description

cert-probe-failure

string

Action based on certificate probe failure.

Choices:

  • block

  • allow

cert-validation-failure

string

Action based on certificate validation failure.

Choices:

  • allow

  • block

  • ignore

cert-validation-timeout

string

Action based on certificate validation timeout.

Choices:

  • allow

  • block

  • ignore

client-certificate

string

Action based on received client certificate.

Choices:

  • bypass

  • inspect

  • block

expired-server-cert

string

Action based on server certificate is expired.

Choices:

  • allow

  • block

  • ignore

ports

integer

Ports to use for scanning (1 - 65535, default = 443).

proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established (not before).

Choices:

  • disable

  • enable

revoked-server-cert

string

Action based on server certificate is revoked.

Choices:

  • allow

  • block

  • ignore

sni-server-cert-check

string

Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.

Choices:

  • disable

  • enable

  • strict

status

string

Configure protocol inspection status.

Choices:

  • disable

  • certificate-inspection

  • deep-inspection

unsupported-ssl-cipher

string

Action based on the SSL cipher used being unsupported.

Choices:

  • allow

  • block

unsupported-ssl-negotiation

string

Action based on the SSL negotiation used being unsupported.

Choices:

  • allow

  • block

untrusted-server-cert

string

Action based on server certificate is not issued by a trusted CA.

Choices:

  • allow

  • block

  • ignore

imaps

dictionary

no description

cert-validation-failure

string

Action based on certificate validation failure.

Choices:

  • allow

  • block

  • ignore

cert-validation-timeout

string

Action based on certificate validation timeout.

Choices:

  • allow

  • block

  • ignore

client-certificate

string

Action based on received client certificate.

Choices:

  • bypass

  • inspect

  • block

expired-server-cert

string

Action based on server certificate is expired.

Choices:

  • allow

  • block

  • ignore

ports

integer

Ports to use for scanning (1 - 65535, default = 443).

proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established (not before).

Choices:

  • disable

  • enable

revoked-server-cert

string

Action based on server certificate is revoked.

Choices:

  • allow

  • block

  • ignore

sni-server-cert-check

string

Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.

Choices:

  • disable

  • enable

  • strict

status

string

Configure protocol inspection status.

Choices:

  • disable

  • deep-inspection

unsupported-ssl-cipher

string

Action based on the SSL cipher used being unsupported.

Choices:

  • allow

  • block

unsupported-ssl-negotiation

string

Action based on the SSL negotiation used being unsupported.

Choices:

  • allow

  • block

untrusted-server-cert

string

Action based on server certificate is not issued by a trusted CA.

Choices:

  • allow

  • block

  • ignore

mapi-over-https

string

Enable/disable inspection of MAPI over HTTPS.

Choices:

  • disable

  • enable

name

string

Name.

pop3s

dictionary

no description

cert-validation-failure

string

Action based on certificate validation failure.

Choices:

  • allow

  • block

  • ignore

cert-validation-timeout

string

Action based on certificate validation timeout.

Choices:

  • allow

  • block

  • ignore

client-certificate

string

Action based on received client certificate.

Choices:

  • bypass

  • inspect

  • block

expired-server-cert

string

Action based on server certificate is expired.

Choices:

  • allow

  • block

  • ignore

ports

integer

Ports to use for scanning (1 - 65535, default = 443).

proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established (not before).

Choices:

  • disable

  • enable

revoked-server-cert

string

Action based on server certificate is revoked.

Choices:

  • allow

  • block

  • ignore

sni-server-cert-check

string

Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.

Choices:

  • disable

  • enable

  • strict

status

string

Configure protocol inspection status.

Choices:

  • disable

  • deep-inspection

unsupported-ssl-cipher

string

Action based on the SSL cipher used being unsupported.

Choices:

  • allow

  • block

unsupported-ssl-negotiation

string

Action based on the SSL negotiation used being unsupported.

Choices:

  • allow

  • block

untrusted-server-cert

string

Action based on server certificate is not issued by a trusted CA.

Choices:

  • allow

  • block

  • ignore

rpc-over-https

string

Enable/disable inspection of RPC over HTTPS.

Choices:

  • disable

  • enable

server-cert

string

Certificate used by SSL Inspection to replace server certificate.

server-cert-mode

string

Re-sign or replace the servers certificate.

Choices:

  • re-sign

  • replace

smtps

dictionary

no description

cert-validation-failure

string

Action based on certificate validation failure.

Choices:

  • allow

  • block

  • ignore

cert-validation-timeout

string

Action based on certificate validation timeout.

Choices:

  • allow

  • block

  • ignore

client-certificate

string

Action based on received client certificate.

Choices:

  • bypass

  • inspect

  • block

expired-server-cert

string

Action based on server certificate is expired.

Choices:

  • allow

  • block

  • ignore

ports

integer

Ports to use for scanning (1 - 65535, default = 443).

proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established (not before).

Choices:

  • disable

  • enable

revoked-server-cert

string

Action based on server certificate is revoked.

Choices:

  • allow

  • block

  • ignore

sni-server-cert-check

string

Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.

Choices:

  • disable

  • enable

  • strict

status

string

Configure protocol inspection status.

Choices:

  • disable

  • deep-inspection

unsupported-ssl-cipher

string

Action based on the SSL cipher used being unsupported.

Choices:

  • allow

  • block

unsupported-ssl-negotiation

string

Action based on the SSL negotiation used being unsupported.

Choices:

  • allow

  • block

untrusted-server-cert

string

Action based on server certificate is not issued by a trusted CA.

Choices:

  • allow

  • block

  • ignore

ssh

dictionary

no description

inspect-all

string

Level of SSL inspection.

Choices:

  • disable

  • deep-inspection

ports

integer

Ports to use for scanning (1 - 65535, default = 443).

proxy-after-tcp-handshake

string

Proxy traffic after the TCP 3-way handshake has been established (not before).

Choices:

  • disable

  • enable

ssh-algorithm

string

Relative strength of encryption algorithms accepted during negotiation.

Choices:

  • compatible

  • high-encryption

ssh-tun-policy-check

string

Enable/disable SSH tunnel policy check.

Choices:

  • disable

  • enable

status

string

Configure protocol inspection status.

Choices:

  • disable

  • deep-inspection

unsupported-version

string

Action based on SSH version being unsupported.

Choices:

  • block

  • bypass

ssl

dictionary

no description

cert-validation-failure

string

Action based on certificate validation failure.

Choices:

  • allow

  • block

  • ignore

cert-validation-timeout

string

Action based on certificate validation timeout.

Choices:

  • allow

  • block

  • ignore

client-certificate

string

Action based on received client certificate.

Choices:

  • bypass

  • inspect

  • block

expired-server-cert

string

Action based on server certificate is expired.

Choices:

  • allow

  • block

  • ignore

inspect-all

string

Level of SSL inspection.

Choices:

  • disable

  • certificate-inspection

  • deep-inspection

revoked-server-cert

string

Action based on server certificate is revoked.

Choices:

  • allow

  • block

  • ignore

sni-server-cert-check

string

Check the SNI in the client hello message with the CN or SAN fields in the returned server certificate.

Choices:

  • disable

  • enable

  • strict

unsupported-ssl-cipher

string

Action based on the SSL cipher used being unsupported.

Choices:

  • allow

  • block

unsupported-ssl-negotiation

string

Action based on the SSL negotiation used being unsupported.

Choices:

  • allow

  • block

untrusted-server-cert

string

Action based on server certificate is not issued by a trusted CA.

Choices:

  • allow

  • block

  • ignore

ssl-anomalies-log

string

Enable/disable logging SSL anomalies.

Choices:

  • disable

  • enable

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

Type of address object (IPv4 or IPv6) or FortiGuard category.

Choices:

  • fortiguard-category

  • address

  • address6

  • wildcard-fqdn

  • regex

wildcard-fqdn

string

Exempt servers by wildcard FQDN.

ssl-exemptions-log

string

Enable/disable logging SSL exemptions.

Choices:

  • disable

  • enable

ssl-negotiation-log

string

Enable/disable logging SSL negotiation.

Choices:

  • disable

  • enable

ssl-server

list / elements=string

Ssl-Server.

ftps-client-cert-request

string

Action based on client certificate request during the FTPS handshake.

Choices:

  • bypass

  • inspect

  • block

ftps-client-certificate

string

Action based on received client certificate during the FTPS handshake.

Choices:

  • bypass

  • inspect

  • block

https-client-cert-request

string

Action based on client certificate request during the HTTPS handshake.

Choices:

  • bypass

  • inspect

  • block

https-client-certificate

string

Action based on received client certificate during the HTTPS handshake.

Choices:

  • bypass

  • inspect

  • block

id

integer

SSL server ID.

imaps-client-cert-request

string

Action based on client certificate request during the IMAPS handshake.

Choices:

  • bypass

  • inspect

  • block

imaps-client-certificate

string

Action based on received client certificate during the IMAPS handshake.

Choices:

  • bypass

  • inspect

  • block

ip

string

IPv4 address of the SSL server.

pop3s-client-cert-request

string

Action based on client certificate request during the POP3S handshake.

Choices:

  • bypass

  • inspect

  • block

pop3s-client-certificate

string

Action based on received client certificate during the POP3S handshake.

Choices:

  • bypass

  • inspect

  • block

smtps-client-cert-request

string

Action based on client certificate request during the SMTPS handshake.

Choices:

  • bypass

  • inspect

  • block

smtps-client-certificate

string

Action based on received client certificate during the SMTPS handshake.

Choices:

  • bypass

  • inspect

  • block

ssl-other-client-cert-request

string

Action based on client certificate request during an SSL protocol handshake.

Choices:

  • bypass

  • inspect

  • block

ssl-other-client-certificate

string

Action based on received client certificate during an SSL protocol handshake.

Choices:

  • bypass

  • inspect

  • block

supported-alpn

string

Configure ALPN option.

Choices:

  • none

  • http1-1

  • http2

  • all

untrusted-caname

string

Untrusted CA certificate used by SSL Inspection.

use-ssl-server

string

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

proposed_method

string

The overridden method for the underlying Json RPC request

Choices:

  • update

  • set

  • add

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

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

  • 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: 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: ''
- 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]>

Return Values

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

Key

Description

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_message

string

The descriptive message of the api response

Returned: always

Sample: “OK.”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)