fortios_vpn_ssl_client – Client 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 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
FortiOS Version Compatibility¶
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 |
v7.2.4 |
v7.4.0 |
|
fortios_vpn_ssl_client | 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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- vpn_ssl_client - Client. type: dict more...
- certificate - Certificate to offer to SSL-VPN server if it requests one. Source vpn.certificate.local.name. type: str more...
- class_id - Traffic class ID. Source firewall.traffic-class.class-id. type: int more...
- comment - Comment. type: str more...
- distance - Distance for routes added by SSL-VPN (1 - 255). type: int more...
- interface - SSL interface to send/receive traffic over. Source system.interface.name. type: str more...
- ipv4_subnets - IPv4 subnets that the client is protecting. Source firewall.address.name firewall.addrgrp.name. type: str more...
- ipv6_subnets - IPv6 subnets that the client is protecting. Source firewall.address6.name firewall.addrgrp6.name. type: str more...
- name - SSL-VPN tunnel name. type: str required: true more...
- peer - Authenticate peer"s certificate with the peer/peergrp. Source user.peer.name user.peergrp.name. type: str more...
- port - SSL-VPN server port. type: int more...
- priority - Priority for routes added by SSL-VPN (1 - 65535). type: int more...
- psk - Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x). type: str more...
- realm - Realm name configured on SSL-VPN server. type: str more...
- server - IPv4, IPv6 or DNS address of the SSL-VPN server. type: str more...
- source_ip - IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server. type: str more...
- status - Enable/disable this SSL-VPN client configuration. type: str choices: enable, disable more...
- user - Username to offer to the peer to authenticate the client. type: str 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: Client.
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: 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