Spec-Zone.ru › Ansible

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

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_wanprof_system_sdwan.

Добавлено в fortinet.fortimanager 2.1.0

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

  • Этот модуль позволяет настраивать устройство FortiManager.
  • В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием.

Параметры

Параметр

Комментарии

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_sdwan

dictionary

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

app_perf_log_period

псевдонимы: app-perf-log-period

integer

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

duplication

list / elements=dictionary

Дублирование.

dstaddr

any

(список или строка) Адрес назначения или имена групп адресов.

dstaddr6

any

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

dstintf

any

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

id

integer

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

packet_de_duplication

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

string

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

Варианты:

  • "disable"
  • "enable"

packet_duplication

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

string

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

Варианты:

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

service

any

(список или строка) Имя службы или группы служб.

service_id

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

any

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

sla_match_service

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

string

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

Варианты:

  • "disable"
  • "enable"

srcaddr

any

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

srcaddr6

any

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

srcintf

any

(список или строка) Входящий интерфейс

duplication_max_discrepancy

псевдонимы: duplication-max-discrepancy

integer

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

duplication_max_num

псевдонимы: duplication-max-num

integer

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

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"

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

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

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

integer

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

latency_threshold

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

integer

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

link_cost_factor

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

list / elements=string

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

Варианты:

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

mos_threshold

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

string

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

packetloss_threshold

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

integer

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

priority_in_sla

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

integer

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

priority_out_sla

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

integer

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

sla_fail_log_period

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

integer

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

sla_id_redistribute

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

integer

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

sla_pass_log_period

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

integer

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

source

string

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

source6

string

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

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

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

update_bgp_route

псевдонимы: update-bgp-route

string

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

Варианты:

  • "disable"
  • "enable"

update_cascade_interface

псевдонимы: update-cascade-interface

string

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

Варианты:

  • "disable"
  • "enable"

update_static_route

псевдонимы: update-static-route

string

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

Варианты:

  • "disable"
  • "enable"

user

string

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

vrf

integer

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

health_check_fortiguard

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

list / elements=dictionary

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

addr_mode

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

string

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

Варианты:

  • "ipv4"
  • "ipv6"

class_id

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

any

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

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

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

ftp_file

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

string

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

ftp_mode

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

string

Режим FTP.

Варианты:

  • "passive"
  • "port"

ha_priority

aliases: ha-priority

integer

Приоритет выбора HA

http_agent

aliases: http-agent

string

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

http_get

aliases: http-get

string

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

http_match

aliases: http-match

string

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

interval

integer

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

members

any

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

mos_codec

aliases: mos-codec

string

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

Варианты:

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

packet_size

aliases: packet-size

integer

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

password

any

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

port

integer

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

probe_count

aliases: probe-count

integer

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

probe_packets

aliases: probe-packets

string

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

Варианты:

  • "disable"
  • "enable"

probe_timeout

aliases: probe-timeout

integer

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

protocol

string

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

Варианты:

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

quality_measured_method

aliases: quality-measured-method

string

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

Варианты:

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

recoverytime

integer

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

security_mode

aliases: security-mode

string

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

Варианты:

  • "none"
  • "authentication"

server

any

(список) Предопределённый IP-адрес или имя FQDN из FortiGuard.

sla

list / elements=dictionary

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"

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"

target_name

aliases: target-name

string

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

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_cascade_interface

aliases: update-cascade-interface

string

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

Варианты:

  • "disable"
  • "enable"

update_static_route

aliases: update-static-route

string

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

Варианты:

  • "disable"
  • "enable"

user

string

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

vrf

integer

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

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

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

preferred_source

aliases: preferred-source

string

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

priority

integer

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

priority6

integer

Приоритет интерфейса для IPv6

priority_in_sla

aliases: priority-in-sla

integer

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

priority_out_sla

aliases: priority-out-sla

integer

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

seq_num

aliases: seq-num

integer

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

source

string

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

source6

string

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

spillover_threshold

aliases: spillover-threshold

integer

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

status

string

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

Варианты:

  • "disable"
  • "enable"

transport_group

aliases: transport-group

integer

Измеренная транспортная группа

volume_ratio

aliases: volume-ratio

integer

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

weight

integer

Вес этого интерфейса для балансировки нагрузки с учётом весов.

zone

string

Имя зоны.

neighbor

list / elements=dictionary

Сосед.

health_check

aliases: health-check

string

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

ip

string

IP- или IPv6-адрес соседа.

member

any

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

minimum_sla_meet_members

aliases: minimum-sla-meet-members

integer

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

mode

string

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

Варианты:

  • "sla"
  • "speedtest"

role

string

Роль соседа.

Варианты:

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

route_metric

aliases: route-metric

string

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

Варианты:

  • "preferable"
  • "priority"

service_id

aliases: service-id

string

Идентификатор службы SD-WAN, связанной с соседом.

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

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

option

list / elements=string

Параметр.

Варианты:

  • "sdwan-overlay"
  • "sdwan-manager"

service

list / elements=dictionary

Служба.

addr_mode

aliases: addr-mode

string

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

Варианты:

  • "ipv4"
  • "ipv6"

agent_exclusive

aliases: agent-exclusive

string

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

Варианты:

  • "disable"
  • "enable"

bandwidth_weight

aliases: bandwidth-weight

integer

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

comment

string

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

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

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

end_src_port

aliases: end-src-port

integer

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

fib_best_match_force

aliases: fib-best-match-force

string

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

Варианты:

  • "disable"
  • "enable"

gateway

string

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

Варианты:

  • "disable"
  • "enable"

groups

any

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

hash_mode

aliases: hash-mode

string

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

Варианты:

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

health_check

aliases: health-check

any

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

hold_down_time

aliases: hold-down-time

integer

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

id

integer

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

input_device

aliases: input-device

any

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

input_device_negate

aliases: input-device-negate

string

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

Варианты:

  • "disable"
  • "enable"

input_zone

aliases: input-zone

any

(список) Имя исходной зоны ввода.

internet_service

aliases: internet-service

string

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

Варианты:

  • "disable"
  • "enable"

internet_service_app_ctrl

aliases: internet-service-app-ctrl

any

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

internet_service_app_ctrl_category

aliases: internet-service-app-ctrl-category

any

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

internet_service_app_ctrl_group

aliases: internet-service-app-ctrl-group

any

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

internet_service_custom

aliases: internet-service-custom

any

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

internet_service_custom_group

aliases: internet-service-custom-group

any

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

internet_service_fortiguard

aliases: internet-service-fortiguard

any

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

internet_service_group

aliases: internet-service-group

any

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

internet_service_name

aliases: internet-service-name

any

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

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

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

load_balance

aliases: load-balance

string

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

Варианты:

  • "disable"
  • "enable"

minimum_sla_meet_members

aliases: 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

aliases: packet-loss-weight

integer

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

passive_measurement

aliases: passive-measurement

string

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

Варианты:

  • "disable"
  • "enable"

priority_members

aliases: priority-members

any

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

priority_zone

aliases: priority-zone

any

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

protocol

integer

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

quality_link

aliases: quality-link

integer

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

role

string

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

Варианты:

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

route_tag

aliases: route-tag

integer

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

shortcut

string

Включение/отключение ярлыка для этой службы.

Варианты:

  • "disable"
  • "enable"

shortcut_priority

aliases: shortcut-priority

string

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

Варианты:

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

shortcut_stickiness

aliases: shortcut-stickiness

string

Включение/отключение закрепления ярлыка ADVPN.

Варианты:

  • "disable"
  • "enable"

sla

list / elements=dictionary

SLA.

health_check

aliases: health-check

string

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

id

integer

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

sla_compare_method

aliases: sla-compare-method

string

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

Варианты:

  • "order"
  • "number"

sla_stickiness

aliases: sla-stickiness

string

Включение/отключение закрепления SLA.

Варианты:

  • "disable"
  • "enable"

src

any

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

src6

any

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

src_negate

aliases: src-negate

string

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

Варианты:

  • "disable"
  • "enable"

standalone_action

aliases: standalone-action

string

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

Варианты:

  • "disable"
  • "enable"

start_port

aliases: start-port

integer

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

start_src_port

aliases: start-src-port

integer

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

status

string

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

Варианты:

  • "disable"
  • "enable"

tie_break

aliases: tie-break

string

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

Варианты:

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

tos

string

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

tos_mask

aliases: tos-mask

string

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

use_shortcut_sla

aliases: use-shortcut-sla

string

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

Варианты:

  • "disable"
  • "enable"

users

any

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

zone_mode

aliases: zone-mode

string

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

Варианты:

  • "disable"
  • "enable"

speedtest_bypass_routing

aliases: speedtest-bypass-routing

string

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

Варианты:

  • "disable"
  • "enable"

status

string

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

Варианты:

  • "disable"
  • "enable"

zone

list / elements=dictionary

Зона.

advpn_health_check

aliases: advpn-health-check

string

Проверка работоспособности качества локального канала оверлея ADVPN.

advpn_select

aliases: advpn-select

string

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

Варианты:

  • "disable"
  • "enable"

minimum_sla_meet_members

aliases: minimum-sla-meet-members

integer

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

name

string

Имя зоны.

service_sla_tie_break

aliases: service-sla-tie-break

string

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

Варианты:

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

workspace_locking_adom

string

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

workspace_locking_timeout

integer

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

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

Примечания

Примечание

  • Начиная с версии 2.4.0, для всех входных аргументов используется соглашение об именовании с подчеркиванием (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Это предупреждение можно игнорировать, задав deprecation_warnings=False в ansible.cfg.
  • В этом модуле FortiManager поддерживается работа в режиме блокировки рабочей области; для этого предназначены параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
  • Обычно выполнение модуля может завершиться ошибкой, если возвращен ненулевой код rc. Также можно изменить условия завершения с ошибкой или успехом с помощью параметров rc_failed и rc_succeeded.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure redundant internet connections using SD-WAN
      fortinet.fortimanager.fmgr_wanprof_system_sdwan:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        wanprof: <your own value>
        wanprof_system_sdwan:
          # duplication:
          #   - dstaddr: <list or string>
          #     dstaddr6: <list or string>
          #     dstintf: <list or string>
          #     id: <integer>
          #     packet_de_duplication: <value in [disable, enable]>
          #     packet_duplication: <value in [disable, force, on-demand]>
          #     service: <list or string>
          #     srcaddr: <list or string>
          #     srcaddr6: <list or string>
          #     srcintf: <list or string>
          #     service_id: <list or string>
          #     sla_match_service: <value in [disable, enable]>
          # duplication_max_num: <integer>
          # fail_detect: <value in [disable, enable]>
          # health_check:
          #   - _dynamic_server: <string>
          #     addr_mode: <value in [ipv4, ipv6]>
          #     diffservcode: <string>
          #     dns_match_ip: <string>
          #     dns_request_domain: <string>
          #     failtime: <integer>
          #     ftp_file: <string>
          #     ftp_mode: <value in [passive, port]>
          #     ha_priority: <integer>
          #     http_agent: <string>
          #     http_get: <string>
          #     http_match: <string>
          #     interval: <integer>
          #     members: <list or string>
          #     name: <string>
          #     packet_size: <integer>
          #     password: <list or string>
          #     port: <integer>
          #     probe_count: <integer>
          #     probe_packets: <value in [disable, enable]>
          #     probe_timeout: <integer>
          #     protocol: <value in [ping, tcp-echo, udp-echo, ...]>
          #     quality_measured_method: <value in [half-close, half-open]>
          #     recoverytime: <integer>
          #     security_mode: <value in [none, authentication]>
          #     server: <list or string>
          #     sla:
          #       - id: <integer>
          #         jitter_threshold: <integer>
          #         latency_threshold: <integer>
          #         link_cost_factor: ["latency", "jitter", "packet-loss", "mos", "remote",
          #                            "custom-profile-1"]
          #         packetloss_threshold: <integer>
          #         mos_threshold: <string>
          #         priority_in_sla: <integer>
          #         priority_out_sla: <integer>
          #         custom_profile_threshold: <integer>
          #     sla_fail_log_period: <integer>
          #     sla_pass_log_period: <integer>
          #     system_dns: <value in [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: <value in [disable, enable]>
          #     update_static_route: <value in [disable, enable]>
          #     user: <string>
          #     detect_mode: <value in [active, passive, prefer-passive, ...]>
          #     mos_codec: <value in [g711, g722, g729]>
          #     source: <string>
          #     vrf: <integer>
          #     embed_measured_health: <value in [disable, enable]>
          #     sla_id_redistribute: <integer>
          #     class_id: <string>
          #     source6: <string>
          #     fortiguard: <value in [disable, enable]>
          #     fortiguard_name: <list or string>
          #     agent_probe_timeout: <integer>
          #     remote_probe_timeout: <integer>
          #     bandwidth_weight: <integer>
          #     jitter_weight: <integer>
          #     latency_weight: <integer>
          #     packet_loss_weight: <integer>
          #     update_bgp_route: <value in [disable, enable]>
          # load_balance_mode: <value in [source-ip-based, weight-based, usage-based, ...]>
          # members:
          #   - _dynamic_member: <string>
          #     comment: <string>
          #     cost: <integer>
          #     gateway: <string>
          #     gateway6: <string>
          #     ingress_spillover_threshold: <integer>
          #     interface: <string>
          #     priority: <integer>
          #     seq_num: <integer>
          #     source: <string>
          #     source6: <string>
          #     spillover_threshold: <integer>
          #     status: <value in [disable, enable]>
          #     volume_ratio: <integer>
          #     weight: <integer>
          #     zone: <string>
          #     priority6: <integer>
          #     preferred_source: <string>
          #     transport_group: <integer>
          #     priority_in_sla: <integer>
          #     priority_out_sla: <integer>
          # neighbor:
          #   - health_check: <string>
          #     ip: <string>
          #     member: <list or string>
          #     role: <value in [primary, secondary, standalone]>
          #     sla_id: <integer>
          #     minimum_sla_meet_members: <integer>
          #     mode: <value in [sla, speedtest]>
          #     service_id: <string>
          #     route_metric: <value in [preferable, priority]>
          # neighbor_hold_boot_time: <integer>
          # neighbor_hold_down: <value in [disable, enable]>
          # neighbor_hold_down_time: <integer>
          # service:
          #   - addr_mode: <value in [ipv4, ipv6]>
          #     bandwidth_weight: <integer>
          #     default: <value in [disable, enable]>
          #     dscp_forward: <value in [disable, enable]>
          #     dscp_forward_tag: <string>
          #     dscp_reverse: <value in [disable, enable]>
          #     dscp_reverse_tag: <string>
          #     dst: <list or string>
          #     dst_negate: <value in [disable, enable]>
          #     dst6: <list or string>
          #     end_port: <integer>
          #     gateway: <value in [disable, enable]>
          #     groups: <list or string>
          #     hash_mode: <value in [round-robin, source-ip-based, source-dest-ip-based, ...]>
          #     health_check: <list or string>
          #     hold_down_time: <integer>
          #     id: <integer>
          #     input_device: <list or string>
          #     input_device_negate: <value in [disable, enable]>
          #     internet_service: <value in [disable, enable]>
          #     internet_service_app_ctrl: <list or integer>
          #     internet_service_app_ctrl_group: <list or string>
          #     internet_service_custom: <list or string>
          #     internet_service_custom_group: <list or string>
          #     internet_service_group: <list or string>
          #     internet_service_name: <list or string>
          #     jitter_weight: <integer>
          #     latency_weight: <integer>
          #     link_cost_factor: <value in [latency, jitter, packet-loss, ...]>
          #     link_cost_threshold: <integer>
          #     minimum_sla_meet_members: <integer>
          #     mode: <value in [auto, manual, priority, ...]>
          #     name: <string>
          #     packet_loss_weight: <integer>
          #     priority_members: <list or string>
          #     protocol: <integer>
          #     quality_link: <integer>
          #     role: <value in [primary, secondary, standalone]>
          #     route_tag: <integer>
          #     sla:
          #       - health_check: <string>
          #         id: <integer>
          #     sla_compare_method: <value in [order, number]>
          #     src: <list or string>
          #     src_negate: <value in [disable, enable]>
          #     src6: <list or string>
          #     standalone_action: <value in [disable, enable]>
          #     start_port: <integer>
          #     status: <value in [disable, enable]>
          #     tos: <string>
          #     tos_mask: <string>
          #     users: <list or string>
          #     tie_break: <value in [zone, cfg-order, fib-best-match, ...]>
          #     use_shortcut_sla: <value in [disable, enable]>
          #     input_zone: <list or string>
          #     internet_service_app_ctrl_category: <list or integer>
          #     passive_measurement: <value in [disable, enable]>
          #     priority_zone: <list or string>
          #     agent_exclusive: <value in [disable, enable]>
          #     shortcut: <value in [disable, enable]>
          #     shortcut_stickiness: <value in [disable, enable]>
          #     end_src_port: <integer>
          #     load_balance: <value in [disable, enable]>
          #     sla_stickiness: <value in [disable, enable]>
          #     start_src_port: <integer>
          #     zone_mode: <value in [disable, enable]>
          #     shortcut_priority: <value in [disable, enable, auto]>
          #     comment: <string>
          #     fib_best_match_force: <value in [disable, enable]>
          #     internet_service_fortiguard: <list or string>
          # status: <value in [disable, enable]>
          # zone:
          #   - name: <string>
          #     service_sla_tie_break: <value in [cfg-order, fib-best-match, input-device, ...]>
          #     minimum_sla_meet_members: <integer>
          #     advpn_health_check: <string>
          #     advpn_select: <value in [disable, enable]>
          # speedtest_bypass_routing: <value in [disable, enable]>
          # fail_alert_interfaces: <list or string>
          # app_perf_log_period: <integer>
          # health_check_fortiguard:
          #   - addr_mode: <value in [ipv4, ipv6]>
          #     class_id: <list or string>
          #     detect_mode: <value in [active, passive, prefer-passive, ...]>
          #     diffservcode: <string>
          #     dns_match_ip: <string>
          #     dns_request_domain: <string>
          #     embed_measured_health: <value in [disable, enable]>
          #     failtime: <integer>
          #     ftp_file: <string>
          #     ftp_mode: <value in [passive, port]>
          #     ha_priority: <integer>
          #     http_agent: <string>
          #     http_get: <string>
          #     http_match: <string>
          #     interval: <integer>
          #     members: <list or string>
          #     mos_codec: <value in [g711, g722, g729]>
          #     packet_size: <integer>
          #     password: <list or string>
          #     port: <integer>
          #     probe_count: <integer>
          #     probe_packets: <value in [disable, enable]>
          #     probe_timeout: <integer>
          #     protocol: <value in [ping, tcp-echo, udp-echo, ...]>
          #     quality_measured_method: <value in [half-close, half-open]>
          #     recoverytime: <integer>
          #     security_mode: <value in [none, authentication]>
          #     server: <list or string>
          #     sla:
          #       - id: <integer>
          #         jitter_threshold: <integer>
          #         latency_threshold: <integer>
          #         link_cost_factor: ["latency", "jitter", "packet-loss", "mos", "remote"]
          #         mos_threshold: <string>
          #         packetloss_threshold: <integer>
          #         priority_in_sla: <integer>
          #         priority_out_sla: <integer>
          #     sla_fail_log_period: <integer>
          #     sla_id_redistribute: <integer>
          #     sla_pass_log_period: <integer>
          #     source: <string>
          #     source6: <string>
          #     system_dns: <value in [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: <value in [disable, enable]>
          #     update_static_route: <value in [disable, enable]>
          #     user: <string>
          #     vrf: <integer>
          # option: ["sdwan-overlay", "sdwan-manager"]
          # duplication_max_discrepancy: <integer>

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

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

Ключ

Описание

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.

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

Авторы

  • Xinwei Du (@dux-fortinet)
  • Xing Li (@lix-fortinet)
  • Jie Xue (@JieX19)
  • Link Zheng (@chillancezen)
  • Frank Shen (@fshen01)
  • Hongbin Lu (@fgtdev-hblu)

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

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

© 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/fortimanager/fmgr_wanprof_system_sdwan_module.html

Spec-Zone.ru

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