fortios_system_standalone_cluster – Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes in Fortinet’s FortiOS and FortiGate.
New in version 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 standalone_cluster 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
Tips
Using member operation to add an element to an existing object.
FortiOS Version Compatibility
Supported Version Ranges: v6.4.0 -> 7.4.3
Parameters
- access_token - Token-based authentication. Generated from GUI of Fortigate. type: str required: false
- enable_log - Enable/Disable logging for task. type: bool required: false default: 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
- member_path - Member attribute path to operate on. type: str
- member_state - Add or delete a member under specified attribute path. type: str choices: present, absent
- system_standalone_cluster - Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes. type: dict more...
- asymmetric_traffic_control - Asymmetric traffic control mode. type: str choices: cps-preferred, strict-anti-replay more...
- cluster_peer - Configure FortiGate Session Life Support Protocol (FGSP) session synchronization. type: list member_path: cluster_peer:sync_id more...
- down_intfs_before_sess_sync - List of interfaces to be turned down before session synchronization is complete. type: list member_path: cluster_peer:sync_id/down_intfs_before_sess_sync:name more...
- name - Interface name. Source system.interface.name. type: str required: true more...
- hb_interval - Heartbeat interval (1 - 20 (100*ms). Increase to reduce false positives. type: int more...
- hb_lost_threshold - Lost heartbeat threshold (1 - 60). Increase to reduce false positives. type: int more...
- ipsec_tunnel_sync - Enable/disable IPsec tunnel synchronization. type: str choices: enable, disable more...
- peerip - IP address of the interface on the peer unit that is used for the session synchronization link. type: str more...
- 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 more...
- secondary_add_ipsec_routes - Enable/disable IKE route announcement on the backup unit. type: str choices: enable, disable more...
- 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 more...
- custom_service - Only sessions using these custom services are synchronized. Use source and destination port ranges to define these custom services. type: list member_path: cluster_peer:sync_id/session_sync_filter/custom_service:id more...
- dst_port_range - Custom service destination port range. type: str more...
- id - Custom service ID. see Notes. type: int required: true more...
- src_port_range - Custom service source port range. type: str more...
- dstaddr - Only sessions to this IPv4 address are synchronized. type: str more...
- dstaddr6 - Only sessions to this IPv6 address are synchronized. type: str more...
- dstintf - Only sessions to this interface are synchronized. Source system.interface.name. type: str more...
- srcaddr - Only sessions from this IPv4 address are synchronized. type: str more...
- srcaddr6 - Only sessions from this IPv6 address are synchronized. type: str more...
- srcintf - Only sessions from this interface are synchronized. Source system.interface.name. type: str more...
- sync_id - Sync ID. see Notes. type: int required: true more...
- syncvd - Sessions from these VDOMs are synchronized using this session synchronization configuration. type: list member_path: cluster_peer:sync_id/syncvd:name more...
- name - VDOM name. Source system.vdom.name. type: str required: true more...
- encryption - Enable/disable encryption when synchronizing sessions. type: str choices: enable, disable more...
- group_member_id - Cluster member ID (0 - 15). type: int more...
- layer2_connection - Indicate whether layer 2 connections are present among FGSP members. type: str choices: available, unavailable more...
- psksecret - Pre-shared secret for session synchronization (ASCII string or hexadecimal encoded with a leading 0x). type: str more...
- session_sync_dev - Offload session-sync process to kernel and sync sessions using connected interface(s) directly. Source system.interface.name. type: list
- standalone_group_id - Cluster group ID (0 - 255). Must be the same for all members. type: int more...
Notes
Note
Legacy fortiosapi has been deprecated, httpapi is the preferred way to run playbooks
Examples
- name: Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes.
fortinet.fortios.fortios_system_standalone_cluster:
vdom: "{{ vdom }}"
system_standalone_cluster:
asymmetric_traffic_control: "cps-preferred"
cluster_peer:
-
down_intfs_before_sess_sync:
-
name: "default_name_6 (source system.interface.name)"
hb_interval: "2"
hb_lost_threshold: "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: "16"
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)"
sync_id: "<you_own_value>"
syncvd:
-
name: "default_name_26 (source system.vdom.name)"
encryption: "enable"
group_member_id: "0"
layer2_connection: "available"
psksecret: "<your_own_value>"
session_sync_dev: "<your_own_value> (source system.interface.name)"
standalone_group_id: "0"
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
Status
This module is not guaranteed to have a backwards compatible interface.