:source: fmgd_system_standalonecluster.py
:orphan:
.. _fmgd_system_standalonecluster:
fmgd_system_standalonecluster -- Configure FortiGate Session Life Support Protocol (FGSP) cluster attributes.
+++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++++
.. versionadded:: 1.0.0
.. contents::
:local:
:depth: 1
Synopsis
--------
- This module is able to configure a FortiManager device.
- Examples include all parameters and values need to be adjusted to data sources before usage.
- Tested with FortiManager v7.x.
Requirements
------------
The below requirements are needed on the host that executes this module.
- ansible-core>=2.16.0
FortiManager Version Compatibility
----------------------------------
.. raw:: html
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
Parameters
----------
.. raw:: html
- access_token -The token to access FortiManager without using username and password. type: str required: false
- bypass_validation - Only set to True when module schema diffs with FortiManager API structure, module continues to execute without validating parameters. type: bool required: false default: False
- enable_log - Enable/Disable logging for task. type: bool required: false default: False
- forticloud_access_token - Access token of forticloud managed API users, this option is available with FortiManager later than 6.4.0. type: str required: false
- proposed_method - The overridden method for the underlying Json RPC request. type: str required: false choices: set, update, add
- rc_succeeded - The rc codes list with which the conditions to succeed will be overriden. type: list required: false
- rc_failed - The rc codes list with which the conditions to fail will be overriden. type: list required: false
- workspace_locking_adom - Acquire the workspace lock if FortiManager is running in workspace mode. type: str required: false choices: global, custom adom including root
- workspace_locking_timeout - The maximum time in seconds to wait for other users to release workspace lock. type: integer required: false default: 300
- device - The parameter in requested url type: str required: true
- system_standalonecluster - Configure FortiGate Session Life Support Protocol type: dict
- asymmetric_traffic_control (Alias name: asymmetric-traffic-control) Asymmetric traffic control mode. type: str choices: [cps-preferred, strict-anti-replay]
more...
Supported Version Ranges: v7.4.3 -> latest
- cluster_peer (Alias name: cluster-peer) Cluster peer. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- down_intfs_before_sess_sync (Alias name: down-intfs-before-sess-sync) List of interfaces to be turned down before session synchronization is complete. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- hb_interval (Alias name: hb-interval) Heartbeat interval (1 - 20 (100*ms). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- hb_lost_threshold (Alias name: hb-lost-threshold) Lost heartbeat threshold (1 - 60). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ipsec_tunnel_sync (Alias name: ipsec-tunnel-sync) Enable/disable ipsec tunnel synchronization. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- peerip Ip address of the interface on the peer unit that is used for the session synchronization link. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- peervd Vdom that contains the session synchronization link interface on the peer unit. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- secondary_add_ipsec_routes (Alias name: secondary-add-ipsec-routes) Enable/disable ike route announcement on the backup unit. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- session_sync_filter (Alias name: session-sync-filter) Session sync filter. type: dict
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- custom_service (Alias name: custom-service) Custom service. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dst_port_range (Alias name: dst-port-range) Custom service destination port range. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- id Custom service id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- src_port_range (Alias name: src-port-range) Custom service source port range. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dstaddr Only sessions to this ipv4 address are synchronized. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dstaddr6 Only sessions to this ipv6 address are synchronized. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- dstintf Only sessions to this interface are synchronized. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- srcaddr Only sessions from this ipv4 address are synchronized. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- srcaddr6 Only sessions from this ipv6 address are synchronized. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- srcintf Only sessions from this interface are synchronized. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- sync_id (Alias name: sync-id) Sync id. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- syncvd Sessions from these vdoms are synchronized using this session synchronization configuration. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ike_monitor (Alias name: ike-monitor) Ike monitor. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ike_use_rfc6311 (Alias name: ike-use-rfc6311) Ike use rfc6311. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ike_heartbeat_interval (Alias name: ike-heartbeat-interval) Ike heartbeat interval. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- ike_monitor_interval (Alias name: ike-monitor-interval) Ike monitor interval. type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- data_intf_session_sync_dev (Alias name: data-intf-session-sync-dev) Reserve data interfaces for session sync only. type: str
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- encryption Enable/disable encryption when synchronizing sessions. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- group_member_id (Alias name: group-member-id) Cluster member id (0 - 15). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- layer2_connection (Alias name: layer2-connection) Indicate whether layer 2 connections are present among fgsp members. type: str choices: [unavailable, available]
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- psksecret Pre-shared secret for session synchronization (ascii string or hexadecimal encoded with a leading 0x). type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- session_sync_dev (Alias name: session-sync-dev) Offload session-sync process to kernel and sync sessions using connected interface(s) directly. type: list
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- standalone_group_id (Alias name: standalone-group-id) Cluster group id (0 - 255). type: int
more...
Supported Version Ranges: v7.2.6 -> v7.2.12, v7.4.3 -> latest
- monitor_interface (Alias name: monitor-interface) Configure a list of interfaces on which to monitor itself. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- pingsvr_monitor_interface (Alias name: pingsvr-monitor-interface) List of pingsvr monitor interface to check for remote ip monitoring. type: list
more...
Supported Version Ranges: v7.6.0 -> latest
- monitor_prefix (Alias name: monitor-prefix) Monitor prefix. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- id Id. type: int
more...
Supported Version Ranges: v7.6.2 -> latest
- prefix Prefix. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- vdom Vdom name. type: list
more...
Supported Version Ranges: v7.6.2 -> latest
- vrf Vrf id. type: int
more...
Supported Version Ranges: v7.6.2 -> latest
- helper_traffic_bounce (Alias name: helper-traffic-bounce) Enable/disable helper related traffic bounce. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> latest
- utm_traffic_bounce (Alias name: utm-traffic-bounce) Enable/disable utm related traffic bounce. type: str choices: [disable, enable]
more...
Supported Version Ranges: v7.6.4 -> latest
Notes
-----
.. note::
- Running in workspace locking mode is supported in this FortiManager module, the top level parameters workspace_locking_adom and workspace_locking_timeout help do the work.
- To create or update an object, use state: present directive.
- To delete an object, use state: absent directive
- Normally, running one module can fail when a non-zero rc is returned. you can also override the conditions to fail or succeed with parameters rc_failed and rc_succeeded
Examples
--------
.. code-block:: yaml+jinja
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Configure FortiGate Session Life Support Protocol
fortinet.fmgdevice.fmgd_system_standalonecluster:
# bypass_validation: false
# workspace_locking_adom:
# workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
device:
system_standalonecluster:
# asymmetric_traffic_control:
# cluster_peer:
# - down_intfs_before_sess_sync:
# hb_interval:
# hb_lost_threshold:
# ipsec_tunnel_sync:
# peerip:
# peervd:
# secondary_add_ipsec_routes:
# session_sync_filter:
# custom_service:
# - dst_port_range:
# id:
# src_port_range:
# dstaddr:
# dstaddr6:
# dstintf:
# srcaddr:
# srcaddr6:
# srcintf:
# sync_id:
# syncvd:
# ike_monitor:
# ike_use_rfc6311:
# ike_heartbeat_interval:
# ike_monitor_interval:
# data_intf_session_sync_dev:
# encryption:
# group_member_id:
# layer2_connection:
# psksecret:
# session_sync_dev:
# standalone_group_id:
# monitor_interface:
# pingsvr_monitor_interface:
# monitor_prefix:
# - id:
# prefix:
# vdom:
# vrf:
# helper_traffic_bounce:
# utm_traffic_bounce:
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:
.. raw:: html
- meta - The result of the request.returned: always type: dict
- request_url - The full url requested. returned: always type: str sample: /sys/login/user
- response_code - The status of api request. returned: always type: int sample: 0
- response_data - The data body of the api response. returned: optional type: list or dict
- response_message - The descriptive message of the api response. returned: always type: str sample: OK
- system_information - The information of the target system. returned: always type: dict
- rc - The status the request. returned: always type: int sample: 0
- version_check_warning - Warning if the parameters used in the playbook are not supported by the current FortiManager version. returned: if at least one parameter not supported by the current FortiManager version type: list
Status
------
- This module is not guaranteed to have a backwards compatible interface.
Authors
-------
- Xinwei Du (@dux-fortinet)
- Xing Li (@lix-fortinet)
- Jie Xue (@JieX19)
- Link Zheng (@chillancezen)
- Frank Shen (@fshen01)
- Hongbin Lu (@fgtdev-hblu)