fmgr_firewall_sslsshprofile_imaps – Configure IMAPS options.¶
New in version 2.0.0.
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.x and v7.x.
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
FortiManager Version Compatibility¶
6.0.0 |
|||||||||||
True | |||||||||||
6.2.0 |
6.2.1 |
6.2.2 |
6.2.3 |
6.2.5 |
6.2.6 |
6.2.7 |
6.2.8 |
6.2.9 |
6.2.10 |
||
True | True | True | True | True | True | True | True | True | True | ||
6.4.0 |
6.4.1 |
6.4.2 |
6.4.3 |
6.4.4 |
6.4.5 |
6.4.6 |
6.4.7 |
6.4.8 |
6.4.9 |
6.4.10 |
6.4.11 |
True | True | True | True | True | True | True | True | True | True | True | True |
7.0.0 |
7.0.1 |
7.0.2 |
7.0.3 |
7.0.4 |
7.0.5 |
7.0.6 |
7.0.7 |
||||
True | True | True | True | True | True | True | True | ||||
7.2.0 |
7.2.1 |
7.2.2 |
|||||||||
True | True | True | |||||||||
7.4.0 |
|||||||||||
True |
Parameters¶
- access_token -The token to access FortiManager without using username and password. type: str required: false
- 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
- 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
- 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
- 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
- adom - The parameter in requested url type: str required: true
- ssl-ssh-profile - The parameter in requested url type: str required: true
- firewall_sslsshprofile_imaps - Configure IMAPS options. 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...
- min-allowed-ssl-version - No description for the parameter type: str choices: [ssl-3.0, tls-1.0, tls-1.1, tls-1.2, tls-1.3] 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 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]>
unsupported-ssl-version: <value in [block, allow, inspect]>
min-allowed-ssl-version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
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:
- meta - The result of the request.returned: always type: dict
- 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_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least on parameter mpt supported by the current FortiManager version type: list 0