fortinet.fortios.fortios_vpn_ocvpn module – Configure Overlay Controller VPN settings 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_ocvpn.
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 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.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:
|
|
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: |
|
Configure Overlay Controller VPN settings. |
|
Enable/disable auto-discovery shortcuts. Choices:
|
|
Control deletion of child short-cut tunnels when the parent tunnel goes down. Choices:
|
|
Enable/disable EAP client authentication. Choices:
|
|
EAP authentication user group. Source user.group.name. |
|
Configure FortiClient settings. |
|
FortiClient user authentication groups. |
|
Authentication user group for FortiClient access. Source user.group.name. |
|
Group name. |
|
OCVPN overlays to allow access to. |
|
Overlay name. Source vpn.ocvpn.overlays.overlay-name. |
|
Pre-shared secret for FortiClient PSK authentication (ASCII string or hexadecimal encoded with a leading 0x). |
|
Enable/disable FortiClient to access OCVPN networks. Choices:
|
|
Hidden HA alias. |
|
Class B subnet reserved for private IP address assignment. |
|
Enable/disable multipath redundancy. Choices:
|
|
Enable/disable NAT support. Choices:
|
|
Network overlays to register with Overlay Controller VPN service. |
|
Enable/disable mode-cfg address assignment. Choices:
|
|
ID. |
|
Allow or deny traffic from other overlays. Choices:
|
|
End of IPv4 range. |
|
Start of IPv4 range. |
|
Overlay name. |
|
Overlay name. |
|
Internal subnets to register with OCVPN service. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
LAN interface. Source system.interface.name. |
|
IPv4 address and subnet mask. |
|
Subnet type. Choices:
|
|
Overlay Controller VPN polling interval. |
|
Set device role. Choices:
|
|
Enable/disable adding OCVPN tunnels to SD-WAN. Choices:
|
|
Set SD-WAN zone. Source system.sdwan.zone.name. |
|
Enable/disable Overlay Controller cloud assisted VPN. Choices:
|
|
Internal subnets to register with Overlay Controller VPN service. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
LAN interface. Source system.interface.name. |
|
IPv4 address and subnet mask. |
|
Subnet type. Choices:
|
|
FortiGate WAN interfaces to use with OCVPN. |
|
Interface name. Source system.interface.name. |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure Overlay Controller VPN settings.
fortinet.fortios.fortios_vpn_ocvpn:
vdom: "{{ vdom }}"
vpn_ocvpn:
auto_discovery: "enable"
auto_discovery_shortcut_mode: "independent"
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_10"
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: "21"
inter_overlay: "allow"
ipv4_end_ip: "<your_own_value>"
ipv4_start_ip: "<your_own_value>"
name: "default_name_25"
overlay_name: "<your_own_value>"
subnets:
-
id: "28"
interface: "<your_own_value> (source system.interface.name)"
subnet: "<your_own_value>"
type: "subnet"
poll_interval: "30"
role: "spoke"
sdwan: "enable"
sdwan_zone: "<your_own_value> (source system.sdwan.zone.name)"
status: "enable"
subnets:
-
id: "38"
interface: "<your_own_value> (source system.interface.name)"
subnet: "<your_own_value>"
type: "subnet"
wan_interface:
-
name: "default_name_43 (source system.interface.name)"
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: |