fortios_vpn_ocvpn – Configure Overlay Controller VPN settings in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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.4.0
Requirements¶
The below requirements are needed on the host that executes this module.
- ansible>=2.9.0
Parameters¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: False
- vdom - 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 default: root
- vpn_ocvpn - Configure Overlay Controller VPN settings. type: dict
- auto_discovery - Enable/disable auto-discovery shortcuts. type: str choices: enable, disable
- eap - Enable/disable EAP client authentication. type: str choices: enable, disable
- eap_users - EAP authentication user group. Source user.group.name. type: str
- forticlient_access - Configure FortiClient settings. type: dict
- auth_groups - FortiClient user authentication groups. type: list
- auth_group - Authentication user group for FortiClient access. Source user.group.name. type: str
- name - Group name. type: str required: True
- overlays - OCVPN overlays to allow access to. type: list
- overlay_name - Overlay name. Source vpn.ocvpn.overlays.overlay-name. type: str
- psksecret - Pre-shared secret for FortiClient PSK authentication (ASCII string or hexadecimal encoded with a leading 0x). type: str
- status - Enable/disable FortiClient to access OCVPN networks. type: str choices: enable, disable
- ip_allocation_block - Class B subnet reserved for private IP address assignment. type: str
- multipath - Enable/disable multipath redundancy. type: str choices: enable, disable
- nat - Enable/disable inter-overlay source NAT. type: str choices: enable, disable
- overlays - Network overlays to register with Overlay Controller VPN service. type: list
- assign_ip - Enable/disable mode-cfg address assignment. type: str choices: enable, disable
- inter_overlay - Allow or deny traffic from other overlays. type: str choices: allow, deny
- ipv4_end_ip - End of IPv4 range. type: str
- ipv4_start_ip - Start of IPv4 range. type: str
- overlay_name - Overlay name. type: str
- subnets - Internal subnets to register with OCVPN service. type: list
- id - ID. type: int required: True
- interface - LAN interface. Source system.interface.name. type: str
- subnet - IPv4 address and subnet mask. type: str
- type - Subnet type. type: str choices: subnet, interface
- poll_interval - Overlay Controller VPN polling interval. type: int
- role - Set device role. type: str choices: spoke, primary-hub, secondary-hub
- sdwan - Enable/disable adding OCVPN tunnels to SDWAN. type: str choices: enable, disable
- status - Enable/disable Overlay Controller cloud assisted VPN. type: str choices: enable, disable
- wan_interface - FortiGate WAN interfaces to use with OCVPN. type: list
- name - Interface name. Source system.interface.name. type: str required: True
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"
ip_allocation_block: "<your_own_value>"
multipath: "enable"
nat: "enable"
overlays:
-
assign_ip: "enable"
inter_overlay: "allow"
ipv4_end_ip: "<your_own_value>"
ipv4_start_ip: "<your_own_value>"
overlay_name: "<your_own_value>"
subnets:
-
id: "24"
interface: "<your_own_value> (source system.interface.name)"
subnet: "<your_own_value>"
type: "subnet"
poll_interval: "28"
role: "spoke"
sdwan: "enable"
status: "enable"
wan_interface:
-
name: "default_name_33 (source system.interface.name)"
Return Values¶
Common return values are documented: https://docs.ansible.com/ansible/latest/reference_appendices/common_return_values.html#common-return-values, the following are the fields unique to this module:
- build - Build number of the fortigate image returned: always type: str sample: 1547
- http_method - Last method used to provision the content into FortiGate returned: always type: str sample: PUT
- http_status - Last result given by FortiGate on last operation applied returned: always type: str sample: 200
- mkey - Master key (id) used in the last call to FortiGate returned: success type: str sample: id
- name - Name of the table used to fulfill the request returned: always type: str sample: urlfilter
- path - Path of the table used to fulfill the request returned: always type: str sample: webfilter
- revision - Internal revision number returned: always type: str sample: 17.0.2.10658
- serial - Serial number of the unit returned: always type: str sample: FGVMEVYYQT3AB5352
- status - Indication of the operation's result returned: always type: str sample: success
- vdom - Virtual domain used returned: always type: str sample: root
- version - Version of the FortiGate returned: always type: str sample: v5.6.3