fortinet.fortios.fortios_system_sdwan модуль – Настройка избыточных подключений к Интернету с несколькими исходящими каналами и профилями проверки работоспособности в Fortinet FortiOS и FortiGate.

access_token

string

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

enable_log

boolean

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

Варианты:

• false ← (default)
• true

member_path

string

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

Разделяется символом слеша, если атрибутов несколько.

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

member_state

string

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

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

Варианты:

• "present"
• "absent"

system_sdwan

dictionary

Настройка резервных интернет-подключений с несколькими исходящими каналами и профилями проверки работоспособности.

app_perf_log_period

integer

Временной интервал в секундах, с которым генерируются логи производительности приложений (0 - 3600).

duplication

list / elements=dictionary

Создать правило дублирования SD-WAN.

dstaddr

list / elements=dictionary

Имена целевого адреса или группы адресов.

name

string / required

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

dstaddr6

list / elements=dictionary

Имена целевого адреса IPv6 или группы адресов IPv6.

name

string / required

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

dstintf

list / elements=dictionary

Исходящие интерфейсы или зоны.

name

string / required

Имя интерфейса, зоны или зоны SDWAN. Источник system.interface.name system.zone.name system.sdwan.zone.name.

id

integer / required

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

packet_de_duplication

string

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

Варианты:

• "enable"
• "disable"

packet_duplication

string

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

Варианты:

• "disable"
• "force"
• "on-demand"

service

list / elements=dictionary

Имя сервиса и группы сервисов.

name

string / required

Имя сервиса и группы сервисов. Источник firewall.service.custom.name firewall.service.group.name.

service_id

list / elements=dictionary

Список ID правил сервиса SD-WAN.

id

integer / required

ID правила сервиса SD-WAN. см. <a href=’#notes’>Примечания</a>. Источник system.sdwan.service.id.

sla_match_service

string

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

Варианты:

• "enable"
• "disable"

srcaddr

list / elements=dictionary

Исходный адрес или имена групп адресов.

name

string / required

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

srcaddr6

list / elements=dictionary

Исходный адрес6 или имена групп адресов6.

name

string / required

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

srcintf

list / elements=dictionary

Входящие интерфейсы или зоны.

name

string / required

Имя интерфейса, зоны или зоны SDWAN. Источник system.interface.name system.zone.name system.sdwan.zone.name.

duplication_max_num

integer

Максимальное количество членов интерфейса, в которых дублируется пакет в зоне SD-WAN (2 - 4).

fail_alert_interfaces

list / elements=dictionary

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

name

string / required

Имя физического интерфейса. Источник 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"

class_id

integer

Идентификатор класса трафика. Источник firewall.traffic-class.class-id.

detect_mode

string

Режим определения способа обнаружения сервера.

Варианты:

• "active"
• "passive"
• "prefer-passive"
• "remote"
• "agent-based"

diffservcode

string

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

dns_match_ip

string

Ожидаемый IP-адрес ответа от DNS-сервера, если протокол - DNS.

dns_request_domain

string

Полностью квалифицированное доменное имя для разрешения для DNS-проверки.

embed_measured_health

string

Включить/выключить внедрение информации о измеренном состоянии.

Варианты:

• "enable"
• "disable"

failtime

integer

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

ftp_file

string

Полный путь и имя файла на FTP-сервере для загрузки для проверки работоспособности FTP.

ftp_mode

string

Режим FTP.

Варианты:

• "passive"
• "port"

ha_priority

integer

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

http_agent

string

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

http_get

string

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

http_match

string

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

interval

integer

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

members

list / elements=dictionary

Список номеров последовательности участников.

seq_num

integer / required

Номер последовательности участника. см. <a href=’#notes’>Примечания</a>. Источник system.sdwan.members.seq-num.

mos_codec

string

Кодек, используемый для расчета MOS.

Варианты:

• "g711"
• "g722"
• "g729"

name

string / required

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

packet_size

integer

Размер пакета сеанса тестирования TWAMP. (124/158 - 1024)

password

string

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

port

integer

Номер порта, используемый для связи с сервером по выбранному протоколу (0 - 65535).

probe_count

integer

Количество последних зондов, которые должны использоваться для расчета задержки и джиттера (5 - 30).

probe_packets

string

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

Варианты:

• "disable"
• "enable"

probe_timeout

integer

Время ожидания, прежде чем пакет зондирования будет считаться потерянным (20 - 3600*1000 мс).

protocol

string

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

Варианты:

• "ping"
• "tcp-echo"
• "udp-echo"
• "http"
• "https"
• "twamp"
• "dns"
• "tcp-connect"
• "ftp"
• "ping6"

quality_measured_method

string

Метод измерения качества tcp-connect.

Варианты:

• "half-open"
• "half-close"

recoverytime

integer

Количество полученных успешных ответов, прежде чем сервер будет считаться восстановленным (1 - 3600).

security_mode

string

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

Варианты:

• "none"
• "authentication"

server

list / elements=string

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

sla

list / elements=dictionary

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

id

integer / required

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

jitter_threshold

integer

Джиттер для SLA для принятия решения в миллисекундах. (0 - 10000000).

latency_threshold

integer

Задержка для SLA для принятия решения в миллисекундах. (0 - 10000000).

link_cost_factor

list / elements=string

Критерии, на основе которых осуществляется выбор канала связи.

Choices:

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

mos_threshold

string

Минимальный средний балл оценки качества обслуживания (MOS) для того, чтобы SLA был отмечен как пройденный. (1.0 - 5.0).

packetloss_threshold

integer

Потеря пакетов для принятия решения SLA в процентах. (0 - 100).

priority_in_sla

integer

Значение, которое будет распределено в таблице маршрутизации, когда in-sla (0 - 65535).

priority_out_sla

integer

Значение, которое будет распределено в таблице маршрутизации, когда out-sla (0 - 65535).

sla_fail_log_period

integer

Временной интервал в секундах, через который будут генерироваться сообщения журнала о сбоях SLA (0 - 3600).

sla_id_redistribute

integer

Выберите ID из подтаблицы SLA. Выбранное значение приоритета SLA будет распределено в таблице маршрутизации (0 - 32).

sla_pass_log_period

integer

Временной интервал в секундах, через который будут генерироваться сообщения журнала об успешном прохождении SLA (0 - 3600).

source

string

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

source6

string

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

system_dns

string

Включить/отключить системный DNS в качестве сервера проверки.

Choices:

• "disable"
• "enable"

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

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

Choices:

• "enable"
• "disable"

update_static_route

string

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

Choices:

• "enable"
• "disable"

user

string

Имя пользователя для доступа к серверу проверки.

vrf

integer

Идентификатор виртуальной маршрутизации (VRF).

load_balance_mode

string

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

Choices:

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

members

list / elements=dictionary

Интерфейсы FortiGate, добавленные в SD-WAN.

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.

preferred_source

string

Предпочтительный источник маршрута для этого участника.

priority

integer

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

priority6

integer

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

seq_num

integer / required

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

source

string

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

source6

string

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

spillover_threshold

integer

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

status

string

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

Choices:

• "disable"
• "enable"

transport_group

integer

Измеренная транспортная группа (0 - 255).

volume_ratio

integer

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

weight

integer

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

zone

string

Имя зоны. Источник system.sdwan.zone.name.

neighbor

list / elements=dictionary

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

health_check

string

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

ip

string / required

IP/IPv6-адрес соседа или имя группы соседей. Источник router.bgp.neighbor-group.name router.bgp.neighbor.ip.

member

list / elements=dictionary

Список номеров последовательности участников. Источник system.sdwan.members.seq-num.

seq_num

integer / required

Номер последовательности участника. см. <a href=’#notes’>Примечания</a>. Источник system.sdwan.members.seq-num.

minimum_sla_meet_members

integer

Минимальное количество участников, которые соответствуют SLA, когда соседний узел является предпочтительным.

mode

string

Какой показатель использовать для выбора соседа.

Варианты:

• "sla"
• "speedtest"

role

string

Роль соседа.

Варианты:

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

service_id

integer

Идентификатор службы SD-WAN для работы с соседом. Источник system.sdwan.service.id.

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"

agent_exclusive

string

Установить/снять флажок использования службы исключительно агентом.

Варианты:

• "enable"
• "disable"

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 / required

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

dst6

list / elements=dictionary

Имя целевого адреса6.

name

string / required

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

dst_negate

string

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

Choices:

• "enable"
• "disable"

end_port

integer

Конечный номер порта назначения.

end_src_port

integer

Конечный номер исходного порта.

gateway

string

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

Choices:

• "enable"
• "disable"

groups

list / elements=dictionary

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

name

string / required

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

hash_mode

string

Хэш-алгоритм для выбранных приоритетных участников в режиме балансировки нагрузки.

Choices:

• "round-robin"
• "source-ip-based"
• "source-dest-ip-based"
• "inbandwidth"
• "outbandwidth"
• "bibandwidth"

health_check

list / elements=dictionary

Список проверок работоспособности.

name

string / required

Имя проверки работоспособности. Источник system.sdwan.health-check.name.

hold_down_time

integer

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

id

integer / required

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

input_device

list / elements=dictionary

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

name

string / required

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

input_device_negate

string

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

Choices:

• "enable"
• "disable"

input_zone

list / elements=dictionary

Имя исходной входной зоны.

name

string / required

Зона. Источник system.sdwan.zone.name.

internet_service

string

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

Choices:

• "enable"
• "disable"

internet_service_app_ctrl

list / elements=dictionary

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

id

integer / required

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

internet_service_app_ctrl_category

list / elements=dictionary

Идентификаторы одной или нескольких категорий контроля приложений.

id

integer / required

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

internet_service_app_ctrl_group

list / elements=dictionary

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

name

string / required

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

internet_service_custom

list / elements=dictionary

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

name

string / required

Имя пользовательского интернет-сервиса. Источник firewall.internet-service-custom.name.

internet_service_custom_group

list / elements=dictionary

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

name

string / required

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

internet_service_group

list / elements=dictionary

Список групп интернет-сервисов.

name

string / required

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

internet_service_name

list / elements=dictionary

Список имен интернет-сервисов.

name

string / required

Имя интернет-сервиса. Источник firewall.internet-service-name.name.

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).

load_balance

string

Включить/выключить балансировку нагрузки.

Варианты:

• "enable"
• "disable"

minimum_sla_meet_members

integer

Минимальное количество участников, которые соответствуют SLA.

mode

string

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

Варианты:

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

name

string

Имя правила SD-WAN.

packet_loss_weight

integer

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

passive_measurement

string

Включить/выключить пассивное измерение на основе критериев сервиса.

Варианты:

• "enable"
• "disable"

priority_members

list / elements=dictionary

Список номеров последовательности участников.

seq_num

integer / required

Номер последовательности участника. см. <a href=’#notes’>Примечания</a>. Источник system.sdwan.members.seq-num.

priority_zone

list / elements=dictionary

Список имен приоритетных зон.

name

string / required

Имя приоритетной зоны. Источник system.sdwan.zone.name.

protocol

integer

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

quality_link

integer

Класс качества.

role

string

Роль сервиса для работы с соседом.

Варианты:

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

route_tag

integer

IPv4 route map route-tag.

shortcut

string

Включить/отключить ярлык для этого сервиса.

Варианты:

• "enable"
• "disable"

shortcut_priority

string

Высокий приоритет ярлыка ADVPN для этого сервиса.

Варианты:

• "enable"
• "disable"
• "auto"

shortcut_stickiness

string

Включить/отключить липкость ярлыка ADVPN.

Варианты:

• "enable"
• "disable"

sla

list / elements=dictionary

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

health_check

string / required

Проверка работоспособности SD-WAN. Источник system.sdwan.health-check.name.

id

integer

ИД SLA.

sla_compare_method

string

Метод сравнения значения SLA для режима SLA.

Варианты:

• "order"
• "number"

sla_stickiness

string

Включить/отключить липкость SLA.

Варианты:

• "enable"
• "disable"

src

list / elements=dictionary

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

name

string / required

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

src6

list / elements=dictionary

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

name

string / required

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

src_negate

string

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

Варианты:

• "enable"
• "disable"

standalone_action

string

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

Choices:

• "enable"
• "disable"

start_port

integer

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

start_src_port

integer

Начальный номер исходного порта.

status

string

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

Choices:

• "enable"
• "disable"

tie_break

string

Метод выбора участника, если более одного удовлетворяет SLA.

Choices:

• "zone"
• "cfg-order"
• "fib-best-match"
• "input-device"

tos

string

Шаблон битов типа сервиса.

tos_mask

string

Оцениваемые биты типа сервиса.

use_shortcut_sla

string

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

Choices:

• "enable"
• "disable"

users

list / elements=dictionary

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

name

string / required

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

zone_mode

string

Включить/отключить режим зоны.

Choices:

• "enable"
• "disable"

speedtest_bypass_routing

string

Включить/отключить обход маршрутизации при speedtest на члене SD-WAN.

Choices:

• "disable"
• "enable"

status

string

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

Choices:

• "disable"
• "enable"

zone

list / elements=dictionary

Настроить зоны SD-WAN.

advpn_health_check

string

Проверка работоспособности качества локального оверлейного соединения ADVPN. Источник system.sdwan.health-check.name.

advpn_select

string

Включить/отключить выбор ADVPN на основе информации SDWAN.

Choices:

• "enable"
• "disable"

minimum_sla_meet_members

integer

Минимальное количество участников, которые удовлетворяют SLA, когда сосед предпочтительнее.

name

string / required

Имя зоны.

service_sla_tie_break

string

Метод выбора участника, если более одного удовлетворяет SLA.

Choices:

• "cfg-order"
• "fib-best-match"
• "input-device"

vdom

string

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

Default: "root"