fortinet.fortimanager.fmgr_firewall_sslsshprofile_imaps – Configure IMAPS options.

Note

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

To install it use: ansible-galaxy collection install fortinet.fortimanager.

To use it in a playbook, specify: fortinet.fortimanager.fmgr_firewall_sslsshprofile_imaps.

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_imaps
dictionary
the top level parameters set
allow-invalid-server-cert
string
    Choices:
  • disable
  • enable
When enabled, allows SSL sessions whose server certificate validation failed.
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-cert-request
string
    Choices:
  • bypass
  • inspect
  • block
Action based on client certificate request.
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.
invalid-server-cert
string
    Choices:
  • allow
  • block
Allow or block the invalid SSL session server certificate.
ports
integer
no description
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
string
    Choices:
  • bypass
  • inspect
  • block
Action based on the SSL encryption used being unsupported.
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-cert
string
    Choices:
  • allow
  • block
  • ignore
Allow, ignore, or block the untrusted SSL session server certificate.
untrusted-server-cert
string
    Choices:
  • allow
  • block
  • ignore
Allow, ignore, or block the untrusted SSL session server certificate.
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
ssl-ssh-profile
string / required
the parameter (ssl-ssh-profile) in requested url
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: 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 IMAPS options.
     fmgr_firewall_sslsshprofile_imaps:
        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>
        ssl-ssh-profile: <your own value>
        firewall_sslsshprofile_imaps:
           allow-invalid-server-cert: <value in [disable, enable]>
           client-cert-request: <value in [bypass, inspect, block]>
           ports: <value of integer>
           status: <value in [disable, deep-inspection]>
           unsupported-ssl: <value in [bypass, inspect, block]>
           untrusted-cert: <value in [allow, block, ignore]>
           invalid-server-cert: <value in [allow, block]>
           sni-server-cert-check: <value in [disable, enable, strict]>
           untrusted-server-cert: <value in [allow, block, ignore]>
           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]>
           unsupported-ssl-cipher: <value in [allow, block]>
           unsupported-ssl-negotiation: <value in [allow, block]>

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)