fmgd_vpn_ocvpn – Configure Overlay Controller VPN settings.

Added in version 1.0.0.

Synopsis

  • This module is able to configure a FortiManager device.

  • Examples include all parameters and values need to be adjusted to data sources before usage.

  • Tested with FortiManager v7.x.

Requirements

The below requirements are needed on the host that executes this module.

  • ansible-core>=2.16.0

FortiManager Version Compatibility

Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest

Parameters

  • access_token -The token to access FortiManager without using username and password. type: str required: false
  • bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
  • enable_log - Enable/Disable logging for task. type: bool required: false default: False
  • forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
  • proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
  • rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
  • rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
  • workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
  • workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
  • device - The parameter in requested url type: str required: true
  • vdom - The parameter in requested url type: str required: true
  • vpn_ocvpn - Configure Overlay Controller VPN settings. type: dict
    • auto_discovery (Alias name: auto-discovery) Enable/disable auto-discovery shortcuts. type: str choices: [disable, enable] more...
    • auto_discovery_shortcut_mode (Alias name: 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: [disable, enable] more...
    • eap_users (Alias name: eap-users) Eap authentication user group. type: list more...
    • forticlient_access (Alias name: forticlient-access) Forticlient access. type: dict more...
      • auth_groups (Alias name: auth-groups) Auth groups. type: list more...
        • auth_group (Alias name: auth-group) Authentication user group for forticlient access. type: list more...
        • name Group name. type: str more...
        • overlays Ocvpn overlays to allow access to. type: list more...
      • psksecret Pre-shared secret for forticlient psk authentication (ascii string or hexadecimal encoded with a leading 0x). type: list more...
      • status Enable/disable forticlient to access ocvpn networks. type: str choices: [disable, enable] more...
    • ha_alias (Alias name: ha-alias) Hidden ha alias. type: str more...
    • ip_allocation_block (Alias name: ip-allocation-block) Class b subnet reserved for private ip address assignment. type: list more...
    • multipath Enable/disable multipath redundancy. type: str choices: [disable, enable] more...
    • nat Enable/disable nat support. type: str choices: [disable, enable] more...
    • overlays Overlays. type: list more...
      • inter_overlay (Alias name: inter-overlay) Allow or deny traffic from other overlays. type: str choices: [deny, allow] more...
      • overlay_name (Alias name: overlay-name) Overlay name. type: str more...
      • subnets Subnets. type: list more...
        • id Id. type: int more...
        • interface Lan interface. type: list more...
        • subnet Ipv4 address and subnet mask. type: list more...
        • type Subnet type. type: str choices: [subnet, interface] more...
      • ipv4_start_ip (Alias name: ipv4-start-ip) Start of ipv4 range. type: str more...
      • ipv4_end_ip (Alias name: ipv4-end-ip) End of ipv4 range. type: str more...
      • assign_ip (Alias name: assign-ip) Enable/disable mode-cfg address assignment. type: str choices: [disable, enable] more...
      • id Id. type: int more...
      • name Overlay name. type: str more...
    • poll_interval (Alias name: poll-interval) Overlay controller vpn polling interval. type: int more...
    • role Set device role. type: str choices: [spoke, primary-hub, secondary-hub, client] more...
    • sdwan Enable/disable adding ocvpn tunnels to sd-wan. type: str choices: [disable, enable] more...
    • sdwan_zone (Alias name: sdwan-zone) Set sd-wan zone. type: list more...
    • status Enable/disable overlay controller cloud assisted vpn. type: str choices: [disable, enable] more...
    • wan_interface (Alias name: wan-interface) Fortigate wan interfaces to use with ocvpn. type: list more...

Notes

Note

  • Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.

  • To create or update an object, use state: present directive.

  • To delete an object, use state: absent directive

  • Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded

Examples

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure Overlay Controller VPN settings.
      fortinet.fmgdevice.fmgd_vpn_ocvpn:
        # bypass_validation: false
        # workspace_locking_adom: <global or your adom name>
        # workspace_locking_timeout: 300
        # rc_succeeded: [0, -2, -3, ...]
        # rc_failed: [-2, -3, ...]
        device: <your own value>
        vdom: <your own value>
        vpn_ocvpn:
          # auto_discovery: <value in [disable, enable]>
          # auto_discovery_shortcut_mode: <value in [independent, dependent]>
          # eap: <value in [disable, enable]>
          # eap_users: <list or string>
          # forticlient_access:
          #   auth_groups:
          #     - auth_group: <list or string>
          #       name: <string>
          #       overlays: <list or string>
          #   psksecret: <list or string>
          #   status: <value in [disable, enable]>
          # ha_alias: <string>
          # ip_allocation_block: <list or string>
          # multipath: <value in [disable, enable]>
          # nat: <value in [disable, enable]>
          # overlays:
          #   - inter_overlay: <value in [deny, allow]>
          #     overlay_name: <string>
          #     subnets:
          #       - id: <integer>
          #         interface: <list or string>
          #         subnet: <list or string>
          #         type: <value in [subnet, interface]>
          #     ipv4_start_ip: <string>
          #     ipv4_end_ip: <string>
          #     assign_ip: <value in [disable, enable]>
          #     id: <integer>
          #     name: <string>
          # poll_interval: <integer>
          # role: <value in [spoke, primary-hub, secondary-hub, ...]>
          # sdwan: <value in [disable, enable]>
          # sdwan_zone: <list or string>
          # status: <value in [disable, enable]>
          # wan_interface: <list or string>

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:

  • meta - The result of the request.returned: always type: dict
    • request_url - The full url requested. returned: always type: str sample: /sys/login/user
    • response_code - The status of api request. returned: always type: int sample: 0
    • response_data - The data body of the api response. returned: optional type: list or dict
    • response_message - The descriptive message of the api response. returned: always type: str sample: OK
    • system_information - The information of the target system. returned: always type: dict
  • rc - The status the request. returned: always type: int sample: 0
  • version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list

Status

  • This module is not guaranteed to have a backwards compatible interface.

Authors

  • Xinwei Du (@dux-fortinet)

  • Xing Li (@lix-fortinet)

  • Jie Xue (@JieX19)

  • Link Zheng (@chillancezen)

  • Frank Shen (@fshen01)

  • Hongbin Lu (@fgtdev-hblu)