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

Примечание

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

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

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

Для использования в playbook укажите: fortinet.fortios.fortios_system_cluster_sync.

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

Обзор
Требования
Параметры
Примечания
Примеры
Значения возврата

Обзор

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

Требования

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

ansible>=2.15

END_OF_DOCUMENT_MARKER

Параметры

Параметр	Комментарии
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 Session Life Support Protocol (FGSP) для синхронизации сессий.
down_intfs_before_sess_sync список / элементы=словарь	Список интерфейсов, которые нужно выключить перед завершением синхронизации сессий.
name строка / обязательный	Имя интерфейса. Источник системы.interface.name.
hb_interval целое число	Интервал отправки сигналов (heartbeat) (1 - 10 сек).
hb_lost_threshold целое число	Пороговое значение для потери сигналов (1 - 10).
ike_heartbeat_interval целое число	Интервал отправки IKE heartbeat (1 - 60 сек).
ike_monitor строка	Включить/выключить мониторинг IKE HA. Варианты: `"enable"` `"disable"`
ike_monitor_interval целое число	Интервал мониторинга IKE HA (10 - 300 сек).
ike_seqjump_speed целое число	Коэффициент предварительного пропуска ESP (эквивалент 1G - 10G pps).
ipsec_tunnel_sync строка	Включить/выключить синхронизацию IPsec туннеля. Варианты: `"enable"` `"disable"`
peerip строка	IP-адрес интерфейса на узле-партнёре, используемый для связи синхронизации сессий.
peervd строка	VDOM, содержащий интерфейс связи синхронизации сессий на узле-партнёре. Обычно у обоих узлов peervd одинаковый. Источник системы.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 строка	Синхронизируются только сеансы с этим интерфейсом. Имя интерфейса источника системы.
srcaddr строка	Синхронизируются только сеансы с этого IPv4-адреса.
srcaddr6 строка	Синхронизируются только сеансы с этого IPv6-адреса.
srcintf строка	Синхронизируются только сеансы с этого интерфейса. Имя интерфейса источника системы.
slave_add_ike_routes строка	Включить/выключить объявление маршрутов IKE на резервном устройстве. Варианты: `"enable"` `"disable"`
sync_id целое число / обязательно	Идентификатор синхронизации. См. <a href=’#notes’>Примечания</a>.
syncvd список / элементы=словарь	Сеансы из этих VDOM синхронизируются с помощью данной конфигурации синхронизации сеансов.
name строка / обязательно	Имя VDOM. Имя VDOM источника системы.
vdom строка	Виртуальная область, среди ранее определенных. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

Мы настоятельно рекомендуем использовать собственное значение для sync_id вместо 0, поскольку «0» — это специальный маркер, который позволяет бэкенду назначать последнее доступное число для объекта, но он имеет ограничения. Дополнительные сведения см. в разделе «Вопросы и ответы».
Устаревший fortiosapi устарел, httpapi является предпочтительным способом выполнения playbooks
Модуль поддерживает режим проверки.

Примеры

- 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 строка	Главный ключ (id), использованный при последнем вызове 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_cluster_sync_module.html