Модуль fortinet.fortimanager.fmgr_wanprof_system_sdwan_healthcheck – проверка состояния 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, которыми будут переопределены условия успешного выполнения.

state

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

Указание на создание, обновление или удаление объекта.

Варианты:

• "present"
• "absent"

wanprof

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

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

wanprof_system_sdwan_healthcheck

dictionary

Набор параметров верхнего уровня.

_dynamic_server

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

string

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

addr_mode

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

string

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

Варианты:

• "ipv4"
• "ipv6"

agent_probe_timeout

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

integer

Время ожидания, прежде чем пробный пакет будет считаться потерянным, если для detect-mode задано значение agent

bandwidth_weight

псевдонимы: bandwidth-weight

integer

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

class_id

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

string

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

detect_mode

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

string

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

Варианты:

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

diffservcode

string

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

dns_match_ip

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

string

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

dns_request_domain

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

string

Полное доменное имя для разрешения при DNS-проверке.

embed_measured_health

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

string

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

Варианты:

• "disable"
• "enable"

failtime

integer

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

fortiguard

string

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

Варианты:

• "disable"
• "enable"

fortiguard_name

псевдонимы: fortiguard-name

any

(список) Имя предопределенной цели проверки состояния.

ftp_file

псевдонимы: ftp-file

string

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

ftp_mode

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

string

Режим FTP.

Варианты:

• "passive"
• "port"

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.

interval

integer

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

jitter_weight

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

integer

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

latency_weight

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

integer

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

members

any

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

mos_codec

псевдонимы: mos-codec

string

Кодек для расчета MOS

Варианты:

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

name

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

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

packet_loss_weight

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

integer

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

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"
• "tcp-connect"
• "ftp"
• "https"

quality_measured_method

псевдонимы: quality-measured-method

string

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

Варианты:

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

recoverytime

integer

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

remote_probe_timeout

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

integer

Время ожидания, прежде чем пробный пакет будет считаться потерянным, если для detect-mode задано значение remote

security_mode

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

string

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

Варианты:

• "none"
• "authentication"

server

any

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

sla

list / elements=dictionary

SLA.

custom_profile_threshold

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

integer

Порог пользовательского профиля для отметки SLA как выполненного

id

integer

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

jitter_threshold

aliases: jitter-threshold

integer

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

latency_threshold

aliases: latency-threshold

integer

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

link_cost_factor

aliases: link-cost-factor

list / elements=string

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

Варианты:

• "latency"
• "jitter"
• "packet-loss"
• "mos"
• "remote"
• "custom-profile-1"

mos_threshold

aliases: mos-threshold

string

Минимальная оценка качества передачи речи (MOS), при которой SLA считается выполненным.

packetloss_threshold

aliases: packetloss-threshold

integer

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

priority_in_sla

aliases: priority-in-sla

integer

Значение, добавляемое в таблицу маршрутизации при выполнении SLA

priority_out_sla

aliases: priority-out-sla

integer

Значение, добавляемое в таблицу маршрутизации при невыполнении SLA

sla_fail_log_period

aliases: sla-fail-log-period

integer

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

sla_id_redistribute

aliases: sla-id-redistribute

integer

Выберите идентификатор из подтаблицы SLA.

sla_pass_log_period

aliases: sla-pass-log-period

integer

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

source

string

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

source6

string

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

system_dns

aliases: system-dns

string

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

Варианты:

• "disable"
• "enable"

threshold_alert_jitter

aliases: threshold-alert-jitter

integer

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

threshold_alert_latency

aliases: threshold-alert-latency

integer

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

threshold_alert_packetloss

aliases: threshold-alert-packetloss

integer

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

threshold_warning_jitter

aliases: threshold-warning-jitter

integer

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

threshold_warning_latency

aliases: threshold-warning-latency

integer

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

threshold_warning_packetloss

aliases: threshold-warning-packetloss

integer

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

update_bgp_route

aliases: update-bgp-route

string

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

Варианты:

• "disable"
• "enable"

update_cascade_interface

aliases: update-cascade-interface

string

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

Варианты:

• "disable"
• "enable"

update_static_route

aliases: update-static-route

string

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

Варианты:

• "disable"
• "enable"

user

string

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

vrf

integer

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

workspace_locking_adom

string

ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области; в качестве значения можно указать global и другие ADOM, включая 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.

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