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.1.7).

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.0.0: of fortinet.fortios

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

Parameters

Parameter

Comments

access_token

string

Token-based authentication. Generated from GUI of Fortigate.

enable_log

boolean

Enable/Disable logging for task.

Choices:

  • no ← (default)

  • yes

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_cluster_sync

dictionary

Configure FortiGate Session Life Support Protocol (FGSP) session synchronization.

down_intfs_before_sess_sync

list / elements=dictionary

List of interfaces to be turned down before session synchronization is complete.

name

string

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

Enable/disable IKE HA monitor.

Choices:

  • enable

  • disable

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

Enable/disable IPsec tunnel synchronization.

Choices:

  • enable

  • disable

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.

secondary_add_ipsec_routes

string

Enable/disable IKE route announcement on the backup unit.

Choices:

  • enable

  • disable

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=dictionary

Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custom services.

dst_port_range

string

Custom service destination port range.

id

integer

Custom service ID.

src_port_range

string

Custom service source port range.

dstaddr

string

Only sessions to this IPv4 address are synchronized.

dstaddr6

string

Only sessions to this IPv6 address are synchronized.

dstintf

string

Only sessions to this interface are synchronized. Source system.interface.name.

srcaddr

string

Only sessions from this IPv4 address are synchronized.

srcaddr6

string

Only sessions from this IPv6 address are synchronized.

srcintf

string

Only sessions from this interface are synchronized. Source system.interface.name.

slave_add_ike_routes

string

Enable/disable IKE route announcement on the backup unit.

Choices:

  • enable

  • disable

sync_id

integer

Sync ID.

syncvd

list / elements=dictionary

Sessions from these VDOMs are synchronized using this session synchronization configuration.

name

string

VDOM name. Source system.vdom.name.

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

- 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)"
        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: "27"
        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

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)