fortinet.fortimanager.fmgr_vpn_ssl_settings module – Configure SSL VPN.
Note
This module is part of the fortinet.fortimanager collection (version 2.1.5).
You might already have this collection installed if you are using the ansible package.
It is not included in ansible-core.
To check whether it is installed, run ansible-galaxy collection list.
To install it, use: ansible-galaxy collection install fortinet.fortimanager.
To use it in a playbook, specify: fortinet.fortimanager.fmgr_vpn_ssl_settings.
New in version 2.10: of fortinet.fortimanager
Synopsis
This module is able to configure a FortiManager device.
Examples include all parameters and values which need to be adjusted to data sources before usage.
Parameters
Parameter |
Comments |
|---|---|
only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters Choices:
|
|
the parameter (device) in requested url |
|
Enable/Disable logging for task Choices:
|
|
The overridden method for the underlying Json RPC request Choices:
|
|
the rc codes list with which the conditions to fail will be overriden |
|
the rc codes list with which the conditions to succeed will be overriden |
|
the directive to create, update or delete an object Choices:
|
|
the parameter (vdom) in requested url |
|
the top level parameters set |
|
Force the SSL VPN security level. High allows only high. Medium allows medium and high. Low allows any. Choices:
|
|
Enable/disable checking of source IP for authentication session. Choices:
|
|
SSL VPN authentication timeout (1 - 259200 sec (3 days), 0 for no timeout). |
|
no description |
|
SSL VPN authentication method restriction. Choices:
|
|
SSL VPN cipher strength. Choices:
|
|
Enable/disable SSL VPN client certificate restrictive. Choices:
|
|
User groups. |
|
ID (0 - 4294967295). |
|
SSL VPN portal. |
|
SSL VPN realm. |
|
Source address of incoming traffic. |
|
Enable/disable negated source address match. Choices:
|
|
IPv6 source address of incoming traffic. |
|
Enable/disable negated source IPv6 address match. Choices:
|
|
SSL VPN source interface of incoming traffic. |
|
Name of user peer. |
|
User name. |
|
Enable/disable to auto-create static routes for the SSL VPN tunnel IP addresses. Choices:
|
|
no description Choices:
|
|
Enable/disable verification of referer field in HTTP request header. Choices:
|
|
Default SSL VPN portal. |
|
Compression level (0~9). |
|
Minimum amount of data that triggers compression (200 - 65535 bytes). |
|
DNS server 1. |
|
DNS server 2. |
|
DNS suffix used for SSL VPN clients. |
|
SSLVPN maximum DTLS hello timeout (10 - 60 sec, default = 10). |
|
DTLS maximum protocol version. Choices:
|
|
DTLS minimum protocol version. Choices:
|
|
Enable/disable DTLS to prevent eavesdropping, tampering, or message forgery. Choices:
|
|
Encode 2F sequence to forward slash in URLs. Choices:
|
|
Encrypt and store user passwords for SSL VPN web sessions. Choices:
|
|
Enable/disable only PKI users with two-factor authentication for SSL VPNs. Choices:
|
|
Forward the same, add, or remove HTTP header. Choices:
|
|
Add HSTS includeSubDomains response header. Choices:
|
|
Enable/disable to allow HTTP compression over SSL VPN tunnels. Choices:
|
|
Enable/disable SSL VPN support for HttpOnly cookies. Choices:
|
|
SSL VPN session is disconnected if an HTTP request body is not received within this time (1 - 60 sec, default = 20). |
|
SSL VPN session is disconnected if an HTTP request header is not received within this time (1 - 60 sec, default = 20). |
|
Enable/disable redirect of port 80 to SSL VPN port. Choices:
|
|
SSL VPN disconnects if idle for specified time in seconds. |
|
IPv6 DNS server 1. |
|
IPv6 DNS server 2. |
|
IPv6 WINS server 1. |
|
IPv6 WINS server 2. |
|
SSL VPN maximum login attempt times before block (0 - 10, default = 2, 0 = no limit). |
|
Time for which a user is blocked from logging in after too many failed login attempts (0 - 86400 sec, default = 60). |
|
SSLVPN maximum login timeout (10 - 180 sec, default = 30). |
|
SSL VPN access port (1 - 65535). |
|
Enable/disable, Enable means that if SSL VPN connections are allowed on an interface admin GUI connections are blocked on that… Choices:
|
|
Enable/disable to require client certificates for all SSL VPN users. Choices:
|
|
Enable/disable to allow SSL VPN sessions to bypass routing and bind to the incoming interface. Choices:
|
|
Name of the server certificate to be used for SSL VPNs. |
|
Source address of incoming traffic. |
|
Enable/disable negated source address match. Choices:
|
|
IPv6 source address of incoming traffic. |
|
Enable/disable negated source IPv6 address match. Choices:
|
|
SSL VPN source interface of incoming traffic. |
|
Enable/disable to allow client renegotiation by the server if the tunnel goes down. Choices:
|
|
Enable/disable insertion of empty fragment. Choices:
|
|
SSL maximum protocol version. Choices:
|
|
SSL minimum protocol version. Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
no description Choices:
|
|
Transform backward slashes to forward slashes in URLs. Choices:
|
|
Enable/disable tunnel connection without re-authorization if previous connection dropped. Choices:
|
|
Names of the IPv4 IP Pool firewall objects that define the IP addresses reserved for remote clients. |
|
Names of the IPv6 IP Pool firewall objects that define the IP addresses reserved for remote clients. |
|
Time out value to clean up user session after tunnel connection is dropped (1 - 255 sec, default=30). |
|
Enable/disable unsafe legacy re-negotiation. Choices:
|
|
Enable/disable to obscure the host name of the URL of the web browser display. Choices:
|
|
Name of user peer. |
|
WINS server 1. |
|
WINS server 2. |
|
Add HTTP X-Content-Type-Options header. Choices:
|
|
the adom to lock for FortiManager running in workspace mode, the value can be global and others including root |
|
the maximum time in seconds to wait for other user to release the workspace lock Default: 300 |
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 SSL VPN.
fmgr_vpn_ssl_settings:
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, ...]
device: <your own value>
vdom: <your own value>
vpn_ssl_settings:
algorithm: <value in [default, high, low, ...]>
auth-session-check-source-ip: <value in [disable, enable]>
auth-timeout: <value of integer>
authentication-rule:
-
auth: <value in [any, local, radius, ...]>
cipher: <value in [any, high, medium]>
client-cert: <value in [disable, enable]>
groups: <value of string>
id: <value of integer>
portal: <value of string>
realm: <value of string>
source-address: <value of string>
source-address-negate: <value in [disable, enable]>
source-address6: <value of string>
source-address6-negate: <value in [disable, enable]>
source-interface: <value of string>
user-peer: <value of string>
users: <value of string>
auto-tunnel-static-route: <value in [disable, enable]>
banned-cipher:
- RSA
- DH
- DHE
- ECDH
- ECDHE
- DSS
- ECDSA
- AES
- AESGCM
- CAMELLIA
- 3DES
- SHA1
- SHA256
- SHA384
- STATIC
check-referer: <value in [disable, enable]>
default-portal: <value of string>
deflate-compression-level: <value of integer>
deflate-min-data-size: <value of integer>
dns-server1: <value of string>
dns-server2: <value of string>
dns-suffix: <value of string>
dtls-hello-timeout: <value of integer>
dtls-max-proto-ver: <value in [dtls1-0, dtls1-2]>
dtls-min-proto-ver: <value in [dtls1-0, dtls1-2]>
dtls-tunnel: <value in [disable, enable]>
encode-2f-sequence: <value in [disable, enable]>
encrypt-and-store-password: <value in [disable, enable]>
force-two-factor-auth: <value in [disable, enable]>
header-x-forwarded-for: <value in [pass, add, remove]>
hsts-include-subdomains: <value in [disable, enable]>
http-compression: <value in [disable, enable]>
http-only-cookie: <value in [disable, enable]>
http-request-body-timeout: <value of integer>
http-request-header-timeout: <value of integer>
https-redirect: <value in [disable, enable]>
idle-timeout: <value of integer>
ipv6-dns-server1: <value of string>
ipv6-dns-server2: <value of string>
ipv6-wins-server1: <value of string>
ipv6-wins-server2: <value of string>
login-attempt-limit: <value of integer>
login-block-time: <value of integer>
login-timeout: <value of integer>
port: <value of integer>
port-precedence: <value in [disable, enable]>
reqclientcert: <value in [disable, enable]>
route-source-interface: <value in [disable, enable]>
servercert: <value of string>
source-address: <value of string>
source-address-negate: <value in [disable, enable]>
source-address6: <value of string>
source-address6-negate: <value in [disable, enable]>
source-interface: <value of string>
ssl-client-renegotiation: <value in [disable, enable]>
ssl-insert-empty-fragment: <value in [disable, enable]>
ssl-max-proto-ver: <value in [tls1-0, tls1-1, tls1-2, ...]>
ssl-min-proto-ver: <value in [tls1-0, tls1-1, tls1-2, ...]>
tlsv1-0: <value in [disable, enable]>
tlsv1-1: <value in [disable, enable]>
tlsv1-2: <value in [disable, enable]>
tlsv1-3: <value in [disable, enable]>
transform-backward-slashes: <value in [disable, enable]>
tunnel-connect-without-reauth: <value in [disable, enable]>
tunnel-ip-pools: <value of string>
tunnel-ipv6-pools: <value of string>
tunnel-user-session-timeout: <value of integer>
unsafe-legacy-renegotiation: <value in [disable, enable]>
url-obscuration: <value in [disable, enable]>
user-peer: <value of string>
wins-server1: <value of string>
wins-server2: <value of string>
x-content-type-options: <value in [disable, enable]>
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The full url requested Returned: always Sample: “/sys/login/user” |
|
The status of api request Returned: always Sample: 0 |
|
The descriptive message of the api response Returned: always Sample: “OK.” |
Authors
Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)