fortinet.fortios.fortios_vpn_ssl_client module – Client in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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.fortios
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: fortinet.fortios.fortios_vpn_ssl_client
.
New in fortinet.fortios 2.0.0
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 client 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.15
Parameters
Parameter |
Comments |
---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
Member attribute path to operate on. Delimited by a slash character if there are more than one attribute. Parameter marked with member_path is legitimate for doing member operation. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Indicates whether to create or remove the object. Choices:
|
|
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. Default: |
|
Client. |
|
Certificate to offer to SSL-VPN server if it requests one. Source vpn.certificate.local.name. |
|
Traffic class ID. Source firewall.traffic-class.class-id. |
|
Comment. |
|
Distance for routes added by SSL-VPN (1 - 255). |
|
SSL interface to send/receive traffic over. Source system.interface.name. |
|
IPv4 subnets that the client is protecting. Source firewall.address.name firewall.addrgrp.name. |
|
IPv6 subnets that the client is protecting. Source firewall.address6.name firewall.addrgrp6.name. |
|
SSL-VPN tunnel name. |
|
Authenticate peer”s certificate with the peer/peergrp. Source user.peer.name user.peergrp.name. |
|
SSL-VPN server port. |
|
Priority for routes added by SSL-VPN (1 - 65535). |
|
Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x). |
|
Realm name configured on SSL-VPN server. |
|
IPv4, IPv6 or DNS address of the SSL-VPN server. |
|
IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server. |
|
Enable/disable this SSL-VPN client configuration. Choices:
|
|
Username to offer to the peer to authenticate the client. |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Client.
fortinet.fortios.fortios_vpn_ssl_client:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ssl_client:
certificate: "<your_own_value> (source vpn.certificate.local.name)"
class_id: "0"
comment: "Comment."
distance: "10"
interface: "<your_own_value> (source system.interface.name)"
ipv4_subnets: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
ipv6_subnets: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
name: "default_name_10"
peer: "<your_own_value> (source user.peer.name user.peergrp.name)"
port: "443"
priority: "1"
psk: "<your_own_value>"
realm: "<your_own_value>"
server: "192.168.100.40"
source_ip: "84.230.14.43"
status: "enable"
user: "<your_own_value>"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |