fmgr_firewall_sslsshprofile – Configure SSL/SSH protocol options.

New in version 2.10.

Synopsis

  • This module is able to configure a FortiManager device.
  • Examples include all parameters and values need to be adjusted to data sources before usage.
  • Tested with FortiManager v6.0.0.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible>=2.9.0

FortiManager Version Compatibility


6.0.0 6.2.1 6.2.3 6.2.5 6.4.0 6.4.2 6.4.5 7.0.0
firewall_sslsshprofile yes yes yes yes yes yes yes yes

Parameters

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

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: fortimanager-inventory
  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
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        firewall_sslsshprofile:
           caname: <value of string>
           comment: <value of string>
           mapi-over-https: <value in [disable, enable]>
           name: <value of string>
           rpc-over-https: <value in [disable, enable]>
           server-cert: <value of string>
           server-cert-mode: <value in [re-sign, replace]>
           ssl-anomalies-log: <value in [disable, enable]>
           ssl-exempt:
             -
                 address: <value of string>
                 address6: <value of string>
                 fortiguard-category: <value of string>
                 id: <value of integer>
                 regex: <value of string>
                 type: <value in [fortiguard-category, address, address6, ...]>
                 wildcard-fqdn: <value of string>
           ssl-exemptions-log: <value in [disable, enable]>
           ssl-server:
             -
                 ftps-client-cert-request: <value in [bypass, inspect, block]>
                 https-client-cert-request: <value in [bypass, inspect, block]>
                 id: <value of integer>
                 imaps-client-cert-request: <value in [bypass, inspect, block]>
                 ip: <value of string>
                 pop3s-client-cert-request: <value in [bypass, inspect, block]>
                 smtps-client-cert-request: <value in [bypass, inspect, block]>
                 ssl-other-client-cert-request: <value in [bypass, inspect, block]>
                 ftps-client-certificate: <value in [bypass, inspect, block]>
                 https-client-certificate: <value in [bypass, inspect, block]>
                 imaps-client-certificate: <value in [bypass, inspect, block]>
                 pop3s-client-certificate: <value in [bypass, inspect, block]>
                 smtps-client-certificate: <value in [bypass, inspect, block]>
                 ssl-other-client-certificate: <value in [bypass, inspect, block]>
           untrusted-caname: <value of string>
           use-ssl-server: <value in [disable, enable]>
           whitelist: <value in [disable, enable]>
           block-blacklisted-certificates: <value in [disable, enable]>
           ssl-negotiation-log: <value in [disable, enable]>
           ftps:
              cert-validation-failure: <value in [allow, block, ignore]>
              cert-validation-timeout: <value in [allow, block, ignore]>
              client-certificate: <value in [bypass, inspect, block]>
              expired-server-cert: <value in [allow, block, ignore]>
              ports: <value of integer>
              revoked-server-cert: <value in [allow, block, ignore]>
              sni-server-cert-check: <value in [disable, enable, strict]>
              status: <value in [disable, deep-inspection]>
              unsupported-ssl-cipher: <value in [allow, block]>
              unsupported-ssl-negotiation: <value in [allow, block]>
              untrusted-server-cert: <value in [allow, block, ignore]>
           https:
              cert-validation-failure: <value in [allow, block, ignore]>
              cert-validation-timeout: <value in [allow, block, ignore]>
              client-certificate: <value in [bypass, inspect, block]>
              expired-server-cert: <value in [allow, block, ignore]>
              ports: <value of integer>
              proxy-after-tcp-handshake: <value in [disable, enable]>
              revoked-server-cert: <value in [allow, block, ignore]>
              sni-server-cert-check: <value in [disable, enable, strict]>
              status: <value in [disable, certificate-inspection, deep-inspection]>
              unsupported-ssl-cipher: <value in [allow, block]>
              unsupported-ssl-negotiation: <value in [allow, block]>
              untrusted-server-cert: <value in [allow, block, ignore]>
              cert-probe-failure: <value in [block, allow]>
           imaps:
              cert-validation-failure: <value in [allow, block, ignore]>
              cert-validation-timeout: <value in [allow, block, ignore]>
              client-certificate: <value in [bypass, inspect, block]>
              expired-server-cert: <value in [allow, block, ignore]>
              ports: <value of integer>
              proxy-after-tcp-handshake: <value in [disable, enable]>
              revoked-server-cert: <value in [allow, block, ignore]>
              sni-server-cert-check: <value in [disable, enable, strict]>
              status: <value in [disable, deep-inspection]>
              unsupported-ssl-cipher: <value in [allow, block]>
              unsupported-ssl-negotiation: <value in [allow, block]>
              untrusted-server-cert: <value in [allow, block, ignore]>
           pop3s:
              cert-validation-failure: <value in [allow, block, ignore]>
              cert-validation-timeout: <value in [allow, block, ignore]>
              client-certificate: <value in [bypass, inspect, block]>
              expired-server-cert: <value in [allow, block, ignore]>
              ports: <value of integer>
              proxy-after-tcp-handshake: <value in [disable, enable]>
              revoked-server-cert: <value in [allow, block, ignore]>
              sni-server-cert-check: <value in [disable, enable, strict]>
              status: <value in [disable, deep-inspection]>
              unsupported-ssl-cipher: <value in [allow, block]>
              unsupported-ssl-negotiation: <value in [allow, block]>
              untrusted-server-cert: <value in [allow, block, ignore]>
           smtps:
              cert-validation-failure: <value in [allow, block, ignore]>
              cert-validation-timeout: <value in [allow, block, ignore]>
              client-certificate: <value in [bypass, inspect, block]>
              expired-server-cert: <value in [allow, block, ignore]>
              ports: <value of integer>
              proxy-after-tcp-handshake: <value in [disable, enable]>
              revoked-server-cert: <value in [allow, block, ignore]>
              sni-server-cert-check: <value in [disable, enable, strict]>
              status: <value in [disable, deep-inspection]>
              unsupported-ssl-cipher: <value in [allow, block]>
              unsupported-ssl-negotiation: <value in [allow, block]>
              untrusted-server-cert: <value in [allow, block, ignore]>
           ssh:
              inspect-all: <value in [disable, deep-inspection]>
              ports: <value of integer>
              proxy-after-tcp-handshake: <value in [disable, enable]>
              ssh-algorithm: <value in [compatible, high-encryption]>
              ssh-tun-policy-check: <value in [disable, enable]>
              status: <value in [disable, deep-inspection]>
              unsupported-version: <value in [block, bypass]>
           ssl:
              cert-validation-failure: <value in [allow, block, ignore]>
              cert-validation-timeout: <value in [allow, block, ignore]>
              client-certificate: <value in [bypass, inspect, block]>
              expired-server-cert: <value in [allow, block, ignore]>
              inspect-all: <value in [disable, certificate-inspection, deep-inspection]>
              revoked-server-cert: <value in [allow, block, ignore]>
              sni-server-cert-check: <value in [disable, enable, strict]>
              unsupported-ssl-cipher: <value in [allow, block]>
              unsupported-ssl-negotiation: <value in [allow, block]>
              untrusted-server-cert: <value in [allow, block, ignore]>
           allowlist: <value in [disable, enable]>
           block-blocklisted-certificates: <value in [disable, enable]>
           dot:
              cert-validation-failure: <value in [allow, block, ignore]>
              cert-validation-timeout: <value in [allow, block, ignore]>
              client-certificate: <value in [bypass, inspect, block]>
              expired-server-cert: <value in [allow, block, ignore]>
              proxy-after-tcp-handshake: <value in [disable, enable]>
              revoked-server-cert: <value in [allow, block, ignore]>
              sni-server-cert-check: <value in [enable, strict, disable]>
              status: <value in [disable, deep-inspection]>
              unsupported-ssl-cipher: <value in [block, allow]>
              unsupported-ssl-negotiation: <value in [block, allow]>
              untrusted-server-cert: <value in [allow, block, ignore]>
           supported-alpn: <value in [none, http1-1, http2, ...]>

Return Values

Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:

  • request_url - The full url requested returned: always type: str sample: /sys/login/user
  • response_code - The status of api request returned: always type: int sample: 0
  • response_message - The descriptive message of the api response returned: always type: str sample: OK
  • response_data - The data body of the api response returned: optional type: list or dict

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.