модуль fortinet.fortios.fortios_system_cluster_sync — настройка синхронизации сеансов с помощью протокола поддержки жизненного цикла сеансов FortiGate (FGSP) в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Чтобы установить коллекцию, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля требуются дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_system_cluster_sync.

Добавлено в fortinet.fortios 2.0.0

Краткое описание
Требования
Параметры
Примечания
Примеры
Возвращаемые значения

Краткое описание

Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры системных функций и категории cluster_sync. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

ansible>=2.16

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
enable_log логическое значение	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с атрибутом member_path можно использовать для выполнения операции с элементом.
member_state строка	Добавить или удалить элемент по указанному пути атрибута. Если задан параметр member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
state строка / обязательный	Указывает, следует ли создать или удалить объект. Варианты: `"present"` `"absent"`
system_cluster_sync словарь	Настройка синхронизации сеансов с помощью протокола поддержки жизненного цикла сеансов FortiGate (FGSP).
down_intfs_before_sess_sync список / элементы=словарь	Список интерфейсов, которые необходимо отключить до завершения синхронизации сеансов.
name строка / обязательный	Имя интерфейса. Источник: system.interface.name.
hb_interval целое число	Интервал между сигналами проверки активности (1–10 с).
hb_lost_threshold целое число	Порог потери сигналов проверки активности (1–10).
ike_heartbeat_interval целое число	Интервал между сигналами проверки активности IKE (1–60 с).
ike_monitor строка	Включить или отключить мониторинг IKE HA. Варианты: `"enable"` `"disable"`
ike_monitor_interval целое число	Интервал мониторинга IKE HA (10–300 с).
ike_seqjump_speed целое число	Коэффициент ускоренного перехода ESP (эквивалент 1G–10G пакетов/с).
ipsec_tunnel_sync строка	Включить или отключить синхронизацию туннелей IPsec. Варианты: `"enable"` `"disable"`
peerip строка	IP-адрес интерфейса на узле-партнере, используемого для канала синхронизации сеансов.
peervd строка	VDOM, содержащий интерфейс канала синхронизации сеансов на узле-партнере. Обычно у обоих партнеров значение peervd совпадает. Источник: system.vdom.name.
secondary_add_ipsec_routes строка	Включить или отключить объявление маршрутов IKE на резервном устройстве. Варианты: `"enable"` `"disable"`
session_sync_filter словарь	Добавьте один или несколько фильтров, если нужно синхронизировать только некоторые сеансы. Используйте фильтр, чтобы настроить типы синхронизируемых сеансов.
custom_service список / элементы=словарь	Синхронизируются только сеансы, использующие указанные пользовательские службы. Чтобы определить эти службы, используйте диапазоны портов источника и назначения.
dst_port_range строка	Диапазон портов назначения пользовательской службы.
id целое число / обязательный	Идентификатор пользовательской службы. См. <a href=’#notes’>Примечания</a>.
src_port_range строка	Диапазон портов источника пользовательской службы.
dstaddr строка	Синхронизируются только сеансы, направленные на этот IPv4-адрес.
dstaddr6 строка	Синхронизируются только сеансы, направленные на этот IPv6-адрес.
dstintf строка	Синхронизируются только сеансы, направленные через этот интерфейс. Источник: system.interface.name.
srcaddr строка	Синхронизируются только сеансы с этого IPv4-адреса.
srcaddr6 строка	Синхронизируются только сеансы с этого IPv6-адреса.
srcintf строка	Синхронизируются только сеансы с этого интерфейса. Источник: system.interface.name.
slave_add_ike_routes строка	Включить или отключить объявление маршрутов IKE на резервном устройстве. Варианты: `"enable"` `"disable"`
sync_id целое число / обязательный	Идентификатор синхронизации. См. <a href=’#notes’>Примечания</a>.
syncvd список / элементы=словарь	Сеансы из этих VDOM синхронизируются с помощью этой конфигурации синхронизации сеансов.
name строка / обязательный	Имя VDOM. Источник: system.vdom.name.
vdom строка	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Настоятельно рекомендуем использовать для sync_id собственное значение, а не 0. Значение «0» является специальным заполнителем, позволяющим серверной части назначить объекту последний доступный номер, однако у такого подхода есть ограничения. Подробности см. в разделе «Вопросы и ответы».
Устаревший fortiosapi объявлен устаревшим; предпочтительный способ запуска плейбуков — httpapi.
Модуль поддерживает check_mode.

Примеры

- name: Configure FortiGate Session Life Support Protocol (FGSP) session synchronization.
  fortinet.fortios.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: "2"
          hb_lost_threshold: "3"
          ike_heartbeat_interval: "3"
          ike_monitor: "enable"
          ike_monitor_interval: "15"
          ike_seqjump_speed: "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: "18"
                      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: "<you_own_value>"
          syncvd:
              -
                  name: "default_name_29 (source system.vdom.name)"

Возвращаемые значения

Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:

Ключ	Описание
build строка	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method строка	Последний метод, использованный для передачи конфигурации на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status строка	Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: `"200"`
mkey строка	Главный ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успешном выполнении Пример: `"id"`
name строка	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path строка	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision строка	Внутренний номер редакции Возвращается: всегда Пример: `"17.0.2.10658"`
serial строка	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status строка	Результат операции Возвращается: всегда Пример: `"success"`
vdom строка	Использованный виртуальный домен Возвращается: всегда Пример: `"root"`
version строка	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

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

Ссылки на коллекцию

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_cluster_sync_module.html