модуль fortinet.fortimanager.fmgr_wanprof_system_virtualwanlink — настройка резервных интернет-подключений с помощью SD-WAN

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

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

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров.

Варианты:

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

enable_log

boolean

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

Варианты:

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

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

proposed_method

string

Переопределяемый метод для базового запроса Json RPC.

Варианты:

• "update"
• "set"
• "add"

rc_failed

list / elements=integer

Список кодов rc, для которых переопределяются условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, для которых переопределяются условия успешного выполнения.

wanprof

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

Параметр (wanprof) в запрошенном URL.

wanprof_system_virtualwanlink

dictionary

Параметры верхнего уровня.

fail_alert_interfaces

псевдонимы: fail-alert-interfaces

any

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

fail_detect

псевдонимы: fail-detect

string

Включить или отключить проверку состояния интернет-соединения SD-WAN

Варианты:

• "disable"
• "enable"

health_check

псевдонимы: health-check

list / elements=dictionary

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

_dynamic_server

псевдонимы: _dynamic-server

string

Динамический сервер.

addr_mode

псевдонимы: addr-mode

string

Режим адресации

Варианты:

• "ipv4"
• "ipv6"

diffservcode

string

Кодовая точка дифференцированного обслуживания

dns_request_domain

псевдонимы: dns-request-domain

string

Полное доменное имя, которое нужно разрешить при DNS-проверке.

failtime

integer

Количество сбоев, после которого сервер считается недоступным

ha_priority

псевдонимы: ha-priority

integer

Приоритет при выборе узла HA

http_agent

псевдонимы: http-agent

string

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

http_get

псевдонимы: http-get

string

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

http_match

псевдонимы: http-match

string

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

internet_service_id

псевдонимы: internet-service-id

string

Идентификатор интернет-службы.

interval

integer

Интервал проверки состояния или время между попытками подключения к серверу

members

any

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

name

string

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

packet_size

псевдонимы: packet-size

integer

Размер пакета в тестовом сеансе TWAMP,

password

any

(список) Пароль контроллера TWAMP в режиме аутентификации

port

integer

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

probe_count

псевдонимы: probe-count

integer

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

probe_packets

псевдонимы: probe-packets

string

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

Варианты:

• "disable"
• "enable"

probe_timeout

псевдонимы: probe-timeout

integer

Время ожидания, по истечении которого пробный пакет считается потерянным

protocol

string

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

Варианты:

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

recoverytime

integer

Количество успешных ответов, после которого сервер считается восстановившим работу

security_mode

псевдонимы: security-mode

string

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

Варианты:

• "none"
• "authentication"

server

any

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

sla

list / elements=dictionary

Параметры SLA.

id

integer

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

jitter_threshold

псевдонимы: jitter-threshold

integer

Порог джиттера для принятия решений по SLA, в миллисекундах.

latency_threshold

псевдонимы: latency-threshold

integer

Порог задержки для принятия решений по SLA, в миллисекундах.

link_cost_factor

псевдонимы: link-cost-factor

list / elements=string

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

Варианты:

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

packetloss_threshold

псевдонимы: packetloss-threshold

integer

Порог потери пакетов для принятия решений по SLA, в процентах.

sla_fail_log_period

псевдонимы: sla-fail-log-period

integer

Интервал в секундах, с которым создаются сообщения журнала о сбое SLA

sla_pass_log_period

псевдонимы: sla-pass-log-period

integer

Интервал в секундах, с которым создаются сообщения журнала об успешном прохождении SLA

system_dns

псевдонимы: system-dns

string

Включить или отключить использование системного DNS-сервера для проб.

Варианты:

• "disable"
• "enable"

threshold_alert_jitter

псевдонимы: threshold-alert-jitter

integer

Порог оповещения для джиттера

threshold_alert_latency

псевдонимы: threshold-alert-latency

integer

Порог оповещения для задержки

threshold_alert_packetloss

псевдонимы: threshold-alert-packetloss

integer

Порог оповещения для потери пакетов

threshold_warning_jitter

псевдонимы: threshold-warning-jitter

integer

Порог предупреждения для джиттера

threshold_warning_latency

псевдонимы: threshold-warning-latency

integer

Порог предупреждения для задержки

threshold_warning_packetloss

псевдонимы: threshold-warning-packetloss

integer

Порог предупреждения для потери пакетов

timeout

integer

Время ожидания ответа сервера, по истечении которого попытка подключения считается неудачной

update_cascade_interface

aliases: update-cascade-interface

string

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

Варианты:

• "disable"
• "enable"

update_static_route

aliases: update-static-route

string

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

Варианты:

• "disable"
• "enable"

load_balance_mode

aliases: load-balance-mode

string

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

Варианты:

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

members

list / elements=dictionary

Участники.

_dynamic_member

aliases: _dynamic-member

string

Динамический участник.

comment

string

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

cost

integer

Стоимость этого интерфейса для служб в режиме SLA

gateway

string

Шлюз по умолчанию для этого интерфейса.

gateway6

string

Шлюз IPv6.

ingress_spillover_threshold

aliases: ingress-spillover-threshold

integer

Порог входящего трафика для переключения на резервный интерфейс

interface

string

Имя интерфейса.

priority

integer

Приоритет интерфейса

seq_num

aliases: seq-num

integer

Порядковый номер

source

string

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

source6

string

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

spillover_threshold

aliases: spillover-threshold

integer

Порог исходящего трафика для переключения на резервный интерфейс

status

string

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

Варианты:

• "disable"
• "enable"

volume_ratio

aliases: volume-ratio

integer

Измеренное соотношение объёмов

weight

integer

Вес этого интерфейса при взвешенной балансировке нагрузки.

neighbor

list / elements=dictionary

Сосед.

health_check

aliases: health-check

string

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

ip

string

IP-адрес соседа.

member

string

Порядковый номер участника.

role

string

Роль соседа.

Варианты:

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

sla_id

aliases: sla-id

integer

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

neighbor_hold_boot_time

aliases: neighbor-hold-boot-time

integer

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

neighbor_hold_down

aliases: neighbor-hold-down

string

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

Варианты:

• "disable"
• "enable"

neighbor_hold_down_time

aliases: neighbor-hold-down-time

integer

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

service

list / elements=dictionary

Служба.

addr_mode

aliases: addr-mode

string

Режим адресации

Варианты:

• "ipv4"
• "ipv6"

bandwidth_weight

aliases: bandwidth-weight

integer

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

default

string

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

Варианты:

• "disable"
• "enable"

dscp_forward

aliases: dscp-forward

string

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

Варианты:

• "disable"
• "enable"

dscp_forward_tag

aliases: dscp-forward-tag

string

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

dscp_reverse

aliases: dscp-reverse

string

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

Варианты:

• "disable"
• "enable"

dscp_reverse_tag

aliases: dscp-reverse-tag

string

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

dst

any

(список или строка) Имя адреса назначения.

dst6

any

(список или строка) Имя адреса назначения IPv6.

dst_negate

aliases: dst-negate

string

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

Варианты:

• "disable"
• "enable"

end_port

aliases: end-port

integer

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

gateway

string

Включить/отключить шлюз службы SD-WAN.

Варианты:

• "disable"
• "enable"

groups

any

(список или строка) Группы пользователей.

health_check

aliases: health-check

string

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

hold_down_time

aliases: hold-down-time

integer

Период ожидания в секундах при переключении с резервного участника на основного

id

integer

Идентификатор правила приоритета

input_device

aliases: input-device

any

(список или строка) Имя исходного интерфейса.

input_device_negate

aliases: input-device-negate

string

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

Варианты:

• "disable"
• "enable"

internet_service

aliases: internet-service

string

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

Варианты:

• "disable"
• "enable"

internet_service_app_ctrl

aliases: internet-service-app-ctrl

any

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

internet_service_app_ctrl_group

aliases: internet-service-app-ctrl-group

any

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

internet_service_ctrl

aliases: internet-service-ctrl

any

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

internet_service_ctrl_group

aliases: internet-service-ctrl-group

any

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

internet_service_custom

aliases: internet-service-custom

any

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

internet_service_custom_group

aliases: internet-service-custom-group

any

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

internet_service_group

aliases: internet-service-group

any

(список или строка) Список групп интернет-сервисов.

internet_service_id

aliases: internet-service-id

any

(список или строка) Список идентификаторов интернет-сервисов.

internet_service_name

aliases: internet-service-name

string

Список названий интернет-сервисов.

jitter_weight

aliases: jitter-weight

integer

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

latency_weight

aliases: latency-weight

integer

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

link_cost_factor

aliases: link-cost-factor

string

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

Допустимые значения:

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

link_cost_threshold

aliases: link-cost-threshold

integer

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

member

string

Порядковый номер участника.

mode

string

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

Допустимые значения:

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

name

string

Название правила приоритета.

packet_loss_weight

aliases: packet-loss-weight

integer

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

priority_members

aliases: priority-members

any

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

protocol

integer

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

quality_link

aliases: quality-link

integer

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

role

string

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

Допустимые значения:

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

route_tag

aliases: route-tag

integer

Тег маршрута карты маршрутов IPv4.

sla

list / elements=dictionary

SLA.

health_check

aliases: health-check

string

Проверка работоспособности Virtual WAN Link.

id

integer

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

sla_compare_method

aliases: sla-compare-method

string

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

Допустимые значения:

• "order"
• "number"

src

any

(список или строка) Название исходного адреса.

src6

any

(список или строка) Название исходного адреса IPv6.

src_negate

aliases: src-negate

string

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

Допустимые значения:

• "disable"
• "enable"

standalone_action

aliases: standalone-action

string

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

Допустимые значения:

• "disable"
• "enable"

start_port

aliases: start-port

integer

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

status

string

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

Допустимые значения:

• "disable"
• "enable"

tos

string

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

tos_mask

aliases: tos-mask

string

Биты типа обслуживания для проверки.

users

any

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

status

string

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

Допустимые значения:

• "disable"
• "enable"

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочего пространства. Значением может быть global или другое значение, включая root.

workspace_locking_timeout

integer

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

По умолчанию: 300

meta

dictionary

Результат запроса.

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

request_url

string

Полный URL запроса.

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

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

Текстовое описание ответа API.

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

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

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

rc

integer

Статус запроса.

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

Пример: 0

version_check_warning

list / elements=string

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

Возвращается: при наличии сложных данных