lix_fortinet.fortios.fortios_vpn_ssl_client (102.2.120) — module

Install collection

Install with ansible-galaxy collection install lix_fortinet.fortios:==102.2.120

Add to requirements.yml

  collections:
    - name: lix_fortinet.fortios
      version: 102.2.120

Description

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

• ansible>=2.9

Usage examples

Scanned by Steampunk Spotter

• Success
  Steampunk Spotter scan finished with no errors, warnings or hints.

- 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)"
        name: "default_name_8"
        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>"

Inputs

    
vdom:
    default: root
    description:
    - 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

state:
    choices:
    - present
    - absent
    description:
    - Indicates whether to create or remove the object.
    required: true
    type: str

enable_log:
    default: false
    description:
    - Enable/Disable logging for task.
    required: false
    type: bool

member_path:
    description:
    - 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.
    type: str

access_token:
    description:
    - Token-based authentication. Generated from GUI of Fortigate.
    required: false
    type: str

member_state:
    choices:
    - present
    - absent
    description:
    - Add or delete a member under specified attribute path.
    - When member_state is specified, the state option is ignored.
    type: str

vpn_ssl_client:
    default: null
    description:
    - Client.
    suboptions:
      certificate:
        description:
        - Certificate to offer to SSL-VPN server if it requests one. Source vpn.certificate.local.name.
        type: str
      class_id:
        description:
        - Traffic class ID. Source firewall.traffic-class.class-id.
        type: int
      comment:
        description:
        - Comment.
        type: str
      distance:
        description:
        - Distance for routes added by SSL-VPN (1 - 255).
        type: int
      interface:
        description:
        - SSL interface to send/receive traffic over. Source system.interface.name.
        type: str
      name:
        description:
        - SSL-VPN tunnel name.
        required: true
        type: str
      peer:
        description:
        - Authenticate peer"s certificate with the peer/peergrp. Source user.peer.name
          user.peergrp.name.
        type: str
      port:
        description:
        - SSL-VPN server port.
        type: int
      priority:
        description:
        - Priority for routes added by SSL-VPN (1 - 65535).
        type: int
      psk:
        description:
        - Pre-shared secret to authenticate with the server (ASCII string or hexadecimal
          encoded with a leading 0x).
        type: str
      realm:
        description:
        - Realm name configured on SSL-VPN server.
        type: str
      server:
        description:
        - IPv4, IPv6 or DNS address of the SSL-VPN server.
        type: str
      source_ip:
        description:
        - IPv4 or IPv6 address to use as a source for the SSL-VPN connection to the server.
        type: str
      status:
        choices:
        - enable
        - disable
        description:
        - Enable/disable this SSL-VPN client configuration.
        type: str
      user:
        description:
        - Username to offer to the peer to authenticate the client.
        type: str
    type: dict

Outputs

build:
  description: Build number of the fortigate image
  returned: always
  sample: '1547'
  type: str
http_method:
  description: Last method used to provision the content into FortiGate
  returned: always
  sample: PUT
  type: str
http_status:
  description: Last result given by FortiGate on last operation applied
  returned: always
  sample: '200'
  type: str
mkey:
  description: Master key (id) used in the last call to FortiGate
  returned: success
  sample: id
  type: str
name:
  description: Name of the table used to fulfill the request
  returned: always
  sample: urlfilter
  type: str
path:
  description: Path of the table used to fulfill the request
  returned: always
  sample: webfilter
  type: str
revision:
  description: Internal revision number
  returned: always
  sample: 17.0.2.10658
  type: str
serial:
  description: Serial number of the unit
  returned: always
  sample: FGVMEVYYQT3AB5352
  type: str
status:
  description: Indication of the operation's result
  returned: always
  sample: success
  type: str
vdom:
  description: Virtual domain used
  returned: always
  sample: root
  type: str
version:
  description: Version of the FortiGate
  returned: always
  sample: v5.6.3
  type: str