fmgr_firewall_sslsshprofile_pop3s – Configure POP3S 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.

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 7.2.0
firewall_sslsshprofile_pop3s yes yes yes yes yes yes yes yes yes

Parameters

  • enable_log - Enable/Disable logging for task type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0 type: str required: 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
  • adom - The parameter in requested url type: str required: true
  • ssl-ssh-profile - The parameter in requested url type: str required: true
  • firewall_sslsshprofile_pop3s - no description type: dict
    • allow-invalid-server-cert - When enabled, allows SSL sessions whose server certificate validation failed. type: str choices: [disable, enable] more...
    • client-cert-request - Action based on client certificate request. type: str choices: [bypass, inspect, block] more...
    • ports - No description for the parameter type: int more...
    • status - Configure protocol inspection status. type: str choices: [disable, deep-inspection] more...
    • unsupported-ssl - Action based on the SSL encryption used being unsupported. type: str choices: [bypass, inspect, block] more...
    • untrusted-cert - Allow, ignore, or block the untrusted SSL session server certificate. type: str choices: [allow, block, ignore] more...
    • invalid-server-cert - Allow or block the invalid SSL session server certificate. type: str choices: [allow, block] 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...
    • untrusted-server-cert - Allow, ignore, or block the untrusted SSL session server certificate. type: str choices: [allow, block, ignore] more...
    • 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...
    • 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...
    • unsupported-ssl-version - Action based on the SSL version used being unsupported. type: str choices: [block, allow, inspect] 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: no description
     fmgr_firewall_sslsshprofile_pop3s:
        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_pop3s:
           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]>
           unsupported-ssl-version: <value in [block, allow, inspect]>

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.