fortinet.fortios.fortios_system_cluster_sync module – Configure FortiGate Session Life Support Protocol (FGSP) session synchronization in Fortinet’s FortiOS and FortiGate.
Note
This module is part of the fortinet.fortios collection (version 2.3.8).
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_cluster_sync.
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 cluster_sync 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 |
|---|---|
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:
|
|
Indicates whether to create or remove the object. Choices:
|
|
Configure FortiGate Session Life Support Protocol (FGSP) session synchronization. |
|
List of interfaces to be turned down before session synchronization is complete. |
|
Interface name. Source system.interface.name. |
|
Heartbeat interval (1 - 10 sec). |
|
Lost heartbeat threshold (1 - 10). |
|
IKE heartbeat interval (1 - 60 secs). |
|
Enable/disable IKE HA monitor. Choices:
|
|
IKE HA monitor interval (10 - 300 secs). |
|
ESP jump ahead factor (1G - 10G pps equivalent). |
|
Enable/disable IPsec tunnel synchronization. Choices:
|
|
IP address of the interface on the peer unit that is used for the session synchronization link. |
|
VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd. Source system.vdom.name. |
|
Enable/disable IKE route announcement on the backup unit. Choices:
|
|
Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. |
|
Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custom services. |
|
Custom service destination port range. |
|
Custom service ID. see <a href=’#notes’>Notes</a>. |
|
Custom service source port range. |
|
Only sessions to this IPv4 address are synchronized. |
|
Only sessions to this IPv6 address are synchronized. |
|
Only sessions to this interface are synchronized. Source system.interface.name. |
|
Only sessions from this IPv4 address are synchronized. |
|
Only sessions from this IPv6 address are synchronized. |
|
Only sessions from this interface are synchronized. Source system.interface.name. |
|
Enable/disable IKE route announcement on the backup unit. Choices:
|
|
Sync ID. see <a href=’#notes’>Notes</a>. |
|
Sessions from these VDOMs are synchronized using this session synchronization configuration. |
|
VDOM name. Source system.vdom.name. |
|
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
We highly recommend using your own value as the sync_id instead of 0, while ‘0’ is a special placeholder that allows the backend to assign the latest available number for the object, it does have limitations. Please find more details in Q&A.
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
The module supports check_mode.
Examples
- name: Configure FortiGate Session Life Support Protocol (FGSP) session synchronization.
fortinet.fortios.fortios_system_cluster_sync:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
system_cluster_sync:
down_intfs_before_sess_sync:
-
name: "default_name_4 (source system.interface.name)"
hb_interval: "2"
hb_lost_threshold: "3"
ike_heartbeat_interval: "3"
ike_monitor: "enable"
ike_monitor_interval: "15"
ike_seqjump_speed: "10"
ipsec_tunnel_sync: "enable"
peerip: "<your_own_value>"
peervd: "<your_own_value> (source system.vdom.name)"
secondary_add_ipsec_routes: "enable"
session_sync_filter:
custom_service:
-
dst_port_range: "<your_own_value>"
id: "18"
src_port_range: "<your_own_value>"
dstaddr: "<your_own_value>"
dstaddr6: "<your_own_value>"
dstintf: "<your_own_value> (source system.interface.name)"
srcaddr: "<your_own_value>"
srcaddr6: "<your_own_value>"
srcintf: "<your_own_value> (source system.interface.name)"
slave_add_ike_routes: "enable"
sync_id: "<you_own_value>"
syncvd:
-
name: "default_name_29 (source system.vdom.name)"
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: |