fortios_system_cluster_sync – Configure FortiGate Session Life Support Protocol (FGSP) session synchronization in Fortinet’s FortiOS and FortiGate.¶
New in version 2.9.
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¶
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: 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
- state - Indicates whether to create or remove the object. type: str required: True choices: present, absent
- system_cluster_sync - Configure FortiGate Session Life Support Protocol (FGSP) session synchronization. type: dict
- down_intfs_before_sess_sync - List of interfaces to be turned down before session synchronization is complete. type: list
- name - Interface name. Source system.interface.name. type: str required: True
- hb_interval - Heartbeat interval (1 - 10 sec). type: int
- hb_lost_threshold - Lost heartbeat threshold (1 - 10). type: int
- peerip - IP address of the interface on the peer unit that is used for the session synchronization link. type: str
- peervd - VDOM that contains the session synchronization link interface on the peer unit. Usually both peers would have the same peervd. Source system.vdom.name. type: str
- session_sync_filter - Add one or more filters if you only want to synchronize some sessions. Use the filter to configure the types of sessions to synchronize. type: dict
- custom_service - Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custome services. type: list
- dst_port_range - Custom service destination port range. type: str
- id - Custom service ID. type: int required: True
- src_port_range - Custom service source port range. type: str
- dstaddr - Only sessions to this IPv4 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters. type: str
- dstaddr6 - Only sessions to this IPv6 address are synchronized. You can only enter one address. To synchronize sessions for multiple destination addresses, add multiple filters. type: str
- dstintf - 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. type: str
- srcaddr - Only sessions from this IPv4 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters. type: str
- srcaddr6 - Only sessions from this IPv6 address are synchronized. You can only enter one address. To synchronize sessions from multiple source addresses, add multiple filters. type: str
- srcintf - 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. type: str
- slave_add_ike_routes - Enable/disable IKE route announcement on the backup unit. type: str choices: enable, disable
- sync_id - Sync ID. type: int
- syncvd - Sessions from these VDOMs are synchronized using this session synchronization configuration. type: list
- name - VDOM name. Source system.vdom.name. type: str required: True
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"
peerip: "<your_own_value>"
peervd: "<your_own_value> (source system.vdom.name)"
session_sync_filter:
custom_service:
-
dst_port_range: "<your_own_value>"
id: "12"
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: "21"
syncvd:
-
name: "default_name_23 (source system.vdom.name)"
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