fortinet.fortios.fortios_system_virtual_wan_link модуль — Настройка резервных интернет-соединений с использованием SD-WAN (ранее виртуальное WAN-соединение) в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль является частью коллекции fortinet.fortios (версия 2.3.7).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить её установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования, см. Требования для получения подробностей.
Для использования в книге задач укажите: fortinet.fortios.fortios_system_virtual_wan_link.
Новинка в fortinet.fortios 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю задавать и изменять системные параметры и категорию virtual_wan_link. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токенов. Сгенерировано в веб-интерфейсе Fortigate. |
enable_log логический | Включить/выключить ведение журнала для задачи. Варианты:
|
member_path строка | Путь к атрибуту члена для выполнения операций. Разделяется с помощью символа косой черты, если атрибутов несколько. Параметр, помеченный как member_path, предназначен для операций с членами. |
member_state строка | Добавить или удалить члена по указанному пути к атрибуту. При указании member_state параметр state игнорируется. Варианты:
|
system_virtual_wan_link словарь | Настройка избыточных интернет-соединений с использованием SD-WAN (ранее виртуальная WAN-ссылка). |
|
fail_alert_interfaces список / элементы=словарь |
Физические интерфейсы, которые будут уведомлены. |
|
name строка / обязательно |
Имя физического интерфейса. Источник system.interface.name. |
|
fail_detect строка |
Включить/выключить проверку состояния интернет-соединения SD-WAN (обнаружение сбоев). Варианты:
|
|
health_check список / элементы=словарь |
Проверка состояния SD-WAN или проверка работоспособности. Определить сервер в интернете и определить, как SD-WAN проверяет, что FortiGate может с ним взаимодействовать. |
|
addr_mode строка |
Режим адреса (IPv4 или IPv6). Варианты:
|
|
diffservcode строка |
Точка кода дифференцированных служб (DSCP) в заголовке IP зондирующего пакета. |
|
failtime целое число |
Количество сбоев, после которого сервер считается недоступным (1 - 3600). |
|
ha_priority целое число |
Приоритет выбора HA (1 - 50). |
|
http_agent строка |
Строка в поле http-agent в заголовке HTTP. |
|
http_get строка |
URL, используемый для взаимодействия с сервером, если протокол — HTTP. |
|
http_match строка |
Ожидаемая строка ответа от сервера, если протокол — HTTP. |
|
interval целое число |
Интервал проверки состояния в миллисекундах или время между попытками подключения к серверу (500 - 3600*1000 мс). |
|
members список / элементы=словарь |
Список номеров последовательности членов. |
|
seq_num целое число / обязательно |
Номер последовательности члена. См. <a href=’#notes’>Примечания</a>. Источник system.virtual-wan-link.members.seq-num. |
|
name строка / обязательно |
Имя проверки состояния или проверки работоспособности. |
|
packet_size целое число |
Размер пакета сессии тестирования twamp. |
|
password string |
Пароль контроллера Twamp в режиме аутентификации |
|
port integer |
Номер порта, используемый для связи с сервером по выбранному протоколу. |
|
probe_packets string |
Включить/отключить передачу пробных пакетов. Choices:
|
|
probe_timeout integer |
Время ожидания, прежде чем пробный пакет будет считаться потерянным (500 - 5000 мс). |
|
protocol string |
Протокол, используемый для определения того, может ли FortiGate общаться с сервером. Choices:
|
|
recoverytime integer |
Количество полученных успешных ответов, прежде чем сервер будет считаться восстановленным (1 - 3600). |
|
security_mode string |
Режим безопасности контроллера Twamp. Choices:
|
|
server string |
IP-адрес или полное доменное имя сервера. |
|
sla list / elements=dictionary |
Соглашение об уровне обслуживания (SLA). |
|
id integer / required |
ИД SLA. см. <a href=’#notes’>Примечания</a>. |
|
jitter_threshold integer |
Джиттер для SLA для принятия решения в миллисекундах. (0 - 10000000). |
|
latency_threshold integer |
Задержка для SLA для принятия решения в миллисекундах. (0 - 10000000). |
|
link_cost_factor list / elements=string |
Критерии, на основе которых следует выбирать канал связи. Choices:
|
|
packetloss_threshold integer |
Потеря пакетов для SLA для принятия решения в процентах. (0 - 100). |
|
sla_fail_log_period integer |
Временной интервал в секундах, через который будут генерироваться сообщения журнала об ошибках SLA (0 - 3600). |
|
sla_pass_log_period integer |
Временной интервал в секундах, через который будут генерироваться сообщения журнала об успешном выполнении SLA (0 - 3600). |
|
threshold_alert_jitter integer |
Пороговое значение предупреждения для джиттера (мс). |
|
threshold_alert_latency integer |
Пороговое значение предупреждения для задержки (мс). |
|
threshold_alert_packetloss integer |
Пороговое значение предупреждения для потери пакетов (проценты). |
|
threshold_warning_jitter integer |
Предупреждающее пороговое значение для джиттера (мс). |
|
threshold_warning_latency integer |
Предупреждающее пороговое значение для задержки (мс). |
|
threshold_warning_packetloss integer |
Предупреждающий порог потери пакетов (в процентах). |
|
update_cascade_interface string |
Включить/отключить обновление каскадного интерфейса. Choices:
|
|
update_static_route string |
Включить/отключить обновление статического маршрута. Choices:
|
|
load_balance_mode string |
Алгоритм или режим, используемый для балансировки нагрузки интернет-трафика на участников SD-WAN. Choices:
|
|
members list / elements=dictionary |
Интерфейсы FortiGate, добавленные в virtual-wan-link. |
|
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. |
|
priority integer |
Приоритет интерфейса (0 - 4294967295). Используется для правил SD-WAN или правил приоритета. |
|
seq_num integer / required |
Порядковый номер (1-255). См. <a href=’#notes’>Примечания</a>. |
|
source string |
Исходный IP-адрес, используемый в пакете проверки работоспособности для сервера. |
|
source6 string |
Исходный IPv6-адрес, используемый в пакете проверки работоспособности для сервера. |
|
spillover_threshold integer |
Порог переполнения исходящего трафика для этого интерфейса (0 - 16776000 кбит/с). Когда достигается этот порог объема трафика, новые сессии переключаются на другие интерфейсы в SD-WAN. |
|
status string |
Включить/отключить этот интерфейс в SD-WAN. Choices:
|
|
volume_ratio integer |
Измеренное соотношение объемов (это значение / сумма всех значений = процент объема канала, 1 - 255). |
|
weight integer |
Вес этого интерфейса для взвешенной балансировки нагрузки. (1 - 255) Больше трафика направляется на интерфейсы с более высокими весами. |
|
neighbor list / elements=dictionary |
Создать соседа SD-WAN из таблицы соседей BGP для управления объявлениями маршрутов в соответствии со статусом SLA. |
|
health_check string |
Имя проверки работоспособности SD-WAN. Источник system.virtual-wan-link.health-check.name. |
|
ip string / required |
IP-адрес соседа. Source router.bgp.neighbor.ip. |
|
member integer |
Порядковый номер участника. Source system.virtual-wan-link.members.seq-num. |
|
role string |
Роль соседа. Choices:
|
|
sla_id integer |
ID SLA. |
|
neighbor_hold_boot_time integer |
Период ожидания в секундах при переключении с основного соседа на вторичного соседа с момента запуска соседа. (0 - 10000000). |
|
neighbor_hold_down string |
Включить/отключить удержание переключения со вторичного соседа на основной. Choices:
|
|
neighbor_hold_down_time integer |
Период ожидания в секундах при переключении со вторичного соседа на основной, когда удержание отключено. (0 - 10000000). |
|
service list / elements=dictionary |
Создать правила SD-WAN (также называемые службами) для управления распределением сеансов по интерфейсам в SD-WAN. |
|
addr_mode string |
Режим адресации (IPv4 или IPv6). Choices:
|
|
bandwidth_weight integer |
Коэффициент обратной величины доступной двунаправленной пропускной способности в формуле custom-profile-1. |
|
default string |
Включить/отключить использование SD-WAN в качестве службы по умолчанию. Choices:
|
|
dscp_forward string |
Включить/отключить тег DSCP для прямого трафика. Choices:
|
|
dscp_forward_tag string |
Тег DSCP для прямого трафика. |
|
dscp_reverse string |
Включить/отключить тег DSCP для обратного трафика. Choices:
|
|
dscp_reverse_tag string |
Тег DSCP для обратного трафика. |
|
dst list / elements=dictionary |
Имя целевого адреса. |
|
name string / required |
Имя адреса или группы адресов. Source firewall.address.name firewall.addrgrp.name. |
|
dst6 list / elements=dictionary |
Имя целевого адреса6. |
|
name string / required |
Имя адреса6 или группы адресов6. Source firewall.address6.name firewall.addrgrp6.name. |
|
dst_negate string |
Включить/отключить отрицание соответствия целевого адреса. Choices:
|
|
end_port integer |
Конечный номер порта назначения. |
|
gateway string |
Включить/выключить шлюз сервиса SD-WAN. Choices:
|
|
groups list / elements=dictionary |
Группы пользователей. |
|
name string / required |
Имя группы. Источник user.group.name. |
|
health_check string |
Проверка состояния. Источник system.virtual-wan-link.health-check.name. |
|
hold_down_time integer |
Период ожидания в секундах при переключении с резервного члена на основной (0 - 10000000). |
|
id integer / required |
Приоритетный ID правила (1 - 4000). см. <a href=’#notes’>Примечания</a>. |
|
input_device list / elements=dictionary |
Имя исходного интерфейса. |
|
name string / required |
Имя интерфейса. Источник system.interface.name. |
|
input_device_negate string |
Включить/выключить отрицание соответствия входного устройства. Choices:
|
|
internet_service string |
Включить/выключить использование интернет-сервиса для балансировки нагрузки на основе приложений. Choices:
|
|
internet_service_app_ctrl list / elements=dictionary |
Список ID интернет-сервисов на основе контроля приложений. |
|
id integer / required |
ID интернет-сервиса на основе контроля приложений. см. <a href=’#notes’>Примечания</a>. |
|
internet_service_app_ctrl_group list / elements=dictionary |
Список групп интернет-сервисов на основе контроля приложений. |
|
name string / required |
Имя группы интернет-сервисов на основе контроля приложений. Источник application.group.name. |
|
internet_service_ctrl list / elements=dictionary |
Список ID интернет-сервисов на основе управления. |
|
id integer / required |
ID интернет-сервиса на основе управления. см. <a href=’#notes’>Примечания</a>. |
|
internet_service_ctrl_group list / elements=dictionary |
Список групп интернет-сервисов на основе управления. |
|
name string / required |
Имя группы интернет-сервисов на основе управления. Источник application.group.name. |
|
internet_service_custom list / elements=dictionary |
Список имен пользовательских интернет-сервисов. |
|
name string / required |
Имя пользовательского интернет-сервиса. Источник firewall.internet-service-custom.name. |
|
internet_service_custom_group list / elements=dictionary |
Список групп пользовательских интернет-сервисов. |
|
name string / required |
Имя настраиваемой группы интернет-сервисов. Источник firewall.internet-service-custom-group.name. |
|
internet_service_group list / elements=dictionary |
Список групп интернет-сервисов. |
|
name string / required |
Имя группы интернет-сервисов. Источник firewall.internet-service-group.name. |
|
internet_service_id list / elements=dictionary |
Список ID интернет-сервисов. |
|
id integer / required |
ID интернет-сервиса. см. <a href=’#notes’>Примечания</a>. Источник firewall.internet-service.id. |
|
jitter_weight integer |
Коэффициент джиттера в формуле custom-profile-1. |
|
latency_weight integer |
Коэффициент задержки в формуле custom-profile-1. |
|
link_cost_factor string |
Коэффициент стоимости канала. Варианты:
|
|
link_cost_threshold integer |
Процентный порог изменения значений стоимости канала, который приведет к повторной генерации маршрута политики (0 - 10000000). |
|
member integer |
Порядковый номер участника. Источник system.virtual-wan-link.members.seq-num. |
|
mode string |
Управление тем, как правило приоритета устанавливает приоритет интерфейсов в SD-WAN. Варианты:
|
|
name string |
Имя правила приоритета. |
|
packet_loss_weight integer |
Коэффициент потери пакетов в формуле custom-profile-1. |
|
priority_members list / elements=dictionary |
Список порядковых номеров участников. |
|
seq_num integer / required |
Порядковый номер участника. см. <a href=’#notes’>Примечания</a>. Источник system.virtual-wan-link.members.seq-num. |
|
protocol integer |
Номер протокола. |
|
quality_link integer |
Оценка качества. |
|
role string |
Роль сервиса для работы с соседом. Варианты:
|
|
route_tag integer |
IPv4 route map route-tag. |
|
sla list / elements=dictionary |
Соглашение об уровне обслуживания (SLA). |
|
health_check string / required |
Проверка работоспособности виртуального WAN-соединения. Источник system.virtual-wan-link.health-check.name. |
|
id integer |
ID SLA. |
|
sla_compare_method string |
Метод сравнения значения SLA для режима sla и балансировки нагрузки. Choices:
|
|
src list / elements=dictionary |
Имя исходного адреса. |
|
name string / required |
Имя адреса или группы адресов. Исходный firewall.address.name firewall.addrgrp.name. |
|
src6 list / elements=dictionary |
Имя исходного адреса IPv6. |
|
name string / required |
Имя адреса IPv6 или группы адресов IPv6. Исходный firewall.address6.name firewall.addrgrp6.name. |
|
src_negate string |
Включить/отключить отрицание соответствия исходного адреса. Choices:
|
|
standalone_action string |
Включить/отключить сервис, когда выбранная роль соседа является автономной, а роль сервиса — нет. Choices:
|
|
start_port integer |
Начальный номер порта назначения. |
|
status string |
Включить/отключить сервис SD-WAN. Choices:
|
|
tos string |
Шаблон битов типа обслуживания. |
|
tos_mask string |
Оцениваемые биты типа обслуживания. |
|
users list / elements=dictionary |
Имя пользователя. |
|
name string / required |
Имя пользователя. Исходный user.local.name. |
|
status string |
Включить/отключить SD-WAN. Choices:
|
|
zone list / elements=dictionary |
Настроить зоны SD-WAN. |
|
name string / required |
Имя зоны. |
vdom string | Виртуальный домен, среди ранее определённых. Vdom — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельный блок. Default: |
Примечания
Примечание
- Устаревший fortiosapi был объявлен устаревшим, httpapi — предпочтительный способ запуска playbooks
Примеры
- name: Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
fortinet.fortios.fortios_system_virtual_wan_link:
vdom: "{{ vdom }}"
system_virtual_wan_link:
fail_alert_interfaces:
-
name: "default_name_4 (source system.interface.name)"
fail_detect: "enable"
health_check:
-
addr_mode: "ipv4"
diffservcode: "<your_own_value>"
failtime: "1800"
ha_priority: "25"
http_agent: "<your_own_value>"
http_get: "<your_own_value>"
http_match: "<your_own_value>"
interval: "1800000"
members:
-
seq_num: "<you_own_value>"
name: "default_name_17"
packet_size: "512"
password: "<your_own_value>"
port: "32767"
probe_packets: "disable"
probe_timeout: "2500"
protocol: "ping"
recoverytime: "1800"
security_mode: "none"
server: "192.168.100.40"
sla:
-
id: "28"
jitter_threshold: "5000000"
latency_threshold: "5000000"
link_cost_factor: "latency"
packetloss_threshold: "50"
sla_fail_log_period: "1800"
sla_pass_log_period: "1800"
threshold_alert_jitter: "2147483647"
threshold_alert_latency: "2147483647"
threshold_alert_packetloss: "50"
threshold_warning_jitter: "2147483647"
threshold_warning_latency: "2147483647"
threshold_warning_packetloss: "50"
update_cascade_interface: "enable"
update_static_route: "enable"
load_balance_mode: "source-ip-based"
members:
-
comment: "Comments."
cost: "2147483647"
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
ingress_spillover_threshold: "8388000"
interface: "<your_own_value> (source system.interface.name)"
priority: "2147483647"
seq_num: "<you_own_value>"
source: "<your_own_value>"
source6: "<your_own_value>"
spillover_threshold: "8388000"
status: "disable"
volume_ratio: "127"
weight: "127"
neighbor:
-
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
ip: "<your_own_value> (source router.bgp.neighbor.ip)"
member: "2147483647"
role: "standalone"
sla_id: "2147483647"
neighbor_hold_boot_time: "5000000"
neighbor_hold_down: "enable"
neighbor_hold_down_time: "5000000"
service:
-
addr_mode: "ipv4"
bandwidth_weight: "5000000"
default: "enable"
dscp_forward: "enable"
dscp_forward_tag: "<your_own_value>"
dscp_reverse: "enable"
dscp_reverse_tag: "<your_own_value>"
dst:
-
name: "default_name_77 (source firewall.address.name firewall.addrgrp.name)"
dst_negate: "enable"
dst6:
-
name: "default_name_80 (source firewall.address6.name firewall.addrgrp6.name)"
end_port: "32767"
gateway: "enable"
groups:
-
name: "default_name_84 (source user.group.name)"
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
hold_down_time: "5000000"
id: "87"
input_device:
-
name: "default_name_89 (source system.interface.name)"
input_device_negate: "enable"
internet_service: "enable"
internet_service_app_ctrl:
-
id: "93"
internet_service_app_ctrl_group:
-
name: "default_name_95 (source application.group.name)"
internet_service_ctrl:
-
id: "97"
internet_service_ctrl_group:
-
name: "default_name_99 (source application.group.name)"
internet_service_custom:
-
name: "default_name_101 (source firewall.internet-service-custom.name)"
internet_service_custom_group:
-
name: "default_name_103 (source firewall.internet-service-custom-group.name)"
internet_service_group:
-
name: "default_name_105 (source firewall.internet-service-group.name)"
internet_service_id:
-
id: "107 (source firewall.internet-service.id)"
jitter_weight: "5000000"
latency_weight: "5000000"
link_cost_factor: "latency"
link_cost_threshold: "5000000"
member: "2147483647"
mode: "auto"
name: "default_name_114"
packet_loss_weight: "5000000"
priority_members:
-
seq_num: "<you_own_value>"
protocol: "127"
quality_link: "127"
role: "standalone"
route_tag: "2147483647"
sla:
-
health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
id: "124"
sla_compare_method: "order"
src:
-
name: "default_name_127 (source firewall.address.name firewall.addrgrp.name)"
src_negate: "enable"
src6:
-
name: "default_name_130 (source firewall.address6.name firewall.addrgrp6.name)"
standalone_action: "enable"
start_port: "32767"
status: "enable"
tos: "<your_own_value>"
tos_mask: "<your_own_value>"
users:
-
name: "default_name_137 (source user.local.name)"
status: "disable"
zone:
-
name: "default_name_140"
Значения возврата
Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate при последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_system_virtual_wan_link_module.html