fortios_system_standalone_cluster.rst

source:	fortios_system_standalone_cluster.py
orphan:

fortios_system_standalone_cluster -- Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes in Fortinet's FortiOS and FortiGate.

.. versionadded:: 2.0.0

• Synopsis
• Requirements
• Tips
• FortiOS Version Compatibility
• Parameters
• Notes
• Examples
• Return Values
• Status
• Authors

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

Tips

Using member operation to add an element to an existing object.

FortiOS Version Compatibility

v6.4.0

v6.4.1

v6.4.4

v7.0.0

v7.0.1

v7.0.2

v7.0.3

v7.0.4

v7.0.5

v7.0.6

v7.0.7

v7.0.8

v7.0.12

v7.2.0

v7.2.1

v7.2.2

v7.2.4

v7.4.0

fortios_system_standalone_cluster

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

yes

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

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  system_standalone_cluster

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• cluster_peer - Configure FortiGate Session Life Support Protocol (FGSP) session synchronization. type: list member_path: cluster_peer:sync_id more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  cluster_peer

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  no

  yes

  yes

  yes

  yes

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

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  down_intfs_before_sess_sync	yes	yes	yes	yes

• name - Interface name. Source system.interface.name. type: str required: true more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes

• hb_interval - Heartbeat interval (1 - 20 (100*ms). Increase to reduce false positives. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  hb_interval	yes	yes	yes	yes

• hb_lost_threshold - Lost heartbeat threshold (1 - 60). Increase to reduce false positives. type: int more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  hb_lost_threshold	yes	yes	yes	yes

• ipsec_tunnel_sync - Enable/disable IPsec tunnel synchronization. type: str choices: enable, disable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  ipsec_tunnel_sync	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes

• peerip - IP address of the interface on the peer unit that is used for the session synchronization link. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  peerip	yes	yes	yes	yes

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

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  peervd	yes	yes	yes	yes

• secondary_add_ipsec_routes - Enable/disable IKE route announcement on the backup unit. type: str choices: enable, disable more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  secondary_add_ipsec_routes	yes	yes	yes	yes
  [enable]	yes	yes	yes	yes
  [disable]	yes	yes	yes	yes

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

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  session_sync_filter	yes	yes	yes	yes

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

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  custom_service	yes	yes	yes	yes

• dst_port_range - Custom service destination port range. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  dst_port_range	yes	yes	yes	yes

• id - Custom service ID. type: int required: true more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  id	yes	yes	yes	yes

• src_port_range - Custom service source port range. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  src_port_range	yes	yes	yes	yes

• dstaddr - Only sessions to this IPv4 address are synchronized. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  dstaddr	yes	yes	yes	yes

• dstaddr6 - Only sessions to this IPv6 address are synchronized. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  dstaddr6	yes	yes	yes	yes

• dstintf - Only sessions to this interface are synchronized. Source system.interface.name. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  dstintf	yes	yes	yes	yes

• srcaddr - Only sessions from this IPv4 address are synchronized. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  srcaddr	yes	yes	yes	yes

• srcaddr6 - Only sessions from this IPv6 address are synchronized. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  srcaddr6	yes	yes	yes	yes

• srcintf - Only sessions from this interface are synchronized. Source system.interface.name. type: str more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  srcintf	yes	yes	yes	yes

• sync_id - Sync ID. type: int required: true more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  sync_id	yes	yes	yes	yes

• syncvd - Sessions from these VDOMs are synchronized using this session synchronization configuration. type: list member_path: cluster_peer:sync_id/syncvd:name more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  syncvd	yes	yes	yes	yes

• name - VDOM name. Source system.vdom.name. type: str required: true more...

  	v7.2.1	v7.2.2	v7.2.4	v7.4.0
  name	yes	yes	yes	yes

• encryption - Enable/disable encryption when synchronizing sessions. type: str choices: enable, disable more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  encryption

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [enable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [disable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• group_member_id - Cluster member ID (0 - 15). type: int more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  group_member_id

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• layer2_connection - Indicate whether layer 2 connections are present among FGSP members. type: str choices: available, unavailable more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  layer2_connection

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [available]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  [unavailable]

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

• psksecret - Pre-shared secret for session synchronization (ASCII string or hexadecimal encoded with a leading 0x). type: str more...

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  psksecret

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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

  v6.4.0

  v6.4.1

  v6.4.4

  v7.0.0

  v7.0.1

  v7.0.2

  v7.0.3

  v7.0.4

  v7.0.5

  v7.0.6

  v7.0.7

  v7.0.8

  v7.0.12

  v7.2.0

  v7.2.1

  v7.2.2

  v7.2.4

  v7.4.0

  standalone_group_id

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

  yes

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) cluster attributes.
    fortios_system_standalone_cluster:
      vdom:  "{{ vdom }}"
      system_standalone_cluster:
        cluster_peer:
         -
            down_intfs_before_sess_sync:
             -
                name: "default_name_5 (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:  "15"
                    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: "0"
            syncvd:
             -
                name: "default_name_25 (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.

Authors

• Link Zheng (@chillancezen)
• Jie Xue (@JieX19)
• Hongbin Lu (@fgtdev-hblu)
• Frank Shen (@frankshen01)
• Miguel Angel Munoz (@mamunozgonzalez)
• Nicolas Thomas (@thomnico)

Hint

If you notice any issues in this documentation, you can create a pull request to improve it.