Модуль fortinet.fortios.fortios_system_virtual_wan_link — настройка резервных подключений к Интернету с помощью SD-WAN (ранее — виртуальный канал WAN) в FortiOS и FortiGate от Fortinet.

access_token

string

Аутентификация на основе токена. Создаётся в графическом интерфейсе Fortigate.

enable_log

boolean

Включить/отключить ведение журнала для задачи.

Варианты:

• false ← (по умолчанию)
• true

member_path

string

Путь к атрибуту элемента, над которым выполняется операция.

Если атрибутов несколько, они разделяются символом косой черты.

Параметр с пометкой member_path подходит для выполнения операции над элементом.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если указан member_state, параметр state игнорируется.

Варианты:

• "present"
• "absent"

system_virtual_wan_link

dictionary

Настройка резервных подключений к Интернету с помощью SD-WAN (ранее — virtual WAN link).

fail_alert_interfaces

list / elements=dictionary

Физические интерфейсы, для которых будут отправляться оповещения.

name

string / обязательный

Имя физического интерфейса. Источник: system.interface.name.

fail_detect

string

Включить/отключить проверку состояния интернет-подключения SD-WAN (обнаружение сбоев).

Варианты:

• "enable"
• "disable"

health_check

list / elements=dictionary

Проверка состояния SD-WAN или работоспособности. Укажите сервер в Интернете и определите, как SD-WAN проверяет возможность FortiGate установить с ним связь.

addr_mode

string

Режим адресации (IPv4 или IPv6).

Варианты:

• "ipv4"
• "ipv6"

diffservcode

string

Кодовая точка дифференцированного обслуживания (DSCP) в заголовке IP пробного пакета.

failtime

integer

Количество сбоев, после которого сервер считается недоступным (1–3600).

ha_priority

integer

Приоритет выбора HA (1–50).

http_agent

string

Строка в поле http-agent заголовка HTTP.

http_get

string

URL для связи с сервером, если в качестве протокола используется HTTP.

http_match

string

Ожидаемая строка ответа сервера, если используется протокол HTTP.

interval

integer

Интервал проверки состояния в миллисекундах, то есть время между попытками подключения к серверу (500–3600*1000 мс).

members

list / elements=dictionary

Список порядковых номеров участников.

seq_num

integer / обязательный

Порядковый номер участника. См. <a href=’#notes’>Примечания</a>. Источник: system.virtual-wan-link.members.seq-num.

name

string / обязательный

Имя проверки состояния или работоспособности.

packet_size

integer

Размер пакета сеанса тестирования twamp,

password

string

Пароль контроллера Twamp в режиме аутентификации

port

integer

Номер порта для связи с сервером по выбранному протоколу.

probe_packets

string

Включить/отключить передачу пробных пакетов.

Варианты:

• "disable"
• "enable"

probe_timeout

integer

Время ожидания, после которого пробный пакет считается потерянным (500–5000 мс).

protocol

string

Протокол, используемый для проверки возможности FortiGate установить связь с сервером.

Варианты:

• "ping"
• "tcp-echo"
• "udp-echo"
• "http"
• "twamp"
• "ping6"

recoverytime

integer

Количество успешных ответов, после которого сервер считается восстановившимся (1–3600).

security_mode

string

Режим безопасности контроллера Twamp.

Варианты:

• "none"
• "authentication"

server

string

IP-адрес или полное доменное имя (FQDN) сервера.

sla

list / elements=dictionary

Соглашение об уровне обслуживания (SLA).

id

integer / обязательный

Идентификатор SLA. См. <a href=’#notes’>Примечания</a>.

jitter_threshold

integer

Порог джиттера в миллисекундах, используемый SLA для принятия решения (0–10000000).

latency_threshold

integer

Порог задержки в миллисекундах, используемый SLA для принятия решения (0–10000000).

link_cost_factor

list / elements=string

Критерии выбора канала.

Варианты:

• "latency"
• "jitter"
• "packet-loss"

packetloss_threshold

integer

Порог потери пакетов в процентах, используемый SLA для принятия решения (0–100).

sla_fail_log_period

integer

Интервал в секундах между созданием сообщений журнала о сбоях SLA (0–3600).

sla_pass_log_period

integer

Интервал в секундах между созданием сообщений журнала об успешном прохождении SLA (0–3600).

threshold_alert_jitter

integer

Порог оповещения для джиттера (мс).

threshold_alert_latency

integer

Порог оповещения для задержки (мс).

threshold_alert_packetloss

integer

Порог оповещения для потери пакетов (в процентах).

threshold_warning_jitter

integer

Порог предупреждения для джиттера (мс).

threshold_warning_latency

integer

Порог предупреждения для задержки (мс).

threshold_warning_packetloss

integer

Порог предупреждения для потери пакетов (в процентах).

update_cascade_interface

string

Включить/отключить обновление каскадного интерфейса.

Варианты:

• "enable"
• "disable"

update_static_route

string

Включить/отключить обновление статического маршрута.

Варианты:

• "enable"
• "disable"

load_balance_mode

string

Алгоритм или режим балансировки интернет-трафика между участниками SD-WAN.

Варианты:

• "source-ip-based"
• "weight-based"
• "usage-based"
• "source-dest-ip-based"
• "measured-volume-based"

members

list / elements=dictionary

Интерфейсы FortiGate, добавленные в virtual-wan-link.

comment

string

Комментарии.

cost

integer

Стоимость этого интерфейса для служб в режиме SLA (0–4294967295).

gateway

string

Шлюз по умолчанию для этого интерфейса. Обычно это шлюз по умолчанию интернет-провайдера, к которому подключён интерфейс.

gateway6

string

Шлюз IPv6.

ingress_spillover_threshold

integer

Порог входящего трафика для этого интерфейса (0–16776000 кбит/с). При достижении этого порога объёма трафика новые сеансы переключаются на другие интерфейсы SD-WAN.

interface

string

Имя интерфейса. Источник: system.interface.name.

priority

integer

Приоритет интерфейса (0–4294967295). Используется для правил SD-WAN или правил приоритета.

seq_num

integer / обязательный

Порядковый номер (1–255). См. <a href=’#notes’>Примечания</a>.

source

string

Исходный IP-адрес, используемый в пакете проверки работоспособности, отправляемом серверу.

source6

string

Исходный IPv6-адрес, используемый в пакете проверки работоспособности, отправляемом серверу.

spillover_threshold

integer

Порог исходящего трафика для этого интерфейса (0–16776000 кбит/с). При достижении этого порога объёма трафика новые сеансы переключаются на другие интерфейсы SD-WAN.

status

string

Включение или отключение этого интерфейса в SD-WAN.

Варианты:

• "disable"
• "enable"

volume_ratio

integer

Измеренное соотношение объёма (это значение / сумма всех значений = процент объёма канала, 1–255).

weight

integer

Вес этого интерфейса при балансировке нагрузки с учётом весов (1–255). На интерфейсы с большим весом направляется больше трафика.

neighbor

list / elements=dictionary

Создание соседа SD-WAN из таблицы соседей BGP для управления объявлениями маршрутов в соответствии с состоянием SLA.

health_check

string

Имя проверки работоспособности SD-WAN. Источник: system.virtual-wan-link.health-check.name.

ip

string / обязательный

IP-адрес соседа. Источник: router.bgp.neighbor.ip.

member

integer

Порядковый номер участника. Источник: system.virtual-wan-link.members.seq-num.

role

string

Роль соседа.

Варианты:

• "standalone"
• "primary"
• "secondary"

sla_id

integer

Идентификатор SLA.

neighbor_hold_boot_time

integer

Период ожидания в секундах при переключении с основного соседа на резервного с момента запуска соседа (0–10000000).

neighbor_hold_down

string

Включение или отключение задержки переключения с резервного соседа на основного.

Варианты:

• "enable"
• "disable"

neighbor_hold_down_time

integer

Период ожидания в секундах при переключении с резервного соседа на основного, когда задержка отключена (0–10000000).

service

list / elements=dictionary

Создание правил SD-WAN (также называемых службами) для управления распределением сеансов по интерфейсам SD-WAN.

addr_mode

string

Режим адресации (IPv4 или IPv6).

Варианты:

• "ipv4"
• "ipv6"

bandwidth_weight

integer

Коэффициент обратной величины доступной двунаправленной пропускной способности в формуле custom-profile-1.

default

string

Включение или отключение использования SD-WAN в качестве службы по умолчанию.

Варианты:

• "enable"
• "disable"

dscp_forward

string

Включение или отключение тега DSCP для прямого трафика.

Варианты:

• "enable"
• "disable"

dscp_forward_tag

string

Тег DSCP для прямого трафика.

dscp_reverse

string

Включение или отключение тега DSCP для обратного трафика.

Варианты:

• "enable"
• "disable"

dscp_reverse_tag

string

Тег DSCP для обратного трафика.

dst

list / elements=dictionary

Имя адреса назначения.

name

string / обязательный

Имя адреса или группы адресов. Источник: firewall.address.name firewall.addrgrp.name.

dst6

list / elements=dictionary

Имя адреса назначения IPv6.

name

string / обязательный

Имя адреса IPv6 или группы адресов IPv6. Источник: firewall.address6.name firewall.addrgrp6.name.

dst_negate

string

Включение или отключение инверсии совпадения адреса назначения.

Варианты:

• "enable"
• "disable"

end_port

integer

Номер конечного порта назначения.

gateway

string

Включение или отключение шлюза службы SD-WAN.

Варианты:

• "enable"
• "disable"

groups

list / elements=dictionary

Группы пользователей.

name

string / обязательный

Имя группы. Источник: user.group.name.

health_check

string

Проверка работоспособности. Источник: system.virtual-wan-link.health-check.name.

hold_down_time

integer

Период ожидания в секундах при переключении с резервного участника на основного (0–10000000).

id

integer / обязательный

Идентификатор правила приоритета (1–4000). См. <a href=’#notes’>Примечания</a>.

input_device

list / elements=dictionary

Имя исходного интерфейса.

name

string / обязательный

Имя интерфейса. Источник: system.interface.name.

input_device_negate

string

Включение или отключение инверсии совпадения входного устройства.

Варианты:

• "enable"
• "disable"

internet_service

string

Включение или отключение использования интернет-службы для балансировки нагрузки на основе приложений.

Варианты:

• "enable"
• "disable"

internet_service_app_ctrl

list / elements=dictionary

Список идентификаторов интернет-служб на основе управления приложениями.

id

integer / обязательный

Идентификатор интернет-службы на основе управления приложениями. См. <a href=’#notes’>Примечания</a>.

internet_service_app_ctrl_group

list / elements=dictionary

Список групп интернет-служб на основе управления приложениями.

name

string / обязательный

Имя группы интернет-служб на основе управления приложениями. Источник: application.group.name.

internet_service_ctrl

list / elements=dictionary

Список идентификаторов интернет-служб на основе контроля.

id

integer / обязательный

Идентификатор интернет-службы на основе контроля. См. <a href=’#notes’>Примечания</a>.

internet_service_ctrl_group

list / elements=dictionary

Список групп интернет-служб на основе контроля.

name

string / обязательный

Имя группы интернет-служб на основе контроля. Источник: application.group.name.

internet_service_custom

list / elements=dictionary

Список имён пользовательских интернет-служб.

name

string / обязательный

Имя пользовательской интернет-службы. Источник: firewall.internet-service-custom.name.

internet_service_custom_group

list / elements=dictionary

Список групп пользовательских интернет-служб.

name

string / обязательный

Имя группы пользовательских интернет-служб. Источник: firewall.internet-service-custom-group.name.

internet_service_group

list / elements=dictionary

Список групп интернет-служб.

name

string / обязательный

Имя группы интернет-служб. Источник: firewall.internet-service-group.name.

internet_service_id

list / elements=dictionary

Список идентификаторов интернет-служб.

id

integer / обязательный

Идентификатор интернет-службы. См. <a href=’#notes’>Примечания</a>. Источник: firewall.internet-service.id.

jitter_weight

integer

Коэффициент джиттера в формуле custom-profile-1.

latency_weight

integer

Коэффициент задержки в формуле custom-profile-1.

link_cost_factor

string

Фактор стоимости канала.

Варианты:

• "latency"
• "jitter"
• "packet-loss"
• "inbandwidth"
• "outbandwidth"
• "bibandwidth"
• "custom-profile-1"

link_cost_threshold

integer

Пороговое процентное изменение значений стоимости канала, приводящее к повторному созданию маршрута политики (0–10000000).

member

integer

Порядковый номер участника. Источник: system.virtual-wan-link.members.seq-num.

mode

string

Управляет тем, как правило приоритета задаёт приоритет интерфейсов в SD-WAN.

Варианты:

• "auto"
• "manual"
• "priority"
• "sla"
• "load-balance"

name

string

Имя правила приоритета.

packet_loss_weight

integer

Коэффициент потери пакетов в формуле custom-profile-1.

priority_members

list / elements=dictionary

Список порядковых номеров участников.

seq_num

integer / обязательный

Порядковый номер участника. См. <a href=’#notes’>Примечания</a>. Источник: system.virtual-wan-link.members.seq-num.

protocol

integer

Номер протокола.

quality_link

integer

Оценка качества.

role

string

Роль сервиса для взаимодействия с соседним устройством.

Варианты:

• "standalone"
• "primary"
• "secondary"

route_tag

integer

Тег маршрута в карте маршрутизации IPv4.

sla

list / elements=dictionary

Соглашение об уровне обслуживания (SLA).

health_check

string / обязательный

Проверка работоспособности Virtual WAN Link. Источник: system.virtual-wan-link.health-check.name.

id

integer

Идентификатор SLA.

sla_compare_method

string

Метод сравнения значений SLA для режимов SLA и балансировки нагрузки.

Варианты:

• "order"
• "number"

src

list / elements=dictionary

Имя исходного адреса.

name

string / обязательный

Имя адреса или группы адресов. Источник: firewall.address.name firewall.addrgrp.name.

src6

list / elements=dictionary

Имя исходного адреса IPv6.

name

string / обязательный

Имя адреса IPv6 или группы адресов IPv6. Источник: firewall.address6.name firewall.addrgrp6.name.

src_negate

string

Включить/отключить инверсию условия совпадения исходного адреса.

Варианты:

• "enable"
• "disable"

standalone_action

string

Включить/отключить сервис, если выбранная роль соседнего устройства — standalone, а роль сервиса — нет.

Варианты:

• "enable"
• "disable"

start_port

integer

Начальный номер порта назначения.

status

string

Включить/отключить сервис SD-WAN.

Варианты:

• "enable"
• "disable"

tos

string

Шаблон битов типа обслуживания.

tos_mask

string

Проверяемые биты типа обслуживания.

users

list / elements=dictionary

Имя пользователя.

name

string / обязательный

Имя пользователя. Источник: user.local.name.

status

string

Включить/отключить SD-WAN.

Варианты:

• "disable"
• "enable"

zone

list / elements=dictionary

Настройка зон SD-WAN.

name

string / обязательный

Имя зоны.

vdom

string

Виртуальный домен из числа определённых ранее. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для настройки содержимого на FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate для последней выполненной операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успехе

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер ревизии

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"