fortios_firewall_ssl_setting – SSL proxy settings in Fortinet’s FortiOS and FortiGate.¶
New in version 2.0.0.
Synopsis¶
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify firewall_ssl feature and setting category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
FortiOS Version Compatibility¶
v6.0.0 |
v6.0.5 |
v6.0.11 |
v6.2.0 |
v6.2.3 |
v6.2.5 |
v6.2.7 |
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
v7.0.1 |
v7.0.2 |
v7.0.3 |
v7.0.4 |
v7.0.5 |
v7.0.6 |
v7.0.7 |
v7.0.8 |
v7.2.0 |
v7.2.1 |
v7.2.2 |
|
fortios_firewall_ssl_setting | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes | yes |
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- vdom - Virtual domain, among those defined previously. A vdom is a virtual instance of the FortiGate that can be configured and used as a different unit. type: str default: root
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- firewall_ssl_setting - SSL proxy settings. type: dict more...
- abbreviate_handshake - Enable/disable use of SSL abbreviated handshake. type: str choices: enable, disable more...
- cert_cache_capacity - Maximum capacity of the host certificate cache (0 - 500). type: int more...
- cert_cache_timeout - Time limit to keep certificate cache (1 - 120 min). type: int more...
- kxp_queue_threshold - Maximum length of the CP KXP queue. When the queue becomes full, the proxy switches cipher functions to the main CPU (0 - 512). type: int more...
- no_matching_cipher_action - Bypass or drop the connection when no matching cipher is found. type: str choices: bypass, drop more...
- proxy_connect_timeout - Time limit to make an internal connection to the appropriate proxy process (1 - 60 sec). type: int more...
- session_cache_capacity - Capacity of the SSL session cache (--Obsolete--) (1 - 1000). type: int more...
- session_cache_timeout - Time limit to keep SSL session state (1 - 60 min). type: int more...
- ssl_dh_bits - Bit-size of Diffie-Hellman (DH) prime used in DHE-RSA negotiation . type: str choices: 768, 1024, 1536, 2048 more...
- ssl_queue_threshold - Maximum length of the CP SSL queue. When the queue becomes full, the proxy switches cipher functions to the main CPU (0 - 512). type: int more...
- ssl_send_empty_frags - Enable/disable sending empty fragments to avoid attack on CBC IV (for SSL 3.0 and TLS 1.0 only). type: str choices: enable, disable more...
Examples¶
- hosts: fortigates
collections:
- fortinet.fortios
connection: httpapi
vars:
vdom: "root"
ansible_httpapi_use_ssl: yes
ansible_httpapi_validate_certs: no
ansible_httpapi_port: 443
tasks:
- name: SSL proxy settings.
fortios_firewall_ssl_setting:
vdom: "{{ vdom }}"
firewall_ssl_setting:
abbreviate_handshake: "enable"
cert_cache_capacity: "200"
cert_cache_timeout: "10"
kxp_queue_threshold: "16"
no_matching_cipher_action: "bypass"
proxy_connect_timeout: "30"
session_cache_capacity: "500"
session_cache_timeout: "20"
ssl_dh_bits: "768"
ssl_queue_threshold: "32"
ssl_send_empty_frags: "enable"
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:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3