Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните команду ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.

Чтобы использовать его в плейбуке, укажите: fortinet.fortios.fortios_system_sdwan.

Добавлено в fortinet.fortios 2.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя системные функции и категорию sdwan. В примерах приведены все параметры и значения, которые перед использованием необходимо адаптировать к источникам данных. Проверено с FOS v6.0.0

Требования

На хосте, выполняющем этот модуль, должны быть установлены следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

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

enable_log

boolean

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

Варианты:

  • false ← (по умолчанию)
  • 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 / обязательный

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

dstaddr6

list / elements=dictionary

Адрес IPv6 назначения или имена групп адресов IPv6.

name

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

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

dstintf

list / elements=dictionary

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

name

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

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

id

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

Идентификатор правила дублирования (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 / обязательный

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

service_id

list / elements=dictionary

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

id

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

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

sla_match_service

string

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

Варианты:

  • "enable"
  • "disable"

srcaddr

list / elements=dictionary

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

name

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

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

srcaddr6

list / elements=dictionary

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

name

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

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

srcintf

list / elements=dictionary

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

name

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

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

duplication_max_discrepancy

integer

Максимальное расхождение между двумя пакетами для устранения дубликатов, в миллисекундах (250–1000).

duplication_max_num

integer

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

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"

agent_probe_timeout

integer

Время ожидания до признания пробного пакета потерянным, если detect-mode имеет значение agent (5000–3600*1000 мс).

bandwidth_weight

integer

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

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

fortiguard

string

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

Варианты:

  • "disable"
  • "enable"

fortiguard_name

string

Имя предопределенной цели проверки работоспособности. Источник: system.health-check-fortiguard.name.

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

jitter_weight

integer

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

latency_weight

integer

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

members

list / elements=dictionary

Список порядковых номеров элементов.

seq_num

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

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

mos_codec

string

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

Варианты:

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

name

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

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

packet_loss_weight

integer

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

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.

Варианты:

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

recoverytime

integer

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

remote_probe_timeout

integer

Время ожидания, по истечении которого пробный пакет считается потерянным, если для detect-mode задано значение remote (20–3600*1000 мс).

security_mode

string

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

Варианты:

  • "none"
  • "authentication"

server

list / elements=string

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

sla

list / elements=dictionary

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

custom_profile_threshold

integer

Пороговое значение пользовательского профиля, при котором SLA считается выполненным (0–10000000).

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"
  • "custom-profile-1"
  • "mos"
  • "remote"

mos_threshold

string

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

packetloss_threshold

integer

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

priority_in_sla

integer

Значение, добавляемое в таблицу маршрутизации при соблюдении SLA (0–65535).

priority_out_sla

integer

Значение, добавляемое в таблицу маршрутизации при несоблюдении SLA (0–65535).

sla_fail_log_period

integer

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

sla_id_redistribute

integer

Выберите идентификатор из подтаблицы SLA. Значение приоритета выбранного SLA будет добавлено в таблицу маршрутизации (0–32).

sla_pass_log_period

integer

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

source

string

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

source6

string

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

system_dns

string

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

Варианты:

  • "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_bgp_route

string

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

Варианты:

  • "enable"
  • "disable"

update_cascade_interface

string

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

Варианты:

  • "enable"
  • "disable"

update_static_route

string

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

Варианты:

  • "enable"
  • "disable"

user

string

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

vrf

integer

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

health_check_fortiguard

list / elements=dictionary

Проверка состояния SD-WAN или проверка работоспособности. Укажите предварительно определённый FortiGuard сервер и задайте способ проверки связи FGT с ним средствами SD-WAN.

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

Приоритет при выборе узла высокой доступности (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 / обязательный

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

mos_codec

string

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

Варианты:

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

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"

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-адрес или доменное имя FQDN из FortiGuard.

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"
  • "mos"
  • "remote"

mos_threshold

string

Минимальная средняя оценка качества (MOS), необходимая для успешного прохождения SLA (1,0–5,0).

packetloss_threshold

integer

Пороговое значение потери пакетов для принятия решения по SLA, в процентах (0–100).

priority_in_sla

integer

Значение, добавляемое в таблицу маршрутизации при соблюдении SLA (0–65535).

priority_out_sla

integer

Значение, добавляемое в таблицу маршрутизации при несоблюдении SLA (0–65535).

sla_fail_log_period

integer

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

sla_id_redistribute

integer

Выберите идентификатор из подтаблицы SLA. Значение приоритета выбранного SLA будет добавлено в таблицу маршрутизации (0–32).

sla_pass_log_period

integer

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

source

string

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

source6

string

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

system_dns

string

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

Варианты:

  • "disable"
  • "enable"

target_name

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

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

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"

user

string

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

vrf

integer

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

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, добавленные в 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 или правил приоритета.

priority_in_sla

integer

Предпочтительный приоритет маршрутов к этому участнику, когда он соответствует SLA (0–65535).

priority_out_sla

integer

Предпочтительный приоритет маршрутов к этому участнику, когда он не соответствует SLA (0–65535).

seq_num

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

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

source

string

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

source6

string

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

spillover_threshold

integer

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

status

string

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

Варианты:

  • "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 / обязательный

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

member

list / elements=dictionary

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

seq_num

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

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

minimum_sla_meet_members

integer

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

mode

string

Метрика для выбора соседа.

Варианты:

  • "sla"
  • "speedtest"

role

string

Роль соседа.

Варианты:

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

route_metric

string

Метрика маршрута соседа.

Варианты:

  • "preferable"
  • "priority"

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.

comment

string

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

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

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

name

string / required

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

dst_negate

string

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

Варианты:

  • "enable"
  • "disable"

end_port

integer

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

end_src_port

integer

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

fib_best_match_force

string

Включить/отключить принудительное использование fib-best-match oif в качестве исходящего интерфейса.

Варианты:

  • "disable"
  • "enable"

gateway

string

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

Варианты:

  • "enable"
  • "disable"

groups

list / elements=dictionary

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

name

string / required

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

hash_mode

string

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

Варианты:

  • "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

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

Варианты:

  • "enable"
  • "disable"

input_zone

list / elements=dictionary

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

name

string / required

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

internet_service

string

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

Варианты:

  • "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_fortiguard

list / elements=dictionary

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

name

string / required

Имя интернет-службы FortiGuard. Источник: firewall.internet-service-fortiguard.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 / обязательный

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

priority_zone

list / elements=dictionary

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

name

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

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

protocol

integer

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

quality_link

integer

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

role

string

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

Варианты:

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

route_tag

integer

Тег маршрута route-tag карты маршрутизации IPv4.

shortcut

string

Включить или отключить shortcut для этой службы.

Варианты:

  • "enable"
  • "disable"

shortcut_priority

string

Высокий приоритет shortcut ADVPN для этой службы.

Варианты:

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

shortcut_stickiness

string

Включить или отключить закрепление shortcut в ADVPN.

Варианты:

  • "enable"
  • "disable"

sla

list / elements=dictionary

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

health_check

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

Проверка работоспособности 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 / обязательный

Имя адреса или группы адресов. Источник: 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

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

Варианты:

  • "enable"
  • "disable"

start_port

integer

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

start_src_port

integer

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

status

string

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

Варианты:

  • "enable"
  • "disable"

tie_break

string

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

Варианты:

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

tos

string

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

tos_mask

string

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

use_shortcut_sla

string

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

Варианты:

  • "enable"
  • "disable"

users

list / elements=dictionary

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

name

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

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

zone_mode

string

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

Варианты:

  • "enable"
  • "disable"

speedtest_bypass_routing

string

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

Варианты:

  • "disable"
  • "enable"

status

string

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

Варианты:

  • "disable"
  • "enable"

zone

list / elements=dictionary

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

advpn_health_check

string

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

advpn_select

string

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

Варианты:

  • "enable"
  • "disable"

minimum_sla_meet_members

integer

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

name

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

Имя зоны.

service_sla_tie_break

string

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

Варианты:

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

vdom

string

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

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

Примечания

Примечание

  • Устаревший fortiosapi объявлен устаревшим; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure redundant Internet connections with multiple outbound links and health-check profiles.
  fortinet.fortios.fortios_system_sdwan:
      vdom: "{{ vdom }}"
      system_sdwan:
          app_perf_log_period: "0"
          duplication:
              -
                  dstaddr:
                      -
                          name: "default_name_6 (source firewall.address.name firewall.addrgrp.name)"
                  dstaddr6:
                      -
                          name: "default_name_8 (source firewall.address6.name firewall.addrgrp6.name)"
                  dstintf:
                      -
                          name: "default_name_10 (source system.interface.name system.zone.name system.sdwan.zone.name)"
                  id: "11"
                  packet_de_duplication: "enable"
                  packet_duplication: "disable"
                  service:
                      -
                          name: "default_name_15 (source firewall.service.custom.name firewall.service.group.name)"
                  service_id:
                      -
                          id: "17 (source system.sdwan.service.id)"
                  sla_match_service: "enable"
                  srcaddr:
                      -
                          name: "default_name_20 (source firewall.address.name firewall.addrgrp.name)"
                  srcaddr6:
                      -
                          name: "default_name_22 (source firewall.address6.name firewall.addrgrp6.name)"
                  srcintf:
                      -
                          name: "default_name_24 (source system.interface.name system.zone.name system.sdwan.zone.name)"
          duplication_max_discrepancy: "250"
          duplication_max_num: "2"
          fail_alert_interfaces:
              -
                  name: "default_name_28 (source system.interface.name)"
          fail_detect: "enable"
          health_check:
              -
                  addr_mode: "ipv4"
                  agent_probe_timeout: "60000"
                  bandwidth_weight: "0"
                  class_id: "0"
                  detect_mode: "active"
                  diffservcode: "<your_own_value>"
                  dns_match_ip: "<your_own_value>"
                  dns_request_domain: "<your_own_value>"
                  embed_measured_health: "enable"
                  failtime: "5"
                  fortiguard: "disable"
                  fortiguard_name: "<your_own_value> (source system.health-check-fortiguard.name)"
                  ftp_file: "<your_own_value>"
                  ftp_mode: "passive"
                  ha_priority: "1"
                  http_agent: "<your_own_value>"
                  http_get: "<your_own_value>"
                  http_match: "<your_own_value>"
                  interval: "500"
                  jitter_weight: "0"
                  latency_weight: "0"
                  members:
                      -
                          seq_num: "<you_own_value>"
                  mos_codec: "g711"
                  name: "default_name_55"
                  packet_loss_weight: "0"
                  packet_size: "124"
                  password: "<your_own_value>"
                  port: "0"
                  probe_count: "30"
                  probe_packets: "disable"
                  probe_timeout: "500"
                  protocol: "ping"
                  quality_measured_method: "half-open"
                  recoverytime: "5"
                  remote_probe_timeout: "5000"
                  security_mode: "none"
                  server: "192.168.100.40"
                  sla:
                      -
                          custom_profile_threshold: "0"
                          id: "71"
                          jitter_threshold: "5"
                          latency_threshold: "5"
                          link_cost_factor: "latency"
                          mos_threshold: "<your_own_value>"
                          packetloss_threshold: "0"
                          priority_in_sla: "0"
                          priority_out_sla: "0"
                  sla_fail_log_period: "0"
                  sla_id_redistribute: "0"
                  sla_pass_log_period: "0"
                  source: "<your_own_value>"
                  source6: "<your_own_value>"
                  system_dns: "disable"
                  threshold_alert_jitter: "0"
                  threshold_alert_latency: "0"
                  threshold_alert_packetloss: "0"
                  threshold_warning_jitter: "0"
                  threshold_warning_latency: "0"
                  threshold_warning_packetloss: "0"
                  update_bgp_route: "enable"
                  update_cascade_interface: "enable"
                  update_static_route: "enable"
                  user: "<your_own_value>"
                  vrf: "0"
          health_check_fortiguard:
              -
                  addr_mode: "ipv4"
                  class_id: "0"
                  detect_mode: "active"
                  diffservcode: "<your_own_value>"
                  dns_match_ip: "<your_own_value>"
                  dns_request_domain: "<your_own_value>"
                  embed_measured_health: "enable"
                  failtime: "5"
                  ftp_file: "<your_own_value>"
                  ftp_mode: "passive"
                  ha_priority: "1"
                  http_agent: "<your_own_value>"
                  http_get: "<your_own_value>"
                  http_match: "<your_own_value>"
                  interval: "500"
                  members:
                      -
                          seq_num: "<you_own_value>"
                  mos_codec: "g711"
                  packet_size: "124"
                  password: "<your_own_value>"
                  port: "0"
                  probe_count: "30"
                  probe_packets: "disable"
                  probe_timeout: "500"
                  protocol: "ping"
                  quality_measured_method: "half-open"
                  recoverytime: "5"
                  security_mode: "none"
                  server: "192.168.100.40"
                  sla:
                      -
                          id: "127"
                          jitter_threshold: "5"
                          latency_threshold: "5"
                          link_cost_factor: "latency"
                          mos_threshold: "<your_own_value>"
                          packetloss_threshold: "0"
                          priority_in_sla: "0"
                          priority_out_sla: "0"
                  sla_fail_log_period: "0"
                  sla_id_redistribute: "0"
                  sla_pass_log_period: "0"
                  source: "<your_own_value>"
                  source6: "<your_own_value>"
                  system_dns: "disable"
                  target_name: "<your_own_value>"
                  threshold_alert_jitter: "0"
                  threshold_alert_latency: "0"
                  threshold_alert_packetloss: "0"
                  threshold_warning_jitter: "0"
                  threshold_warning_latency: "0"
                  threshold_warning_packetloss: "0"
                  update_cascade_interface: "enable"
                  update_static_route: "enable"
                  user: "<your_own_value>"
                  vrf: "0"
          load_balance_mode: "source-ip-based"
          members:
              -
                  comment: "Comments."
                  cost: "0"
                  gateway: "<your_own_value>"
                  gateway6: "<your_own_value>"
                  ingress_spillover_threshold: "0"
                  interface: "<your_own_value> (source system.interface.name)"
                  preferred_source: "<your_own_value>"
                  priority: "1"
                  priority_in_sla: "0"
                  priority_out_sla: "0"
                  priority6: "1024"
                  seq_num: "<you_own_value>"
                  source: "<your_own_value>"
                  source6: "<your_own_value>"
                  spillover_threshold: "0"
                  status: "disable"
                  transport_group: "0"
                  volume_ratio: "1"
                  weight: "1"
                  zone: "<your_own_value> (source system.sdwan.zone.name)"
          neighbor:
              -
                  health_check: "<your_own_value> (source system.sdwan.health-check.name)"
                  ip: "<your_own_value> (source router.bgp.neighbor-group.name router.bgp.neighbor.ip)"
                  member:
                      -
                          seq_num: "<you_own_value>"
                  minimum_sla_meet_members: "1"
                  mode: "sla"
                  role: "standalone"
                  route_metric: "preferable"
                  service_id: "0"
                  sla_id: "0"
          neighbor_hold_boot_time: "0"
          neighbor_hold_down: "enable"
          neighbor_hold_down_time: "0"
          service:
              -
                  addr_mode: "ipv4"
                  agent_exclusive: "enable"
                  bandwidth_weight: "0"
                  comment: "Comments."
                  default: "enable"
                  dscp_forward: "enable"
                  dscp_forward_tag: "<your_own_value>"
                  dscp_reverse: "enable"
                  dscp_reverse_tag: "<your_own_value>"
                  dst:
                      -
                          name: "default_name_199 (source firewall.address.name firewall.addrgrp.name)"
                  dst_negate: "enable"
                  dst6:
                      -
                          name: "default_name_202 (source firewall.address6.name firewall.addrgrp6.name)"
                  end_port: "65535"
                  end_src_port: "65535"
                  fib_best_match_force: "disable"
                  gateway: "enable"
                  groups:
                      -
                          name: "default_name_208 (source user.group.name)"
                  hash_mode: "round-robin"
                  health_check:
                      -
                          name: "default_name_211 (source system.sdwan.health-check.name)"
                  hold_down_time: "0"
                  id: "213"
                  input_device:
                      -
                          name: "default_name_215 (source system.interface.name)"
                  input_device_negate: "enable"
                  input_zone:
                      -
                          name: "default_name_218 (source system.sdwan.zone.name)"
                  internet_service: "enable"
                  internet_service_app_ctrl:
                      -
                          id: "221"
                  internet_service_app_ctrl_category:
                      -
                          id: "223"
                  internet_service_app_ctrl_group:
                      -
                          name: "default_name_225 (source application.group.name)"
                  internet_service_custom:
                      -
                          name: "default_name_227 (source firewall.internet-service-custom.name)"
                  internet_service_custom_group:
                      -
                          name: "default_name_229 (source firewall.internet-service-custom-group.name)"
                  internet_service_fortiguard:
                      -
                          name: "default_name_231 (source firewall.internet-service-fortiguard.name)"
                  internet_service_group:
                      -
                          name: "default_name_233 (source firewall.internet-service-group.name)"
                  internet_service_name:
                      -
                          name: "default_name_235 (source firewall.internet-service-name.name)"
                  jitter_weight: "0"
                  latency_weight: "0"
                  link_cost_factor: "latency"
                  link_cost_threshold: "10"
                  load_balance: "enable"
                  minimum_sla_meet_members: "0"
                  mode: "auto"
                  name: "default_name_243"
                  packet_loss_weight: "0"
                  passive_measurement: "enable"
                  priority_members:
                      -
                          seq_num: "<you_own_value>"
                  priority_zone:
                      -
                          name: "default_name_249 (source system.sdwan.zone.name)"
                  protocol: "0"
                  quality_link: "0"
                  role: "standalone"
                  route_tag: "0"
                  shortcut: "enable"
                  shortcut_priority: "enable"
                  shortcut_stickiness: "enable"
                  sla:
                      -
                          health_check: "<your_own_value> (source system.sdwan.health-check.name)"
                          id: "259"
                  sla_compare_method: "order"
                  sla_stickiness: "enable"
                  src:
                      -
                          name: "default_name_263 (source firewall.address.name firewall.addrgrp.name)"
                  src_negate: "enable"
                  src6:
                      -
                          name: "default_name_266 (source firewall.address6.name firewall.addrgrp6.name)"
                  standalone_action: "enable"
                  start_port: "1"
                  start_src_port: "1"
                  status: "enable"
                  tie_break: "zone"
                  tos: "<your_own_value>"
                  tos_mask: "<your_own_value>"
                  use_shortcut_sla: "enable"
                  users:
                      -
                          name: "default_name_276 (source user.local.name)"
                  zone_mode: "enable"
          speedtest_bypass_routing: "disable"
          status: "disable"
          zone:
              -
                  advpn_health_check: "<your_own_value> (source system.sdwan.health-check.name)"
                  advpn_select: "enable"
                  minimum_sla_meet_members: "1"
                  name: "default_name_284"
                  service_sla_tie_break: "cfg-order"

Возвращаемые значения

Общие возвращаемые значения описаны здесь, ниже перечислены поля, уникальные для этого модуля:

Ключ

Описание

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"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 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_sdwan_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API