Модуль fortinet.fortios.fortios_system_ha — настройка HA в 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_ha.
Новое в fortinet.fortios 2.0.0
Краткое описание
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры системных функций и категории HA. В примерах представлены все параметры и значения, которые перед использованием необходимо скорректировать в соответствии с источниками данных. Проверено с FOS v6.0.0
Требования
На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Токен создаётся в графическом интерфейсе Fortigate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Возможные значения:
|
member_path string | Путь к атрибуту элемента, над которым выполняется операция. Если атрибутов несколько, они разделяются косой чертой. Параметр с пометкой member_path можно использовать для выполнения операции над элементом. |
member_state string | Добавить или удалить элемент по указанному пути атрибута. Если задан параметр member_state, параметр state игнорируется. Возможные значения:
|
system_ha dictionary | Настроить HA. |
|
arps integer |
Количество gratuitous ARP (1–60). Уменьшите значение, чтобы снизить трафик. Увеличьте, чтобы сократить время переключения при отказе. |
|
arps_interval integer |
Интервал между gratuitous ARP (1–20 с). Уменьшите значение, чтобы сократить время переключения при отказе. Увеличьте, чтобы снизить трафик. |
|
authentication string |
Включить или отключить аутентификацию сообщений heartbeat. Возможные значения:
|
|
auto_virtual_mac_interface list / elements=dictionary |
Физический интерфейс, которому будет назначен автоматически сгенерированный виртуальный MAC-адрес. |
|
interface_name string / обязательный |
Имя интерфейса. Источник: system.interface.name. |
|
backup_hbdev list / elements=dictionary |
Резервные интерфейсы heartbeat. Настройка должна быть одинаковой для всех участников. |
|
name string / обязательный |
Имя интерфейса. Источник: system.interface.name. |
|
bounce_intf_upon_failover string |
Включить или отключить уведомление ядра о необходимости выключить и снова включить все отслеживаемые интерфейсы. Этот параметр используется при переключении в случае отказа, если gratuitous ARP не обновляют сеть. Возможные значения:
|
|
check_secondary_dev_health string |
Включить или отключить проверку работоспособности вторичного устройства для балансировки нагрузки сеансов в режиме HA A-A. Возможные значения:
|
|
cpu_threshold string |
Вес загрузки ЦП и верхний и нижний пороговые уровни для динамической балансировки нагрузки с учётом веса. |
|
encryption string |
Включить или отключить шифрование сообщений heartbeat. Возможные значения:
|
|
evpn_ttl integer |
TTL FDB EVPN в HA на основном устройстве (5–3600 с). |
|
failover_hold_time integer |
Время ожидания перед переключением при отказе (0–300 с), чтобы избежать повторного переключения. |
|
ftp_proxy_threshold string |
Вес балансировки нагрузки с учётом веса и верхнее и нижнее пороговые значения количества сеансов FTP-прокси. |
|
gratuitous_arps string |
Включить или отключить gratuitous ARP. Отключите, если включён link-failed-signal. Возможные значения:
|
|
group_id integer |
Идентификатор группы HA (0–1023 или 0–7, если имеется более 2 vcluster). Должен быть одинаковым для всех участников. |
|
group_name string |
Имя группы кластера. Должно быть одинаковым для всех участников. |
|
ha_direct string |
Включить или отключить использование интерфейса ha-mgmt для syslog, удалённой аутентификации (RADIUS), FortiAnalyzer, FortiSandbox, sFlow и Netflow. Возможные значения:
|
|
ha_eth_type string |
Ethertype пакета heartbeat HA (4-значное шестнадцатеричное число). |
|
ha_mgmt_interfaces list / elements=dictionary |
Зарезервировать интерфейсы для управления отдельными устройствами кластера. |
|
dst string |
Адрес назначения маршрута по умолчанию для зарезервированного интерфейса управления HA. |
|
dst6 string |
Адрес IPv6 назначения по умолчанию для зарезервированного интерфейса управления HA. |
|
gateway string |
Шлюз маршрута по умолчанию для зарезервированного интерфейса управления HA. |
|
gateway6 string |
Шлюз IPv6 по умолчанию для зарезервированного интерфейса управления HA. |
|
id integer / обязательный |
Идентификатор таблицы. См. <a href=’#notes’>Примечания</a>. |
|
interface string |
Интерфейс, резервируемый для управления HA. Источник: system.interface.name. |
|
ha_mgmt_status string |
Включить резервирование интерфейсов для управления отдельными устройствами кластера. Возможные значения:
|
|
ha_uptime_diff_margin integer |
Обычно это значение уменьшают только для тестирования переключения при отказе. |
|
hb_interval integer |
Интервал между отправкой пакетов heartbeat (1–20). Увеличьте значение, чтобы уменьшить количество ложных срабатываний. |
|
hb_interval_in_milliseconds string |
Единицы измерения интервала между отправкой пакетов heartbeat. Значение по умолчанию — 100 мс. Возможные значения:
|
|
hb_lost_threshold integer |
Количество потерянных сигналов heartbeat, необходимое для регистрации сбоя (1–60). Увеличьте значение, чтобы уменьшить количество ложных срабатываний. |
|
hbdev list / elements=string |
Интерфейсы heartbeat. Настройка должна быть одинаковой для всех участников. |
|
hc_eth_type string |
Ethertype пакета heartbeat HA в прозрачном режиме (4-значное шестнадцатеричное число). |
|
hello_holddown integer |
Время ожидания перед переходом из состояния hello в рабочее состояние (5–300 с). |
|
http_proxy_threshold string |
Вес балансировки нагрузки с учётом веса и верхнее и нижнее пороговые значения количества сеансов HTTP-прокси. |
|
imap_proxy_threshold string |
Вес балансировки нагрузки с учётом веса и верхнее и нижнее пороговые значения количества сеансов IMAP-прокси. |
|
inter_cluster_session_sync string |
Включить или отключить синхронизацию сеансов между кластерами HA. Возможные значения:
|
|
ipsec_phase2_proposal list / elements=string |
Предложение IPsec для фазы 2. Возможные значения:
|
|
key string |
Ключ. |
|
l2ep_eth_type string |
Ethertype пакета heartbeat HA для сеанса Telnet (4-значное шестнадцатеричное число). |
|
link_failed_signal string |
Включить выключение всех интерфейсов на 1 с после переключения при отказе. Используйте, если gratuitous ARP не обновляют сеть. Возможные значения:
|
|
load_balance_all string |
Включить балансировку нагрузки для сеансов TCP. Отключить, чтобы балансировать нагрузку только для сеансов прокси. Возможные значения:
|
|
logical_sn string |
Включить или отключить использование логического серийного номера. Возможные значения:
|
|
memory_based_failover string |
Включить или отключить переключение при отказе на основе использования памяти. Возможные значения:
|
|
memory_compatible_mode string |
Включить или отключить режим совместимости по памяти. Возможные значения:
|
|
memory_failover_flip_timeout integer |
Время ожидания между последовательными переключениями при отказе на основе использования памяти, в минутах (6–2147483647). |
|
memory_failover_monitor_period integer |
Продолжительность повышенного использования памяти до срабатывания переключения при отказе на основе использования памяти, в секундах (1–300). |
|
memory_failover_sample_rate integer |
Интервал выборки использования памяти для его измерения, в секундах (1–60). |
|
memory_failover_threshold integer |
Порог использования памяти для срабатывания переключения при отказе на основе использования памяти (значение 0 означает использование порога режима conserve из system.global). |
|
memory_threshold string |
Вес использования памяти и верхний и нижний пороговые уровни для динамической балансировки нагрузки с учётом веса. |
|
mode string |
Режим HA. Должен быть одинаковым для всех участников. Для FGSP требуется автономный режим. Возможные значения:
|
|
monitor list / elements=string |
Интерфейсы для проверки состояния портов (или отказа канала). Источник: system.interface.name. |
|
multicast_ttl integer |
TTL многоадресной рассылки HA на основном устройстве (5–3600 с). |
|
nntp_proxy_threshold string |
Вес балансировки нагрузки с учётом веса и верхнее и нижнее пороговые значения количества сеансов NNTP-прокси. |
|
override string |
Включить и повысить приоритет устройства, которое всегда должно быть основным (ведущим). Варианты:
|
|
override_wait_time integer |
Задержка согласования при включённом переопределении (0–3600 с). Снижает частоту согласования кластера. |
|
password string |
Пароль кластера. Должен быть одинаковым для всех участников. |
|
pingserver_failover_threshold integer |
Порог переключения при мониторинге удалённого IP-адреса (0–50). |
|
pingserver_flip_timeout integer |
Время ожидания в минутах перед повторным согласованием после переключения при мониторинге удалённого IP-адреса. |
|
pingserver_monitor_interface list / elements=string |
Интерфейсы для проверки при мониторинге удалённых IP-адресов. Источник: system.interface.name. |
|
pingserver_secondary_force_reset string |
Включить принудительное согласование кластера после переключения при мониторинге удалённого IP-адреса. Варианты:
|
|
pingserver_slave_force_reset string |
Включить принудительное согласование кластера после переключения при мониторинге удалённого IP-адреса. Варианты:
|
|
pop3_proxy_threshold string |
Вес для динамической балансировки нагрузки с учётом веса, а также верхнее и нижнее значения числа сеансов прокси-сервера POP3. |
|
priority integer |
Повысить приоритет для выбора основного устройства (0–255). |
|
route_hold integer |
Время ожидания между обновлениями таблицы маршрутизации кластера (0–3600 с). |
|
route_ttl integer |
TTL маршрутов основного устройства (5–3600 с). Увеличьте значение, чтобы поддерживать активные маршруты во время переключения при сбое. |
|
route_wait integer |
Время ожидания перед отправкой новых маршрутов в кластер (0–3600 с). |
|
schedule string |
Тип балансировки нагрузки A-A. Используйте none, если применяются внешние балансировщики нагрузки. Варианты:
|
|
secondary_vcluster dictionary |
Настроить виртуальный кластер 2. |
|
monitor list / elements=string |
Интерфейсы для проверки состояния портов (или отказа канала связи). Источник: system.interface.name. |
|
override string |
Включить и повысить приоритет устройства, которое всегда должно быть основным. Варианты:
|
|
override_wait_time integer |
Задержка согласования при включённом переопределении (0–3600 с). Снижает частоту согласования кластера. |
|
pingserver_failover_threshold integer |
Порог переключения при мониторинге удалённого IP-адреса (0–50). |
|
pingserver_monitor_interface list / elements=string |
Интерфейсы для проверки при мониторинге удалённых IP-адресов. Источник: system.interface.name. |
|
pingserver_secondary_force_reset string |
Включить принудительное согласование кластера после переключения при мониторинге удалённого IP-адреса. Варианты:
|
|
pingserver_slave_force_reset string |
Включить принудительное согласование кластера после переключения при мониторинге удалённого IP-адреса. Варианты:
|
|
priority integer |
Повысить приоритет для выбора основного устройства (0–255). |
|
vcluster_id integer |
Идентификатор кластера. |
|
vdom string |
VDOM в виртуальном кластере 2. |
|
session_pickup string |
Включить или отключить синхронизацию сеансов. Её включение может сократить время простоя сеансов при переключении при сбое. Варианты:
|
|
session_pickup_connectionless string |
Включить или отключить синхронизацию сеансов UDP и ICMP. Варианты:
|
|
session_pickup_delay string |
Включить синхронизацию сеансов длительностью более 30 с. Синхронизировать нужно только более длительные сеансы. Варианты:
|
|
session_pickup_expectation string |
Включить или отключить синхронизацию ожидаемых сеансов помощника сеансов для FGSP. Варианты:
|
|
session_pickup_nat string |
Включить или отключить синхронизацию сеансов NAT для FGSP. Варианты:
|
|
session_sync_dev list / elements=string |
Перенести обработку синхронизации сеансов в ядро и синхронизировать сеансы напрямую через подключённые интерфейсы. Источник: system.interface.name. |
|
smtp_proxy_threshold string |
Вес для динамической балансировки нагрузки с учётом веса, а также верхнее и нижнее значения числа сеансов прокси-сервера SMTP. |
|
ssd_failover string |
Включить или отключить автоматическое переключение HA при отказе SSD-диска. Варианты:
|
|
standalone_config_sync string |
Включить или отключить синхронизацию конфигурации FGSP. Варианты:
|
|
standalone_mgmt_vdom string |
Включить или отключить автономный VDOM управления. Варианты:
|
|
sync_config string |
Включить или отключить синхронизацию конфигурации. Варианты:
|
|
sync_packet_balance string |
Включить или отключить распределение пакетов HA между несколькими процессорами. Варианты:
|
|
unicast_gateway string |
Шлюз маршрута по умолчанию для одноадресного интерфейса. |
|
unicast_hb string |
Включить или отключить одноадресный обмен сигналами активности. Варианты:
|
|
unicast_hb_netmask string |
Маска подсети одноадресного обмена сигналами активности. |
|
unicast_hb_peerip string |
IP-адрес узла-партнёра для одноадресного обмена сигналами активности. |
|
unicast_peers list / elements=dictionary |
Количество одноадресных узлов-партнёров. |
|
id integer / обязательный |
Идентификатор таблицы. См. <a href=’#notes’>Примечания</a>. |
|
peer_ip string |
Одноадресный IP-адрес узла-партнёра. |
|
unicast_status string |
Включить или отключить одноадресное соединение. Варианты:
|
|
uninterruptible_primary_wait integer |
Количество минут, в течение которых основное устройство HA ожидает, пока вторичное устройство HA будет считаться обновлённым и система запустится, прежде чем начать собственное обновление (15–300). |
|
uninterruptible_upgrade string |
Включить обновление кластера без блокировки сетевого трафика. Варианты:
|
|
upgrade_mode string |
Режим обновления кластера. Варианты:
|
|
vcluster list / elements=dictionary |
Таблица виртуальных кластеров. |
|
monitor list / elements=string |
Интерфейсы для проверки состояния портов (или отказа канала связи). Источник: system.interface.name. |
|
override string |
Включить и повысить приоритет устройства, которое всегда должно быть основным (ведущим). Варианты:
|
|
override_wait_time integer |
Задержка согласования при включённом переопределении (0–3600 с). Снижает частоту согласования кластера. |
|
pingserver_failover_threshold integer |
Порог переключения при мониторинге удалённого IP-адреса (0–50). |
|
pingserver_flip_timeout integer |
Время ожидания в минутах перед повторным согласованием после переключения при мониторинге удалённого IP-адреса. |
|
pingserver_monitor_interface list / elements=string |
Интерфейсы для проверки при мониторинге удалённых IP-адресов. Источник: system.interface.name. |
|
pingserver_secondary_force_reset string |
Включить принудительное согласование кластера после переключения при мониторинге удалённого IP-адреса. Варианты:
|
|
pingserver_slave_force_reset string |
Включить принудительное согласование кластера после переключения при мониторинге удалённого IP-адреса. Варианты:
|
|
priority integer |
Увеличьте приоритет, чтобы выбрать основное устройство (0–255). |
|
vcluster_id integer / обязательный |
Идентификатор. См. <a href=’#notes’>Примечания</a>. |
|
vdom list / elements=dictionary |
Виртуальные домены в виртуальном кластере. |
|
name string / обязательный |
Имя виртуального домена. Источник: system.vdom.name. |
|
vcluster2 string |
Включить или отключить виртуальный кластер 2 для виртуальной кластеризации. Варианты:
|
|
vcluster_id integer |
Идентификатор кластера. |
|
vcluster_status string |
Включить или отключить виртуальный кластер для виртуальной кластеризации. Варианты:
|
|
vdom string |
VDOM в виртуальном кластере 1. |
|
weight string |
Вес для алгоритма round-robin для каждого узла кластера. Синтаксис: <priority> <weight>. |
vdom string | Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
Примечания
Примечание
- Устаревший fortiosapi объявлен устаревшим; предпочтительный способ запуска плейбуков — httpapi
- Модуль поддерживает check_mode.
Примеры
- name: Configure HA.
fortinet.fortios.fortios_system_ha:
vdom: "{{ vdom }}"
system_ha:
arps: "5"
arps_interval: "8"
authentication: "enable"
auto_virtual_mac_interface:
-
interface_name: "<your_own_value> (source system.interface.name)"
backup_hbdev:
-
name: "default_name_9 (source system.interface.name)"
bounce_intf_upon_failover: "enable"
check_secondary_dev_health: "enable"
cpu_threshold: "<your_own_value>"
encryption: "enable"
evpn_ttl: "60"
failover_hold_time: "0"
ftp_proxy_threshold: "<your_own_value>"
gratuitous_arps: "enable"
group_id: "0"
group_name: "<your_own_value>"
ha_direct: "enable"
ha_eth_type: "<your_own_value>"
ha_mgmt_interfaces:
-
dst: "<your_own_value>"
dst6: "<your_own_value>"
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
id: "27"
interface: "<your_own_value> (source system.interface.name)"
ha_mgmt_status: "enable"
ha_uptime_diff_margin: "300"
hb_interval: "2"
hb_interval_in_milliseconds: "100ms"
hb_lost_threshold: "6"
hbdev: "<your_own_value>"
hc_eth_type: "<your_own_value>"
hello_holddown: "20"
http_proxy_threshold: "<your_own_value>"
imap_proxy_threshold: "<your_own_value>"
inter_cluster_session_sync: "enable"
ipsec_phase2_proposal: "aes128-sha1"
key: "<your_own_value>"
l2ep_eth_type: "<your_own_value>"
link_failed_signal: "enable"
load_balance_all: "enable"
logical_sn: "enable"
memory_based_failover: "enable"
memory_compatible_mode: "enable"
memory_failover_flip_timeout: "6"
memory_failover_monitor_period: "60"
memory_failover_sample_rate: "1"
memory_failover_threshold: "0"
memory_threshold: "<your_own_value>"
mode: "standalone"
monitor: "<your_own_value> (source system.interface.name)"
multicast_ttl: "600"
nntp_proxy_threshold: "<your_own_value>"
override: "enable"
override_wait_time: "0"
password: "<your_own_value>"
pingserver_failover_threshold: "0"
pingserver_flip_timeout: "60"
pingserver_monitor_interface: "<your_own_value> (source system.interface.name)"
pingserver_secondary_force_reset: "enable"
pingserver_slave_force_reset: "enable"
pop3_proxy_threshold: "<your_own_value>"
priority: "128"
route_hold: "10"
route_ttl: "10"
route_wait: "0"
schedule: "none"
secondary_vcluster:
monitor: "<your_own_value> (source system.interface.name)"
override: "enable"
override_wait_time: "0"
pingserver_failover_threshold: "0"
pingserver_monitor_interface: "<your_own_value> (source system.interface.name)"
pingserver_secondary_force_reset: "enable"
pingserver_slave_force_reset: "enable"
priority: "128"
vcluster_id: "1"
vdom: "<your_own_value>"
session_pickup: "enable"
session_pickup_connectionless: "enable"
session_pickup_delay: "enable"
session_pickup_expectation: "enable"
session_pickup_nat: "enable"
session_sync_dev: "<your_own_value> (source system.interface.name)"
smtp_proxy_threshold: "<your_own_value>"
ssd_failover: "enable"
standalone_config_sync: "enable"
standalone_mgmt_vdom: "enable"
sync_config: "enable"
sync_packet_balance: "enable"
unicast_gateway: "<your_own_value>"
unicast_hb: "enable"
unicast_hb_netmask: "<your_own_value>"
unicast_hb_peerip: "<your_own_value>"
unicast_peers:
-
id: "99"
peer_ip: "<your_own_value>"
unicast_status: "enable"
uninterruptible_primary_wait: "30"
uninterruptible_upgrade: "enable"
upgrade_mode: "simultaneous"
vcluster:
-
monitor: "<your_own_value> (source system.interface.name)"
override: "enable"
override_wait_time: "0"
pingserver_failover_threshold: "0"
pingserver_flip_timeout: "60"
pingserver_monitor_interface: "<your_own_value> (source system.interface.name)"
pingserver_secondary_force_reset: "enable"
pingserver_slave_force_reset: "enable"
priority: "128"
vcluster_id: "<you_own_value>"
vdom:
-
name: "default_name_117 (source system.vdom.name)"
vcluster_id: "0"
vcluster_status: "enable"
vcluster2: "enable"
vdom: "<your_own_value>"
weight: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, возвращенный FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: при успешном выполнении Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат выполнения операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки коллекции
© 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_ha_module.html