fmgr_firewall_sslsshprofile_sslserver – SSL servers.¶
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_sslserver | 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
- ssl-ssh-profile - The parameter in requested url type: str required: true
- firewall_sslsshprofile_sslserver - SSL servers. type: dict
- 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...
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: SSL servers.
fmgr_firewall_sslsshprofile_sslserver:
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>
state: <value in [present, absent]>
firewall_sslsshprofile_sslserver:
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]>
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