Docs4dev
Docs
ansible / latest / collections / fortinet / fortios / fortios_vpn_ocvpn_module.html

fortinet.fortios.fortios_vpn_ocvpn – Configure Overlay Controller VPN settings in Fortinet’s FortiOS and FortiGate.

Note

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

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

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 feature and ocvpn 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 Choices/Defaults Comments
access_token
string
Token-based authentication. Generated from GUI of Fortigate.
enable_log
boolean
    Choices:
  • no ←
  • yes
Enable/Disable logging for task.
vdom
string
Default:
"root"
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.
vpn_ocvpn
dictionary
Configure Overlay Controller VPN settings.
auto_discovery
string
    Choices:
  • enable
  • disable
Enable/disable auto-discovery shortcuts.
eap
string
    Choices:
  • enable
  • disable
Enable/disable EAP client authentication.
eap_users
string
EAP authentication user group. Source user.group.name.
forticlient_access
dictionary
Configure FortiClient settings.
auth_groups
list / elements=string
FortiClient user authentication groups.
auth_group
string
Authentication user group for FortiClient access. Source user.group.name.
name
string / required
Group name.
overlays
list / elements=string
OCVPN overlays to allow access to.
overlay_name
string
Overlay name. Source vpn.ocvpn.overlays.overlay-name.
psksecret
string
Pre-shared secret for FortiClient PSK authentication (ASCII string or hexadecimal encoded with a leading 0x).
status
string
    Choices:
  • enable
  • disable
Enable/disable FortiClient to access OCVPN networks.
ha_alias
string
Hidden HA alias.
ip_allocation_block
string
Class B subnet reserved for private IP address assignment.
multipath
string
    Choices:
  • enable
  • disable
Enable/disable multipath redundancy.
nat
string
    Choices:
  • enable
  • disable
Enable/disable inter-overlay source NAT.
overlays
list / elements=string
Network overlays to register with Overlay Controller VPN service.
assign_ip
string
    Choices:
  • enable
  • disable
Enable/disable client address assignment.
id
integer / required
ID.
inter_overlay
string
    Choices:
  • allow
  • deny
Allow or deny traffic from other overlays.
ipv4_end_ip
string
End of client IPv4 range.
ipv4_start_ip
string
Start of client IPv4 range.
name
string
Overlay name.
overlay_name
string
Overlay name.
subnets
list / elements=string
Internal subnets to register with OCVPN service.
id
integer / required
ID.
interface
string
LAN interface. Source system.interface.name.
subnet
string
IPv4 address and subnet mask.
type
string
    Choices:
  • subnet
  • interface
Subnet type.
poll_interval
integer
Overlay Controller VPN polling interval.
role
string
    Choices:
  • spoke
  • primary-hub
  • secondary-hub
Set device role.
sdwan
string
    Choices:
  • enable
  • disable
Enable/disable adding OCVPN tunnels to SDWAN.
sdwan_zone
string
Set SD-WAN zone. Source system.sdwan.zone.name.
status
string
    Choices:
  • enable
  • disable
Enable/disable Overlay Controller cloud assisted VPN.
subnets
list / elements=string
Internal subnets to register with Overlay Controller VPN service.
id
integer / required
ID.
interface
string
LAN interface. Source system.interface.name.
subnet
string
IPv4 address and subnet mask.
type
string
    Choices:
  • subnet
  • interface
Subnet type.
wan_interface
list / elements=string
FortiGate WAN interfaces to use with OCVPN.
name
string / required
Interface name. Source system.interface.name.

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: Configure Overlay Controller VPN settings.
    fortios_vpn_ocvpn:
      vdom:  "{{ vdom }}"
      vpn_ocvpn:
        auto_discovery: "enable"
        eap: "enable"
        eap_users: "<your_own_value> (source user.group.name)"
        forticlient_access:
            auth_groups:
             -
                auth_group: "<your_own_value> (source user.group.name)"
                name: "default_name_9"
                overlays:
                 -
                    overlay_name: "<your_own_value> (source vpn.ocvpn.overlays.overlay-name)"
            psksecret: "<your_own_value>"
            status: "enable"
        ha_alias: "<your_own_value>"
        ip_allocation_block: "<your_own_value>"
        multipath: "enable"
        nat: "enable"
        overlays:
         -
            assign_ip: "enable"
            id:  "20"
            inter_overlay: "allow"
            ipv4_end_ip: "<your_own_value>"
            ipv4_start_ip: "<your_own_value>"
            name: "default_name_24"
            overlay_name: "<your_own_value>"
            subnets:
             -
                id:  "27"
                interface: "<your_own_value> (source system.interface.name)"
                subnet: "<your_own_value>"
                type: "subnet"
        poll_interval: "31"
        role: "spoke"
        sdwan: "enable"
        sdwan_zone: "<your_own_value> (source system.sdwan.zone.name)"
        status: "enable"
        subnets:
         -
            id:  "37"
            interface: "<your_own_value> (source system.interface.name)"
            subnet: "<your_own_value>"
            type: "subnet"
        wan_interface:
         -
            name: "default_name_42 (source system.interface.name)"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key Returned Description
build
string
always
Build number of the fortigate image

Sample:
1547
http_method
string
always
Last method used to provision the content into FortiGate

Sample:
PUT
http_status
string
always
Last result given by FortiGate on last operation applied

Sample:
200
mkey
string
success
Master key (id) used in the last call to FortiGate

Sample:
id
name
string
always
Name of the table used to fulfill the request

Sample:
urlfilter
path
string
always
Path of the table used to fulfill the request

Sample:
webfilter
revision
string
always
Internal revision number

Sample:
17.0.2.10658
serial
string
always
Serial number of the unit

Sample:
FGVMEVYYQT3AB5352
status
string
always
Indication of the operation's result

Sample:
success
vdom
string
always
Virtual domain used

Sample:
root
version
string
always
Version of the FortiGate

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)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_vpn_ocvpn_module.html