fortinet.fortios.fortios_system_fabric_vpn module – Setup for self orchestrated fabric auto discovery VPN in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.4).
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_fabric_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 fabric_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.14
Parameters
Parameter |
Comments |
|---|---|
Token-based authentication. Generated from GUI of Fortigate. |
|
Enable/Disable logging for task. Choices:
|
|
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. |
|
Add or delete a member under specified attribute path. When member_state is specified, the state option is ignored. Choices:
|
|
Setup for self orchestrated fabric auto discovery VPN. |
|
Local advertised subnets. |
|
Access policy direction. Choices:
|
|
Underlying BGP network. Source router.bgp.network.id. |
|
Underlying firewall address. Source firewall.address.name. |
|
ID. see <a href=’#notes’>Notes</a>. |
|
Underlying policies. Source firewall.policy.policyid. |
|
Network prefix. |
|
BGP Router AS number, valid from 1 to 4294967295. |
|
Branch name. |
|
Underlying health checks. Source system.sdwan.health-check.name. |
|
IPv4 address and subnet mask for hub”s loopback address, syntax: X.X.X.X/24. |
|
Loopback advertised subnet reference. Source system.fabric-vpn.advertised-subnets.id. |
|
Loopback interface. Source system.interface.name. |
|
Local overlay interfaces table. |
|
Underlying BGP neighbor entry. Source router.bgp.neighbor.ip. |
|
Underlying BGP neighbor group entry. Source router.bgp.neighbor-group.name. |
|
Underlying BGP neighbor range entry. Source router.bgp.neighbor-range.id. |
|
Underlying BGP network. Source router.bgp.network.id. |
|
Underlying interface name. Source system.interface.name. |
|
IPsec interface. Source vpn.ipsec.phase1-interface.name. |
|
Overlay name. |
|
The overlay policy to allow ADVPN thru traffic. Source firewall.policy.policyid. |
|
IPv4 address and subnet mask for the overlay tunnel , syntax: X.X.X.X/24. |
|
IP address of the hub gateway (Set by hub). |
|
Underlying router policy. Source router.policy.seq-num. |
|
Reference to SD-WAN member entry. Source system.sdwan.members.seq-num. |
|
Policy creation rule. Choices:
|
|
Pre-shared secret for ADVPN. |
|
Reference to created SD-WAN zone. Source system.sdwan.zone.name. |
|
Enable/disable Fabric VPN. Choices:
|
|
Setting synchronised by fabric or manual. Choices:
|
|
Fabric VPN role. Choices:
|
|
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: |
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
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: Setup for self orchestrated fabric auto discovery VPN.
fortios_system_fabric_vpn:
vdom: "{{ vdom }}"
system_fabric_vpn:
advertised_subnets:
-
access: "inbound"
bgp_network: "0"
firewall_address: "<your_own_value> (source firewall.address.name)"
id: "7"
policies: "<your_own_value> (source firewall.policy.policyid)"
prefix: "<your_own_value>"
bgp_as: "0"
branch_name: "<your_own_value>"
health_checks: "<your_own_value> (source system.sdwan.health-check.name)"
loopback_address_block: "<your_own_value>"
loopback_advertised_subnet: "0"
loopback_interface: "<your_own_value> (source system.interface.name)"
overlays:
-
bgp_neighbor: "<your_own_value> (source router.bgp.neighbor.ip)"
bgp_neighbor_group: "<your_own_value> (source router.bgp.neighbor-group.name)"
bgp_neighbor_range: "0"
bgp_network: "0"
interface: "<your_own_value> (source system.interface.name)"
ipsec_phase1: "<your_own_value> (source vpn.ipsec.phase1-interface.name)"
name: "default_name_23"
overlay_policy: "0"
overlay_tunnel_block: "<your_own_value>"
remote_gw: "<your_own_value>"
route_policy: "0"
sdwan_member: "0"
policy_rule: "health-check"
psksecret: "<your_own_value>"
sdwan_zone: "<your_own_value> (source system.sdwan.zone.name)"
status: "enable"
sync_mode: "enable"
vpn_role: "hub"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
Build number of the fortigate image Returned: always Sample: |
|
Last method used to provision the content into FortiGate Returned: always Sample: |
|
Last result given by FortiGate on last operation applied Returned: always Sample: |
|
Master key (id) used in the last call to FortiGate Returned: success Sample: |
|
Name of the table used to fulfill the request Returned: always Sample: |
|
Path of the table used to fulfill the request Returned: always Sample: |
|
Internal revision number Returned: always Sample: |
|
Serial number of the unit Returned: always Sample: |
|
Indication of the operation’s result Returned: always Sample: |
|
Virtual domain used Returned: always Sample: |
|
Version of the FortiGate Returned: always Sample: |