You are reading an unmaintained version of the Ansible documentation. Unmaintained Ansible versions can contain unfixed security vulnerabilities (CVE). Please upgrade to a maintained version. See the latest Ansible documentation.

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.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_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	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
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_ocvpn dictionary	Configure Overlay Controller VPN settings.
auto_discovery string	Enable/disable auto-discovery shortcuts. Choices: enable disable
auto_discovery_shortcut_mode string	Control deletion of child short-cut tunnels when the parent tunnel goes down. Choices: independent dependent
eap string	Enable/disable EAP client authentication. Choices: enable disable
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	Enable/disable FortiClient to access OCVPN networks. Choices: enable disable
ha_alias string	Hidden HA alias.
ip_allocation_block string	Class B subnet reserved for private IP address assignment.
multipath string	Enable/disable multipath redundancy. Choices: enable disable
nat string	Enable/disable inter-overlay source NAT. Choices: enable disable
overlays list / elements=string	Network overlays to register with Overlay Controller VPN service.
assign_ip string	Enable/disable client address assignment. Choices: enable disable
id integer / required	ID.
inter_overlay string	Allow or deny traffic from other overlays. Choices: allow deny
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	Subnet type. Choices: subnet interface
poll_interval integer	Overlay Controller VPN polling interval.
role string	Set device role. Choices: spoke primary-hub secondary-hub
sdwan string	Enable/disable adding OCVPN tunnels to SDWAN. Choices: enable disable
sdwan_zone string	Set SD-WAN zone. Source system.sdwan.zone.name.
status string	Enable/disable Overlay Controller cloud assisted VPN. Choices: enable disable
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	Subnet type. Choices: subnet interface
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

- collections:
  - fortinet.fortios
  connection: httpapi
  hosts: fortigate01
  vars:
    ansible_httpapi_port: 443
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    vdom: root
  tasks:
  - name: fortios_vpn_ocvpn
    fortios_vpn_ocvpn:
      vdom: root
      vpn_ocvpn:
        auto_discovery: enable
        eap: disable
        ip_allocation_block: 10.254.0.0 255.255.0.0
        multipath: enable
        nat: enable
        poll_interval: 30
        role: spoke
        sdwan: disable
        status: disable

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)