fortios_system_standalone_cluster – Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes in Fortinet’s FortiOS and FortiGate.¶
New in version 2.10.
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.9.0
FortiOS Version Compatibility¶
v6.4.0 |
v6.4.1 |
v6.4.4 |
v7.0.0 |
|
fortios_system_standalone_cluster | yes | yes | yes | yes |
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
- system_standalone_cluster - Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes. type: dict 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: str more...
- standalone_group_id - Cluster group ID (0 - 255). Must be the same for all members. type: int more...
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) cluster attributes.
fortios_system_standalone_cluster:
vdom: "{{ vdom }}"
system_standalone_cluster:
encryption: "enable"
group_member_id: "4"
layer2_connection: "available"
psksecret: "<your_own_value>"
session_sync_dev: "<your_own_value> (source system.interface.name)"
standalone_group_id: "8"
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