:source: fortios_vpn_ssl_settings.py
:orphan:
.. fortios_vpn_ssl_settings:
fortios_vpn_ssl_settings -- Configure Agentless VPN in Fortinet's FortiOS and FortiGate.
++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 2.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiGate or FortiOS (FOS) device by allowing the user to set and modify vpn_ssl feature and settings category. Examples include all parameters and values need to be adjusted to datasources before usage. Tested with FOS v6.0.0
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible>=2.16
Tips
----
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
-----------------------------
Supported Version Ranges: v6.0.0 -> v7.6.6
Parameters
----------
.. raw:: html
- 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
- vpn_ssl_settings - Configure Agentless VPN. type: dict
more...
| Supported Version Ranges |
| vpn_ssl_settings |
v6.0.0 -> 7.6.6 |
- algorithm - Force the Agentless VPN security level. High allows only high. Medium allows medium and high. Low allows any. type: str choices: high, medium, default, low
more...
|
Supported Version Ranges |
| algorithm |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
| [default] |
v6.0.0 -> 7.6.6 |
| [low] |
v6.0.0 -> 7.6.6 |
- auth_session_check_source_ip - Enable/disable checking of source IP for authentication session. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auth_session_check_source_ip |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- auth_timeout - Agentless VPN authentication timeout (1 - 259200 sec (3 days), 0 for no timeout). type: int
more...
|
Supported Version Ranges |
| auth_timeout |
v6.0.0 -> 7.6.6 |
- authentication_rule - Authentication rule for Agentless VPN. type: list member_path: authentication_rule:id
more...
| Supported Version Ranges |
| authentication_rule |
v6.0.0 -> 7.6.6 |
- auth - Agentless VPN authentication method restriction. type: str choices: any, local, radius, tacacs+, ldap, peer
more...
|
Supported Version Ranges |
| auth |
v6.0.0 -> 7.6.6 |
| [any] |
v6.0.0 -> 7.6.6 |
| [local] |
v6.0.0 -> 7.6.6 |
| [radius] |
v6.0.0 -> 7.6.6 |
| [tacacs+] |
v6.0.0 -> 7.6.6 |
| [ldap] |
v6.0.0 -> 7.6.6 |
| [peer] |
v7.0.1 -> 7.6.6 |
- cipher - Agentless VPN cipher strength. type: str choices: any, high, medium
more...
|
Supported Version Ranges |
| cipher |
v6.0.0 -> 7.6.6 |
| [any] |
v6.0.0 -> 7.6.6 |
| [high] |
v6.0.0 -> 7.6.6 |
| [medium] |
v6.0.0 -> 7.6.6 |
- client_cert - Enable/disable Agentless VPN client certificate restrictive. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| client_cert |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- groups - User groups. type: list member_path: authentication_rule:id/groups:name
more...
| Supported Version Ranges |
| groups |
v6.0.0 -> 7.6.6 |
- name - Group name. Source user.group.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- id - ID (0 - 4294967295). see Notes. type: int required: true
more...
|
Supported Version Ranges |
| id |
v6.0.0 -> 7.6.6 |
- portal - Agentless VPN portal. Source vpn.ssl.web.portal.name. type: str
more...
|
Supported Version Ranges |
| portal |
v6.0.0 -> 7.6.6 |
- realm - Agentless VPN realm. Source vpn.ssl.web.realm.url-path. type: str
more...
|
Supported Version Ranges |
| realm |
v6.0.0 -> 7.6.6 |
- source_address - Source address of incoming traffic. type: list member_path: authentication_rule:id/source_address:name
more...
| Supported Version Ranges |
| source_address |
v6.0.0 -> 7.6.6 |
- name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- source_address_negate - Enable/disable negated source address match. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| source_address_negate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- source_address6 - IPv6 source address of incoming traffic. type: list member_path: authentication_rule:id/source_address6:name
more...
| Supported Version Ranges |
| source_address6 |
v6.0.0 -> 7.6.6 |
- name - IPv6 address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- source_address6_negate - Enable/disable negated source IPv6 address match. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| source_address6_negate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- source_interface - Agentless VPN source interface of incoming traffic. type: list member_path: authentication_rule:id/source_interface:name
more...
| Supported Version Ranges |
| source_interface |
v6.0.0 -> 7.6.6 |
- name - Interface name. Source system.interface.name system.zone.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- user_peer - Name of user peer. Source user.peer.name. type: str
more...
|
Supported Version Ranges |
| user_peer |
v6.2.0 -> 7.6.6 |
- users - User name. type: list member_path: authentication_rule:id/users:name
more...
| Supported Version Ranges |
| users |
v6.0.0 -> 7.6.6 |
- name - User name. Source user.local.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- auto_tunnel_static_route - Enable/disable to auto-create static routes for the SSL-VPN tunnel IP addresses. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| auto_tunnel_static_route |
v6.0.0 -> v7.6.2 |
| [enable] |
v6.0.0 -> v7.6.2 |
| [disable] |
v6.0.0 -> v7.6.2 |
- banned_cipher - Select one or more cipher technologies that cannot be used in Agentless VPN negotiations. Only applies to TLS 1.2 and below. type: list choices: RSA, DHE, ECDHE, DSS, ECDSA, AES, AESGCM, CAMELLIA, 3DES, SHA1, SHA256, SHA384, STATIC, CHACHA20, ARIA, AESCCM, DH, ECDH
more...
|
Supported Version Ranges |
| banned_cipher |
v6.0.0 -> 7.6.6 |
| [RSA] |
v6.0.0 -> 7.6.6 |
| [DHE] |
v6.0.0 -> 7.6.6 |
| [ECDHE] |
v6.0.0 -> 7.6.6 |
| [DSS] |
v6.0.0 -> 7.6.6 |
| [ECDSA] |
v6.0.0 -> 7.6.6 |
| [AES] |
v6.0.0 -> 7.6.6 |
| [AESGCM] |
v6.0.0 -> 7.6.6 |
| [CAMELLIA] |
v6.0.0 -> 7.6.6 |
| [3DES] |
v6.0.0 -> 7.6.6 |
| [SHA1] |
v6.0.0 -> 7.6.6 |
| [SHA256] |
v6.0.0 -> 7.6.6 |
| [SHA384] |
v6.0.0 -> 7.6.6 |
| [STATIC] |
v6.0.0 -> 7.6.6 |
| [CHACHA20] |
v7.0.0 -> 7.6.6 |
| [ARIA] |
v7.0.0 -> 7.6.6 |
| [AESCCM] |
v7.0.0 -> 7.6.6 |
| [DH] |
v6.0.0 -> v6.0.11 |
| [ECDH] |
v6.0.0 -> v6.0.11 |
- browser_language_detection - Enable/disable overriding the configured system language based on the preferred language of the browser. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| browser_language_detection |
v7.2.0 -> 7.6.6 |
| [enable] |
v7.2.0 -> 7.6.6 |
| [disable] |
v7.2.0 -> 7.6.6 |
- check_referer - Enable/disable verification of referer field in HTTP request header. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| check_referer |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ciphersuite - Select one or more TLS 1.3 ciphersuites to enable. Does not affect ciphers in TLS 1.2 and below. At least one must be enabled. To disable all, set ssl-max-proto-ver to tls1-2 or below. type: list choices: TLS-AES-128-GCM-SHA256, TLS-AES-256-GCM-SHA384, TLS-CHACHA20-POLY1305-SHA256, TLS-AES-128-CCM-SHA256, TLS-AES-128-CCM-8-SHA256
more...
|
Supported Version Ranges |
| ciphersuite |
v7.0.0 -> 7.6.6 |
| [TLS-AES-128-GCM-SHA256] |
v7.0.0 -> 7.6.6 |
| [TLS-AES-256-GCM-SHA384] |
v7.0.0 -> 7.6.6 |
| [TLS-CHACHA20-POLY1305-SHA256] |
v7.0.0 -> 7.6.6 |
| [TLS-AES-128-CCM-SHA256] |
v7.0.0 -> 7.6.6 |
| [TLS-AES-128-CCM-8-SHA256] |
v7.0.0 -> 7.6.6 |
- client_sigalgs - Set signature algorithms related to client authentication. Affects TLS version <= 1.2 only. type: str choices: no-rsa-pss, all
more...
|
Supported Version Ranges |
| client_sigalgs |
v6.4.4 -> 7.6.6 |
| [no-rsa-pss] |
v6.4.4 -> 7.6.6 |
| [all] |
v6.4.4 -> 7.6.6 |
- default_portal - Default Agentless VPN portal. Source vpn.ssl.web.portal.name. type: str
more...
|
Supported Version Ranges |
| default_portal |
v6.0.0 -> 7.6.6 |
- deflate_compression_level - Compression level (0~9). type: int
more...
|
Supported Version Ranges |
| deflate_compression_level |
v6.0.0 -> 7.6.6 |
- deflate_min_data_size - Minimum amount of data that triggers compression (200 - 65535 bytes). type: int
more...
|
Supported Version Ranges |
| deflate_min_data_size |
v6.0.0 -> 7.6.6 |
- dns_server1 - DNS server 1. type: str
more...
|
Supported Version Ranges |
| dns_server1 |
v6.0.0 -> v7.6.2 |
- dns_server2 - DNS server 2. type: str
more...
|
Supported Version Ranges |
| dns_server2 |
v6.0.0 -> v7.6.2 |
- dns_suffix - DNS suffix used for Agentless VPN clients. type: str
more...
|
Supported Version Ranges |
| dns_suffix |
v6.0.0 -> 7.6.6 |
- dtls_heartbeat_fail_count - Number of missing heartbeats before the connection is considered dropped. type: int
more...
|
Supported Version Ranges |
| dtls_heartbeat_fail_count |
v7.4.0 -> 7.6.6 |
- dtls_heartbeat_idle_timeout - Idle timeout before DTLS heartbeat is sent. type: int
more...
|
Supported Version Ranges |
| dtls_heartbeat_idle_timeout |
v7.4.0 -> 7.6.6 |
- dtls_heartbeat_interval - Interval between DTLS heartbeat. type: int
more...
|
Supported Version Ranges |
| dtls_heartbeat_interval |
v7.4.0 -> 7.6.6 |
- dtls_hello_timeout - SSLVPN maximum DTLS hello timeout (10 - 60 sec). type: int
more...
|
Supported Version Ranges |
| dtls_hello_timeout |
v6.0.0 -> 7.6.6 |
- dtls_max_proto_ver - DTLS maximum protocol version. type: str choices: dtls1-0, dtls1-2
more...
|
Supported Version Ranges |
| dtls_max_proto_ver |
v6.2.0 -> v7.6.2 |
| [dtls1-0] |
v6.2.0 -> v7.6.2 |
| [dtls1-2] |
v6.2.0 -> v7.6.2 |
- dtls_min_proto_ver - DTLS minimum protocol version. type: str choices: dtls1-0, dtls1-2
more...
|
Supported Version Ranges |
| dtls_min_proto_ver |
v6.2.0 -> v7.6.2 |
| [dtls1-0] |
v6.2.0 -> v7.6.2 |
| [dtls1-2] |
v6.2.0 -> v7.6.2 |
- dtls_tunnel - Enable/disable DTLS to prevent eavesdropping, tampering, or message forgery. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dtls_tunnel |
v6.0.0 -> v7.6.2 |
| [enable] |
v6.0.0 -> v7.6.2 |
| [disable] |
v6.0.0 -> v7.6.2 |
- dual_stack_mode - Agentless web mode: support IPv4 and IPv6 bookmarks in the portal. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| dual_stack_mode |
v7.0.0 -> 7.6.6 |
| [enable] |
v7.0.0 -> 7.6.6 |
| [disable] |
v7.0.0 -> 7.6.6 |
- encode_2f_sequence - Encode 2F sequence to forward slash in URLs. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| encode_2f_sequence |
v6.2.0 -> v6.2.0 |
v6.2.5 -> 7.6.6 |
| [enable] |
v6.2.0 -> v6.2.0 |
| [disable] |
v6.2.0 -> v6.2.0 |
- encrypt_and_store_password - Encrypt and store user passwords for Agentless VPN web sessions. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| encrypt_and_store_password |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> 7.6.6 |
- force_two_factor_auth - Enable/disable only PKI users with two-factor authentication for Agentless VPNs. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| force_two_factor_auth |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- header_x_forwarded_for - Forward the same, add, or remove HTTP header. type: str choices: pass, add, remove
more...
|
Supported Version Ranges |
| header_x_forwarded_for |
v6.0.0 -> 7.6.6 |
| [pass] |
v6.0.0 -> 7.6.6 |
| [add] |
v6.0.0 -> 7.6.6 |
| [remove] |
v6.0.0 -> 7.6.6 |
- hsts_include_subdomains - Add HSTS includeSubDomains response header. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| hsts_include_subdomains |
v6.2.0 -> 7.6.6 |
| [enable] |
v6.2.0 -> 7.6.6 |
| [disable] |
v6.2.0 -> 7.6.6 |
- http_compression - Enable/disable to allow HTTP compression over Agentless VPN connections. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| http_compression |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- http_only_cookie - Enable/disable Agentless VPN support for HttpOnly cookies. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| http_only_cookie |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- http_request_body_timeout - Agentless VPN session is disconnected if an HTTP request body is not received within this time (1 - 60 sec). type: int
more...
|
Supported Version Ranges |
| http_request_body_timeout |
v6.0.0 -> 7.6.6 |
- http_request_header_timeout - Agentless VPN session is disconnected if an HTTP request header is not received within this time (1 - 60 sec). type: int
more...
|
Supported Version Ranges |
| http_request_header_timeout |
v6.0.0 -> 7.6.6 |
- https_redirect - Enable/disable redirect of port 80 to Agentless VPN port. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| https_redirect |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- idle_timeout - Agentless VPN disconnects if idle for specified time in seconds. type: int
more...
|
Supported Version Ranges |
| idle_timeout |
v6.0.0 -> 7.6.6 |
- ipv6_dns_server1 - IPv6 DNS server 1. type: str
more...
|
Supported Version Ranges |
| ipv6_dns_server1 |
v6.0.0 -> v7.6.2 |
- ipv6_dns_server2 - IPv6 DNS server 2. type: str
more...
|
Supported Version Ranges |
| ipv6_dns_server2 |
v6.0.0 -> v7.6.2 |
- ipv6_wins_server1 - IPv6 WINS server 1. type: str
more...
|
Supported Version Ranges |
| ipv6_wins_server1 |
v6.0.0 -> v7.6.2 |
- ipv6_wins_server2 - IPv6 WINS server 2. type: str
more...
|
Supported Version Ranges |
| ipv6_wins_server2 |
v6.0.0 -> v7.6.2 |
- login_attempt_limit - Agentless VPN maximum login attempt times before block (0 - 10). type: int
more...
|
Supported Version Ranges |
| login_attempt_limit |
v6.0.0 -> 7.6.6 |
- login_block_time - Time for which a user is blocked from logging in after too many failed login attempts (0 - 86400 sec). type: int
more...
|
Supported Version Ranges |
| login_block_time |
v6.0.0 -> 7.6.6 |
- login_timeout - Agentless VPN maximum login timeout (10 - 180 sec). type: int
more...
|
Supported Version Ranges |
| login_timeout |
v6.0.0 -> 7.6.6 |
- port - Agentless VPN access port (1 - 65535). type: int
more...
|
Supported Version Ranges |
| port |
v6.0.0 -> 7.6.6 |
- port_precedence - Enable/disable, Enable means that if Agentless VPN connections are allowed on an interface admin GUI connections are blocked on that interface. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| port_precedence |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- remote_https_cert_check - Configure how the FortiGate unit checks and responds to the remote HTTPS server"s certificate . type: str choices: no-check, warn-on-error, reject-on-error
more...
|
Supported Version Ranges |
| remote_https_cert_check |
v7.6.5 -> 7.6.6 |
| [no-check] |
v7.6.5 -> 7.6.6 |
| [warn-on-error] |
v7.6.5 -> 7.6.6 |
| [reject-on-error] |
v7.6.5 -> 7.6.6 |
- reqclientcert - Enable/disable to require client certificates for all Agentless VPN users. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| reqclientcert |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- route_source_interface - Enable to allow SSL-VPN sessions to bypass routing and bind to the incoming interface. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| route_source_interface |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- saml_redirect_port - SAML local redirect port in the machine running FortiClient (0 - 65535). 0 is to disable redirection on FGT side. type: int
more...
|
Supported Version Ranges |
| saml_redirect_port |
v7.0.1 -> v7.6.2 |
- server_hostname - Server hostname for HTTPS. When set, will be used for Agentless VPN web proxy host header for any redirection. type: str
more...
|
Supported Version Ranges |
| server_hostname |
v7.4.0 -> 7.6.6 |
- servercert - Name of the server certificate to be used for Agentless VPNs. Source vpn.certificate.local.name. type: str
more...
|
Supported Version Ranges |
| servercert |
v6.0.0 -> 7.6.6 |
- source_address - Source address of incoming traffic. type: list member_path: source_address:name
more...
| Supported Version Ranges |
| source_address |
v6.0.0 -> 7.6.6 |
- name - Address name. Source firewall.address.name firewall.addrgrp.name system.external-resource.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- source_address_negate - Enable/disable negated source address match. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| source_address_negate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- source_address6 - IPv6 source address of incoming traffic. type: list member_path: source_address6:name
more...
| Supported Version Ranges |
| source_address6 |
v6.0.0 -> 7.6.6 |
- name - IPv6 address name. Source firewall.address6.name firewall.addrgrp6.name system.external-resource.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- source_address6_negate - Enable/disable negated source IPv6 address match. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| source_address6_negate |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- source_interface - Agentless VPN source interface of incoming traffic. type: list member_path: source_interface:name
more...
| Supported Version Ranges |
| source_interface |
v6.0.0 -> 7.6.6 |
- name - Interface name. Source system.interface.name system.zone.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> 7.6.6 |
- ssl_client_renegotiation - Enable/disable to allow client renegotiation by the server if the tunnel goes down. type: str choices: disable, enable
more...
|
Supported Version Ranges |
| ssl_client_renegotiation |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
- ssl_insert_empty_fragment - Enable/disable insertion of empty fragment. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ssl_insert_empty_fragment |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ssl_max_proto_ver - SSL maximum protocol version. type: str choices: tls1-0, tls1-1, tls1-2, tls1-3
more...
|
Supported Version Ranges |
| ssl_max_proto_ver |
v6.2.0 -> 7.6.6 |
| [tls1-0] |
v6.2.0 -> 7.6.6 |
| [tls1-1] |
v6.2.0 -> 7.6.6 |
| [tls1-2] |
v6.2.0 -> 7.6.6 |
| [tls1-3] |
v6.2.0 -> 7.6.6 |
- ssl_min_proto_ver - SSL minimum protocol version. type: str choices: tls1-0, tls1-1, tls1-2, tls1-3
more...
|
Supported Version Ranges |
| ssl_min_proto_ver |
v6.2.0 -> 7.6.6 |
| [tls1-0] |
v6.2.0 -> 7.6.6 |
| [tls1-1] |
v6.2.0 -> 7.6.6 |
| [tls1-2] |
v6.2.0 -> 7.6.6 |
| [tls1-3] |
v6.2.0 -> 7.6.6 |
- status - Enable/disable Agentless VPN. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| status |
v7.0.1 -> 7.6.6 |
| [enable] |
v7.0.1 -> 7.6.6 |
| [disable] |
v7.0.1 -> 7.6.6 |
- tls_groups - Configure the supported groups for TLS negotiation. type: list choices: P-521, P-384, P-256, ML-KEM512, ML-KEM768, ML-KEM1024, P-384-MLKEM1024, P-256-MLKEM768, X25519-MLKEM768, X448, X25519, FFDHE2048, FFDHE3072, FFDHE4096, FFDHE6144, FFDHE8192
more...
|
Supported Version Ranges |
| tls_groups |
v7.6.5 -> 7.6.6 |
| [P-521] |
v7.6.5 -> 7.6.6 |
| [P-384] |
v7.6.5 -> 7.6.6 |
| [P-256] |
v7.6.5 -> 7.6.6 |
| [ML-KEM512] |
v7.6.5 -> 7.6.6 |
| [ML-KEM768] |
v7.6.5 -> 7.6.6 |
| [ML-KEM1024] |
v7.6.5 -> 7.6.6 |
| [P-384-MLKEM1024] |
v7.6.5 -> 7.6.6 |
| [P-256-MLKEM768] |
v7.6.5 -> 7.6.6 |
| [X25519-MLKEM768] |
v7.6.5 -> 7.6.6 |
| [X448] |
v7.6.5 -> 7.6.6 |
| [X25519] |
v7.6.5 -> 7.6.6 |
| [FFDHE2048] |
v7.6.5 -> 7.6.6 |
| [FFDHE3072] |
v7.6.5 -> 7.6.6 |
| [FFDHE4096] |
v7.6.5 -> 7.6.6 |
| [FFDHE6144] |
v7.6.5 -> 7.6.6 |
| [FFDHE8192] |
v7.6.5 -> 7.6.6 |
- tlsv1_0 - tlsv1-0 type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tlsv1_0 |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- tlsv1_1 - tlsv1-1 type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tlsv1_1 |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- tlsv1_2 - tlsv1-2 type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tlsv1_2 |
v6.0.0 -> v6.2.7 |
| [enable] |
v6.0.0 -> v6.2.7 |
| [disable] |
v6.0.0 -> v6.2.7 |
- tlsv1_3 - tlsv1-3 type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tlsv1_3 |
v6.2.0 -> v6.2.7 |
| [enable] |
v6.2.0 -> v6.2.7 |
| [disable] |
v6.2.0 -> v6.2.7 |
- transform_backward_slashes - Transform backward slashes to forward slashes in URLs. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| transform_backward_slashes |
v6.4.0 -> 7.6.6 |
| [enable] |
v6.4.0 -> 7.6.6 |
| [disable] |
v6.4.0 -> 7.6.6 |
- tunnel_addr_assigned_method - Method used for assigning address for tunnel. type: str choices: first-available, round-robin
more...
|
Supported Version Ranges |
| tunnel_addr_assigned_method |
v7.0.0 -> v7.6.2 |
| [first-available] |
v7.0.0 -> v7.6.2 |
| [round-robin] |
v7.0.0 -> v7.6.2 |
- tunnel_connect_without_reauth - Enable/disable tunnel connection without re-authorization if previous connection dropped. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| tunnel_connect_without_reauth |
v6.2.0 -> v7.6.2 |
| [enable] |
v6.2.0 -> v7.6.2 |
| [disable] |
v6.2.0 -> v7.6.2 |
- tunnel_ip_pools - Names of the IPv4 IP Pool firewall objects that define the IP addresses reserved for remote clients. type: list member_path: tunnel_ip_pools:name
more...
| Supported Version Ranges |
| tunnel_ip_pools |
v6.0.0 -> v7.6.2 |
- name - Address name. Source firewall.address.name firewall.addrgrp.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v7.6.2 |
- tunnel_ipv6_pools - Names of the IPv6 IP Pool firewall objects that define the IP addresses reserved for remote clients. type: list member_path: tunnel_ipv6_pools:name
more...
| Supported Version Ranges |
| tunnel_ipv6_pools |
v6.0.0 -> v7.6.2 |
- name - Address name. Source firewall.address6.name firewall.addrgrp6.name. type: str required: true
more...
|
Supported Version Ranges |
| name |
v6.0.0 -> v7.6.2 |
- tunnel_user_session_timeout - Number of seconds after which user sessions are cleaned up after tunnel connection is dropped (1 - 86400). type: int
more...
|
Supported Version Ranges |
| tunnel_user_session_timeout |
v6.2.0 -> v7.6.2 |
- unsafe_legacy_renegotiation - Enable/disable unsafe legacy re-negotiation. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| unsafe_legacy_renegotiation |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- url_obscuration - Enable/disable to obscure the host name of the URL of the web browser display. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| url_obscuration |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- user_peer - Name of user peer. Source user.peer.name. type: str
more...
|
Supported Version Ranges |
| user_peer |
v6.2.0 -> 7.6.6 |
- web_mode_snat - Enable/disable use of IP pools defined in firewall policy while using web-mode. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| web_mode_snat |
v7.0.6 -> v7.4.0 |
| [enable] |
v7.0.6 -> v7.4.0 |
| [disable] |
v7.0.6 -> v7.4.0 |
- wins_server1 - WINS server 1. type: str
more...
|
Supported Version Ranges |
| wins_server1 |
v6.0.0 -> v7.6.2 |
- wins_server2 - WINS server 2. type: str
more...
|
Supported Version Ranges |
| wins_server2 |
v6.0.0 -> v7.6.2 |
- x_content_type_options - Add HTTP X-Content-Type-Options header. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| x_content_type_options |
v6.0.0 -> 7.6.6 |
| [enable] |
v6.0.0 -> 7.6.6 |
| [disable] |
v6.0.0 -> 7.6.6 |
- ztna_trusted_client - Enable/disable verification of device certificate for SSLVPN ZTNA session. type: str choices: enable, disable
more...
|
Supported Version Ranges |
| ztna_trusted_client |
v7.2.1 -> v7.6.2 |
| [enable] |
v7.2.1 -> v7.6.2 |
| [disable] |
v7.2.1 -> v7.6.2 |
Notes
-----
.. note::
- Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
- The module supports check_mode.
Examples
--------
.. code-block:: yaml+jinja
- name: Configure Agentless VPN.
fortinet.fortios.fortios_vpn_ssl_settings:
vdom: "{{ vdom }}"
vpn_ssl_settings:
algorithm: "high"
auth_session_check_source_ip: "enable"
auth_timeout: "28800"
authentication_rule:
-
auth: "any"
cipher: "any"
client_cert: "enable"
groups:
-
name: "default_name_11 (source user.group.name)"
id: "12"
portal: " (source vpn.ssl.web.portal.name)"
realm: " (source vpn.ssl.web.realm.url-path)"
source_address:
-
name: "default_name_16 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
source_address_negate: "enable"
source_address6:
-
name: "default_name_19 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
source_address6_negate: "enable"
source_interface:
-
name: "default_name_22 (source system.interface.name system.zone.name)"
user_peer: " (source user.peer.name)"
users:
-
name: "default_name_25 (source user.local.name)"
auto_tunnel_static_route: "enable"
banned_cipher: "RSA"
browser_language_detection: "enable"
check_referer: "enable"
ciphersuite: "TLS-AES-128-GCM-SHA256"
client_sigalgs: "no-rsa-pss"
default_portal: " (source vpn.ssl.web.portal.name)"
deflate_compression_level: "6"
deflate_min_data_size: "300"
dns_server1: ""
dns_server2: ""
dns_suffix: ""
dtls_heartbeat_fail_count: "3"
dtls_heartbeat_idle_timeout: "3"
dtls_heartbeat_interval: "3"
dtls_hello_timeout: "10"
dtls_max_proto_ver: "dtls1-0"
dtls_min_proto_ver: "dtls1-0"
dtls_tunnel: "enable"
dual_stack_mode: "enable"
encode_2f_sequence: "enable"
encrypt_and_store_password: "enable"
force_two_factor_auth: "enable"
header_x_forwarded_for: "pass"
hsts_include_subdomains: "enable"
http_compression: "enable"
http_only_cookie: "enable"
http_request_body_timeout: "30"
http_request_header_timeout: "20"
https_redirect: "enable"
idle_timeout: "300"
ipv6_dns_server1: ""
ipv6_dns_server2: ""
ipv6_wins_server1: ""
ipv6_wins_server2: ""
login_attempt_limit: "2"
login_block_time: "60"
login_timeout: "30"
port: "10443"
port_precedence: "enable"
remote_https_cert_check: "no-check"
reqclientcert: "enable"
route_source_interface: "enable"
saml_redirect_port: "8020"
server_hostname: "myhostname"
servercert: " (source vpn.certificate.local.name)"
source_address:
-
name: "default_name_73 (source firewall.address.name firewall.addrgrp.name system.external-resource.name)"
source_address_negate: "enable"
source_address6:
-
name: "default_name_76 (source firewall.address6.name firewall.addrgrp6.name system.external-resource.name)"
source_address6_negate: "enable"
source_interface:
-
name: "default_name_79 (source system.interface.name system.zone.name)"
ssl_client_renegotiation: "disable"
ssl_insert_empty_fragment: "enable"
ssl_max_proto_ver: "tls1-0"
ssl_min_proto_ver: "tls1-0"
status: "enable"
tls_groups: "P-521"
tlsv1_0: "enable"
tlsv1_1: "enable"
tlsv1_2: "enable"
tlsv1_3: "enable"
transform_backward_slashes: "enable"
tunnel_addr_assigned_method: "first-available"
tunnel_connect_without_reauth: "enable"
tunnel_ip_pools:
-
name: "default_name_94 (source firewall.address.name firewall.addrgrp.name)"
tunnel_ipv6_pools:
-
name: "default_name_96 (source firewall.address6.name firewall.addrgrp6.name)"
tunnel_user_session_timeout: "30"
unsafe_legacy_renegotiation: "enable"
url_obscuration: "enable"
user_peer: " (source user.peer.name)"
web_mode_snat: "enable"
wins_server1: ""
wins_server2: ""
x_content_type_options: "enable"
ztna_trusted_client: "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:
.. raw:: html
- 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
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Link Zheng (@chillancezen)
- Jie Xue (@JieX19)
- Hongbin Lu (@fgtdev-hblu)
- Frank Shen (@frankshen01)
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
.. hint::
If you notice any issues in this documentation, you can create a pull request to improve it.