fortinet.fortios.fortios_vpn_ssl_client – clien in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.3).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_vpn_ssl_client.

New in version 2.10: of fortinet.fortios

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.9.0

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

member_path

string

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.

member_state

string

Add or delete a member under specified attribute path.

When member_state is specified, the state option is ignored.

Choices:

  • present

  • absent

state

string / required

Indicates whether to create or remove the object.

Choices:

  • present

  • absent

vdom

string

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: “root”

vpn_ssl_client

dictionary

client

certificate

string

Certificate to offer to SSL VPN server if it requests one. Source vpn.certificate.local.name.

comment

string

Comment.

distance

integer

Distance for routes added by SSL VPN (1 - 255).

interface

string

SSL interface to send/receive traffic over. Source system.interface.name.

name

string / required

SSL VPN tunnel name.

peer

string

Authenticate peer”s certificate with the peer/peergrp. Source user.peer.name user.peergrp.name.

port

integer

SSL VPN server port.

priority

integer

Priority for routes added by SSL VPN (0 - 4294967295).

psk

string

Pre-shared secret to authenticate with the server (ASCII string or hexadecimal encoded with a leading 0x).

realm

string

Realm name configured on SSL-VPN server.

server

string

IPv4, IPv6 or DNS address of the SSL VPN server.

source_ip

string

IPv4 or IPv6 address to use as a source for the SSL VPN connection to the server.

status

string

Enable/disable this SSL VPN client configuration.

Choices:

  • enable

  • disable

user

string

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

- 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)"
        comment: "Comment."
        distance: "5"
        interface: "<your_own_value> (source system.interface.name)"
        name: "default_name_7"
        peer: "<your_own_value> (source user.peer.name user.peergrp.name)"
        port: "9"
        priority: "10"
        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

string

Build number of the fortigate image

Returned: always

Sample: “1547”

http_method

string

Last method used to provision the content into FortiGate

Returned: always

Sample: “PUT”

http_status

string

Last result given by FortiGate on last operation applied

Returned: always

Sample: “200”

mkey

string

Master key (id) used in the last call to FortiGate

Returned: success

Sample: “id”

name

string

Name of the table used to fulfill the request

Returned: always

Sample: “urlfilter”

path

string

Path of the table used to fulfill the request

Returned: always

Sample: “webfilter”

revision

string

Internal revision number

Returned: always

Sample: “17.0.2.10658”

serial

string

Serial number of the unit

Returned: always

Sample: “FGVMEVYYQT3AB5352”

status

string

Indication of the operation’s result

Returned: always

Sample: “success”

vdom

string

Virtual domain used

Returned: always

Sample: “root”

version

string

Version of the FortiGate

Returned: always

Sample: “v5.6.3”

Authors

  • Link Zheng (@chillancezen)

  • Jie Xue (@JieX19)

  • Hongbin Lu (@fgtdev-hblu)

  • Frank Shen (@frankshen01)

  • Miguel Angel Munoz (@mamunozgonzalez)

  • Nicolas Thomas (@thomnico)