fortinet.fortios.fortios_system_cluster_sync – Configure FortiGate Session Life Support Protocol (FGSP) session synchronization in Fortinet’s FortiOS and FortiGate.

Note

This plugin is part of the fortinet.fortios collection (version 2.1.2).

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.

To use it in a playbook, specify: fortinet.fortios.fortios_system_cluster_sync.

New in version 2.10: of fortinet.fortios

Synopsis
Requirements
Parameters
Notes
Examples
Return Values

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

Parameters

Parameter				Choices/Defaults	Comments
access_token string					Token-based authentication. Generated from GUI of Fortigate.
enable_log boolean				Choices: no ← yes	Enable/Disable logging for task.
state string / required				Choices: present absent	Indicates whether to create or remove the object.
system_cluster_sync dictionary					Configure FortiGate Session Life Support Protocol (FGSP) session synchronization.
	down_intfs_before_sess_sync list / elements=string				List of interfaces to be turned down before session synchronization is complete.
		name string / required			Interface name. Source system.interface.name.
	hb_interval integer				Heartbeat interval (1 - 10 sec).
	hb_lost_threshold integer				Lost heartbeat threshold (1 - 10).
	ike_heartbeat_interval integer				IKE heartbeat interval (1 - 60 secs).
	ike_monitor string			Choices: enable disable	Enable/disable IKE HA monitor.
	ike_monitor_interval integer				IKE HA monitor interval (10 - 300 secs).
	ike_seqjump_speed integer				ESP jump ahead factor (1G - 10G pps equivalent).
	ipsec_tunnel_sync string			Choices: enable disable	Enable/disable IPsec tunnel synchronization.
	peerip string				IP address of the interface on the peer unit that is used for the session synchronization link.
	peervd string				VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd. Source system.vdom.name.
	session_sync_filter dictionary				Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize.
		custom_service list / elements=string			Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services.
			dst_port_range string		Custom service destination port range.
			id integer / required		Custom service ID.
			src_port_range string		Custom service source port range.
		dstaddr string			Only sessions to this IPv4 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
		dstaddr6 string			Only sessions to this IPv6 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters.
		dstintf string			Only sessions to this interface are synchronized. You can only enter one interface name. To synchronize sessions to multiple destination interfaces, add multiple filters. Source system.interface.name.
		srcaddr string			Only sessions from this IPv4 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
		srcaddr6 string			Only sessions from this IPv6 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters.
		srcintf string			Only sessions from this interface are synchronized. You can only enter one interface name. To synchronize sessions for multiple source interfaces, add multiple filters. Source system.interface.name.
	slave_add_ike_routes string			Choices: enable disable	Enable/disable IKE route announcement on the backup unit.
	sync_id integer				Sync ID.
	syncvd list / elements=string				Sessions from these VDOMs are synchronized using this session synchronization configuration.
		name string / required			VDOM name. Source system.vdom.name.
vdom string				Default: "root"	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.

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: Configure FortiGate Session Life Support Protocol (FGSP) session synchronization.
    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: "5"
        hb_lost_threshold: "6"
        ike_heartbeat_interval: "7"
        ike_monitor: "enable"
        ike_monitor_interval: "9"
        ike_seqjump_speed: "10"
        ipsec_tunnel_sync: "enable"
        peerip: "<your_own_value>"
        peervd: "<your_own_value> (source system.vdom.name)"
        session_sync_filter:
            custom_service:
             -
                dst_port_range: "<your_own_value>"
                id:  "17"
                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: "26"
        syncvd:
         -
            name: "default_name_28 (source system.vdom.name)"

Return Values

Common return values are documented here, the following are the fields unique to this module:

Key	Returned	Description
build string	always	Build number of the fortigate image Sample: 1547
http_method string	always	Last method used to provision the content into FortiGate Sample: PUT
http_status string	always	Last result given by FortiGate on last operation applied Sample: 200
mkey string	success	Master key (id) used in the last call to FortiGate Sample: id
name string	always	Name of the table used to fulfill the request Sample: urlfilter
path string	always	Path of the table used to fulfill the request Sample: webfilter
revision string	always	Internal revision number Sample: 17.0.2.10658
serial string	always	Serial number of the unit Sample: FGVMEVYYQT3AB5352
status string	always	Indication of the operation's result Sample: success
vdom string	always	Virtual domain used Sample: root
version string	always	Version of the FortiGate 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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_cluster_sync_module.html