W3cubDocs

/Ansible

fortinet.fortios.fortios_system_sdn_vpn module – Configure public cloud VPN service in Fortinet’s FortiOS and FortiGate.

Note

This module is part of the fortinet.fortios collection (version 2.4.0).

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_system_sdn_vpn.

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 system feature and sdn_vpn 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

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • false ← (default)
  • true

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"

state

string / required

Indicates whether to create or remove the object.

Choices:

  • "present"
  • "absent"

system_sdn_vpn

dictionary

Configure public cloud VPN service.

bgp_as

integer

BGP Router AS number.

cgw_gateway

string

Public IP address of the customer gateway.

cgw_name

string

AWS customer gateway name to be created.

internal_interface

string

Internal interface with local subnet. Source system.interface.name.

local_cidr

string

Local subnet address and subnet mask.

name

string / required

Public cloud VPN name.

nat_traversal

string

Enable/disable use for NAT traversal. Please enable if your FortiGate device is behind a NAT/PAT device.

Choices:

  • "disable"
  • "enable"

psksecret

string

Pre-shared secret for PSK authentication. Auto-generated if not specified

remote_cidr

string

Remote subnet address and subnet mask.

remote_type

string

Type of remote device.

Choices:

  • "vgw"
  • "tgw"

routing_type

string

Type of routing.

Choices:

  • "static"
  • "dynamic"

sdn

string

SDN connector name. Source system.sdn-connector.name.

subnet_id

string

AWS subnet id for TGW route propagation.

tgw_id

string

Transit gateway id.

tunnel_interface

string

Tunnel interface with public IP. Source system.interface.name.

vgw_id

string

Virtual private gateway id.

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"

Notes

Note

  • Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks

Examples

- name: Configure public cloud VPN service.
  fortinet.fortios.fortios_system_sdn_vpn:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      system_sdn_vpn:
          bgp_as: "65000"
          cgw_gateway: "<your_own_value>"
          cgw_name: "<your_own_value>"
          internal_interface: "<your_own_value> (source system.interface.name)"
          local_cidr: "<your_own_value>"
          name: "default_name_8"
          nat_traversal: "disable"
          psksecret: "<your_own_value>"
          remote_cidr: "<your_own_value>"
          remote_type: "vgw"
          routing_type: "static"
          sdn: "<your_own_value> (source system.sdn-connector.name)"
          subnet_id: "<your_own_value>"
          tgw_id: "<your_own_value>"
          tunnel_interface: "<your_own_value> (source system.interface.name)"
          vgw_id: "<your_own_value>"

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)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_sdn_vpn_module.html