fortios_vpn_ocvpn – Configure Overlay Controller VPN settings in Fortinet’s FortiOS and FortiGate.
New in version 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.0.0 -> v7.2.4
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- vpn_ocvpn - Configure Overlay Controller VPN settings. type: dict more...
- auto_discovery - Enable/disable auto-discovery shortcuts. type: str choices: enable, disable more...
- auto_discovery_shortcut_mode - Control deletion of child short-cut tunnels when the parent tunnel goes down. type: str choices: independent, dependent more...
- eap - Enable/disable EAP client authentication. type: str choices: enable, disable more...
- eap_users - EAP authentication user group. Source user.group.name. type: str more...
- forticlient_access - Configure FortiClient settings. type: dict more...
- auth_groups - FortiClient user authentication groups. type: list member_path: forticlient_access/auth_groups:name more...
- auth_group - Authentication user group for FortiClient access. Source user.group.name. type: str more...
- name - Group name. type: str required: true more...
- overlays - OCVPN overlays to allow access to. type: list member_path: forticlient_access/auth_groups:name/overlays:overlay_name more...
- overlay_name - Overlay name. Source vpn.ocvpn.overlays.overlay-name. type: str required: true more...
- psksecret - Pre-shared secret for FortiClient PSK authentication (ASCII string or hexadecimal encoded with a leading 0x). type: str more...
- status - Enable/disable FortiClient to access OCVPN networks. type: str choices: enable, disable more...
- ha_alias - Hidden HA alias. type: str more...
- ip_allocation_block - Class B subnet reserved for private IP address assignment. type: str more...
- multipath - Enable/disable multipath redundancy. type: str choices: enable, disable more...
- nat - Enable/disable NAT support. type: str choices: enable, disable more...
- overlays - Network overlays to register with Overlay Controller VPN service. type: list member_path: overlays:overlay_name more...
- assign_ip - Enable/disable mode-cfg address assignment. type: str choices: enable, disable more...
- id - ID. type: int more...
- inter_overlay - Allow or deny traffic from other overlays. type: str choices: allow, deny more...
- ipv4_end_ip - End of IPv4 range. type: str more...
- ipv4_start_ip - Start of IPv4 range. type: str more...
- name - Overlay name. type: str more...
- overlay_name - Overlay name. type: str required: true more...
- subnets - Internal subnets to register with OCVPN service. type: list member_path: overlays:overlay_name/subnets:id more...
- poll_interval - Overlay Controller VPN polling interval. type: int more...
- role - Set device role. type: str choices: spoke, primary-hub, secondary-hub more...
- sdwan - Enable/disable adding OCVPN tunnels to SD-WAN. type: str choices: enable, disable more...
- sdwan_zone - Set SD-WAN zone. Source system.sdwan.zone.name. type: str more...
- status - Enable/disable Overlay Controller cloud assisted VPN. type: str choices: enable, disable more...
- subnets - Internal subnets to register with Overlay Controller VPN service. type: list member_path: subnets:id more...
- id - ID. see Notes. type: int required: true more...
- interface - LAN interface. Source system.interface.name. type: str more...
- subnet - IPv4 address and subnet mask. type: str more...
- type - Subnet type. type: str choices: subnet, interface more...
- wan_interface - FortiGate WAN interfaces to use with OCVPN. type: list member_path: wan_interface:name more...
- name - Interface name. Source system.interface.name. type: str required: true more...
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: 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
Status
This module is not guaranteed to have a backwards compatible interface.