fortios_system_sdn_vpn – Configure public cloud VPN service in Fortinet’s FortiOS and FortiGate.
Added 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 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v7.6.1 -> v7.6.2
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
- state - Indicates whether to create or remove the object. type: str required: true choices: present, absent
- system_sdn_vpn - Configure public cloud VPN service. type: dict more...
- bgp_as - BGP Router AS number. type: int more...
- cgw_gateway - Public IP address of the customer gateway. type: str more...
- cgw_name - AWS customer gateway name to be created. type: str more...
- internal_interface - Internal interface with local subnet. Source system.interface.name. type: str more...
- local_cidr - Local subnet address and subnet mask. type: str more...
- name - Public cloud VPN name. type: str required: true more...
- nat_traversal - Enable/disable use for NAT traversal. Please enable if your FortiGate device is behind a NAT/PAT device. type: str choices: disable, enable more...
- psksecret - Pre-shared secret for PSK authentication. Auto-generated if not specified type: str more...
- remote_cidr - Remote subnet address and subnet mask. type: str more...
- remote_type - Type of remote device. type: str choices: vgw, tgw more...
- routing_type - Type of routing. type: str choices: static, dynamic more...
- sdn - SDN connector name. Source system.sdn-connector.name. type: str more...
- subnet_id - AWS subnet id for TGW route propagation. type: str more...
- tgw_id - Transit gateway id. type: str more...
- tunnel_interface - Tunnel interface with public IP. Source system.interface.name. type: str more...
- vgw_id - Virtual private gateway id. type: str more...
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: 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.