fortios_system_virtual_wan_link – Настройка избыточных интернет-соединений с использованием SD-WAN (ранее виртуальное WAN-соединение) в Fortinet’s FortiOS и FortiGate
Новая версия 2.8.
Описание
- Этот модуль позволяет настроить FortiGate или FortiOS, позволяя пользователю устанавливать и изменять системные параметры и категорию virtual_wan_link. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.2
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- fortiosapi>=0.9.8
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | |||
|---|---|---|---|---|---|
| host - / обязательно | IP-адрес FortiOS или FortiGate. | ||||
| https boolean |
| Указывает, должны ли запросы к FortiGate использовать протокол HTTPS. | |||
| password - | Значение по умолчанию: "" | Пароль FortiOS или FortiGate. | |||
| system_virtual_wan_link - | Значение по умолчанию: null | Настройка резервных интернет-соединений с использованием 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). | |||
| failtime - | Количество сбоев, после которых сервер считается потерянным (1–10, по умолчанию = 5). | ||||
| http-get - | URL, используемый для связи с сервером, если протокол HTTP. | ||||
| http-match - | Ожидаемая строка ответа от сервера, если протокол HTTP. | ||||
| interval - | Интервал проверки состояния или время между попытками подключения к серверу (1–3600 сек, по умолчанию = 5). | ||||
| members - | Список номеров последовательности членов. | ||||
| seq-num - / обязательно | Номер последовательности члена. Источник system.virtual-wan-link.members.seq-num. | ||||
| name - / обязательно | Имя проверки состояния или проверки работоспособности. | ||||
| packet-size - | Размер пакета сеанса тестирования twamp. | ||||
| password - | Пароль контроллера twamp в режиме аутентификации. | ||||
| port - | Номер порта, используемый для связи с сервером по выбранному протоколу. | ||||
| protocol - |
| Протокол, используемый для определения возможности связи FortiGate с сервером. | |||
| recoverytime - | Количество полученных успешных ответов, прежде чем сервер считается восстановленным (1–10, по умолчанию = 5). | ||||
| security-mode - |
| Режим безопасности контроллера twamp. | |||
| server - | IP-адрес или FQDN сервера. | ||||
| sla - | Соглашение об уровне сервиса (SLA). | ||||
| id - / обязательно | ID SLA. | ||||
| jitter-threshold - | Задержка для принятия решения SLA в миллисекундах. (0–10000000, по умолчанию = 5). | ||||
| latency-threshold - | Задержка для принятия решения SLA в миллисекундах. (0–10000000, по умолчанию = 5). | ||||
| link-cost-factor - |
| Критерии, на основе которых выбирается ссылка. | |||
| packetloss-threshold - | Потеря пакетов для принятия решения SLA в процентах. (0–100, по умолчанию = 0). | ||||
| 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 - |
| Включение/выключение обновления каскадного интерфейса. | |||
| update-static-route - |
| Включение/выключение обновления статического маршрута. | |||
| режим-балансировки-нагрузки - |
| Алгоритм или режим для использования при балансировке нагрузки интернет-трафика для членов SD-WAN. | |||
| члены - | Физические интерфейсы FortiGate, добавленные к виртуальной ссылке virtual-wan-link. | ||||
| комментарий - | Комментарии. | ||||
| шлюз - | Основной шлюз для этого интерфейса. Обычно основной шлюз интернет-провайдера, к которому подключен этот интерфейс. | ||||
| шлюз6 - | IPv6 шлюз. | ||||
| пороговое-значение-переполнения-входящего-трафика - | Пороговое значение переполнения входящего трафика для этого интерфейса (0 - 16776000 кбит/с). При достижении этого порога по объёму трафика новые сессии перенаправляются на другие интерфейсы в SD-WAN. | ||||
| интерфейс - | Имя интерфейса. Имя интерфейса источника системы.source system.interface.name. | ||||
| приоритет - | Приоритет интерфейса (0 - 4294967295). Используется для правил SD-WAN или правил приоритета. | ||||
| посл-номер - / обязательно | Последовательный номер (1-255). | ||||
| источник - | Используемый IP-адрес источника в пакете проверки работоспособности для сервера. | ||||
| источник6 - | Используемый IPv6-адрес источника в пакете проверки работоспособности для сервера. | ||||
| пороговое-значение-переполнения-исходящего-трафика - | Пороговое значение переполнения исходящего трафика для этого интерфейса (0 - 16776000 кбит/с). При достижении этого порога по объёму трафика новые сессии перенаправляются на другие интерфейсы в SD-WAN. | ||||
| статус - |
| Включить/выключить этот интерфейс в SD-WAN. | |||
| отношение-объёма - | Измеренное отношение объема (это значение / сумма всех значений = процент объема канала, 0 - 255). | ||||
| вес - | Вес этого интерфейса для балансировки нагрузки с учетом весов. (0 - 255) Больше трафика направляется на интерфейсы с более высокими весами. | ||||
| служба - | Создать правила SD-WAN или правила приоритета (также называемые службами) для управления тем, как сессии распределяются по физическим интерфейсам в SD-WAN. | ||||
| режим-адресации - |
| Режим адресации (IPv4 или IPv6). | |||
| вес-по-пропускной-способности - | Коэффициент обратной величины доступной двусторонней пропускной способности в формуле custom-profile-1. | ||||
| передача-dscp - |
| Включить/выключить тег DSCP для передаваемого трафика. | |||
| тег-передаваемого-dscp - | Тег DSCP для передаваемого трафика. | ||||
| dscp-обратный - |
| Включить/выключить тег DSCP для обратного трафика. | |||
| тег-обратного-dscp - | Тег DSCP для обратного трафика. | ||||
| назначение - | Имя адреса назначения. | ||||
| имя - / обязательно | Имя адреса или группы адресов. Имя адреса источника firewall.address.name firewall.addrgrp.name. | ||||
| отрицание-назначения - |
| Включить/выключить отрицание соответствия адресу назначения. | |||
| назначение6 - | Имя адреса6 назначения. | ||||
| имя - / обязательно | Имя адреса6 или группы адресов6. Имя адреса6 источника firewall.address6.name firewall.addrgrp6.name. | ||||
| конечный-порт - | Номер конечного порта назначения. | ||||
| шлюз - |
| Включить/выключить шлюз SD-WAN службы. | |||
| группы - | Пользовательские группы. | ||||
| имя - / обязательно | Имя группы. Имя группы источника user.group.name. | ||||
| проверка-работоспособности - | Проверка работоспособности. Имя проверки работоспособности virtual-wan-link.health-check.name. | ||||
| время-удержания - | Период ожидания в секундах при переключении с резервного члена на основной (0 - 10000000, по умолчанию = 0). | ||||
| id - / обязательно | Идентификатор правила приоритета (1 - 4000). | ||||
| входное-устройство - | Имя исходного интерфейса. | ||||
| имя - / обязательно | Имя интерфейса. Имя интерфейса источника системы.source system.interface.name. | ||||
| услуга-интернета - |
| Включить/выключить использование службы интернета для балансировки нагрузки на основе приложений. | |||
| упр-услуга-интернета - | Список идентификаторов службы интернета на основе управления. | ||||
| id - / обязательно | Идентификатор службы интернета на основе управления. | ||||
| группа-упр-услуга-интернета - | Список групп службы интернета на основе управления. | ||||
| название - / обязательно | Имя группы службы интернета на основе управления. Источник application.group.name. | ||||
| настраиваемая-услуга-интернета - | Список пользовательских имён службы интернета. | ||||
| название - / обязательно | Пользовательское имя службы интернета. Источник firewall.internet-service-custom.name. | ||||
| группа-настраиваемая-услуга-интернета - | Список групп пользовательских служб интернета. | ||||
| название - / обязательно | Имя группы пользовательской службы интернета. Источник firewall.internet-service-custom-group.name. | ||||
| группа-услуга-интернета - | Список групп службы интернета. | ||||
| название - / обязательно | Имя группы службы интернета. Источник firewall.internet-service-group.name. | ||||
| идентификатор-услуги-интернета - | Список идентификаторов службы интернета. | ||||
| id - / обязательно | Идентификатор службы интернета. Источник firewall.internet-service.id. | ||||
| весовой-коэффициент-флуктуаций - | Коэффициент флуктуаций в формуле custom-profile-1. | ||||
| весовой-коэффициент-задержки - | Коэффициент задержки в формуле custom-profile-1. | ||||
| коэффициент-стоимости-канала - |
| Коэффициент стоимости канала. | |||
| пороговое-значение-стоимости-канала - | Процентное пороговое значение изменения стоимости канала, которое приведёт к перегенерации маршрута политики (0 - 10000000, по умолчанию = 10). | ||||
| участник - | Порядковый номер участника. | ||||
| режим - |
| Управление тем, как правило приоритета устанавливает приоритет интерфейсов в SD-WAN. | |||
| название - | Имя правила приоритета. | ||||
| весовой-коэффициент-потери-пакетов - | Коэффициент потери пакетов в формуле custom-profile-1. | ||||
| участники-с-приоритетом - | Список порядковых номеров участников. | ||||
| порядковый-номер - / обязательно | Порядковый номер участника. Источник system.virtual-wan-link.members.seq-num. | ||||
| протокол - | Номер протокола. | ||||
| качество-канала - | Класс качества. | ||||
| метка-маршрута - | Метка маршрута карты маршрутов IPv4. | ||||
| sla - | Соглашение об уровне обслуживания (SLA). | ||||
| проверка-работоспособности - / обязательно | Проверка работоспособности виртуального канала WAN. Источник system.virtual-wan-link.health-check.name. | ||||
| id - | Идентификатор SLA. | ||||
| источник - | Имя источника адреса. | ||||
| название - / обязательно | Имя адреса или группы адресов. Источник firewall.address.name firewall.addrgrp.name. | ||||
| отрицание-источника - |
| Включить/выключить отмену совпадения адреса источника. | |||
| источник6 - | Имя адреса источника версии 6. | ||||
| название - / обязательно | Имя адреса версии 6 или группы адресов версии 6. Источник firewall.address6.name firewall.addrgrp6.name. | ||||
| начальный-порт - | Номер начального порта назначения. | ||||
| состояние - |
| Включить/выключить службу SD-WAN. | |||
| tos - | Шаблон бита типа обслуживания. | ||||
| tos-mask - | Тип оцениваемых битов сервиса. | ||||
| users - | Имя пользователя. | ||||
| name - / обязательно | Имя пользователя. Источник user.local.name. | ||||
| status - |
| Включить/выключить SD-WAN. | |||
| username - / обязательно | Имя пользователя FortiOS или FortiGate. | ||||
| vdom - | По умолчанию: "root" | Виртуальная область, среди тех, которые определены ранее. Vdom - это виртуальная инстанция FortiGate, которую можно настроить и использовать как отдельное устройство. | |||
Примечания
Примечание
- Требуется библиотека fortiosapi, разработанная Fortinet
- Выполняется как local_action в вашем плане
Примеры
- hosts: localhost
vars:
host: "192.168.122.40"
username: "admin"
password: ""
vdom: "root"
tasks:
- name: Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
fortios_system_virtual_wan_link:
host: "{{ host }}"
username: "{{ username }}"
password: "{{ password }}"
vdom: "{{ vdom }}"
https: "False"
system_virtual_wan_link:
fail-alert-interfaces:
-
name: "default_name_4 (source system.interface.name)"
fail-detect: "enable"
health-check:
-
addr-mode: "ipv4"
failtime: "8"
http-get: "<your_own_value>"
http-match: "<your_own_value>"
interval: "11"
members:
-
seq-num: "13 (source system.virtual-wan-link.members.seq-num)"
name: "default_name_14"
packet-size: "15"
password: "<your_own_value>"
port: "17"
protocol: "ping"
recoverytime: "19"
security-mode: "none"
server: "192.168.100.40"
sla:
-
id: "23"
jitter-threshold: "24"
latency-threshold: "25"
link-cost-factor: "latency"
packetloss-threshold: "27"
threshold-alert-jitter: "28"
threshold-alert-latency: "29"
threshold-alert-packetloss: "30"
threshold-warning-jitter: "31"
threshold-warning-latency: "32"
threshold-warning-packetloss: "33"
update-cascade-interface: "enable"
update-static-route: "enable"
load-balance-mode: "source-ip-based"
members:
-
comment: "Comments."
gateway: "<your_own_value>"
gateway6: "<your_own_value>"
ingress-spillover-threshold: "41"
interface: "<your_own_value> (source system.interface.name)"
priority: "43"
seq-num: "44"
source: "<your_own_value>"
source6: "<your_own_value>"
spillover-threshold: "47"
status: "disable"
volume-ratio: "49"
weight: "50"
service:
-
addr-mode: "ipv4"
bandwidth-weight: "53"
dscp-forward: "enable"
dscp-forward-tag: "<your_own_value>"
dscp-reverse: "enable"
dscp-reverse-tag: "<your_own_value>"
dst:
-
name: "default_name_59 (source firewall.address.name firewall.addrgrp.name)"
dst-negate: "enable"
dst6:
-
name: "default_name_62 (source firewall.address6.name firewall.addrgrp6.name)"
end-port: "63"
gateway: "enable"
groups:
-
name: "default_name_66 (source user.group.name)"
health-check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
hold-down-time: "68"
id: "69"
input-device:
-
name: "default_name_71 (source system.interface.name)"
internet-service: "enable"
internet-service-ctrl:
-
id: "74"
internet-service-ctrl-group:
-
name: "default_name_76 (source application.group.name)"
internet-service-custom:
-
name: "default_name_78 (source firewall.internet-service-custom.name)"
internet-service-custom-group:
-
name: "default_name_80 (source firewall.internet-service-custom-group.name)"
internet-service-group:
-
name: "default_name_82 (source firewall.internet-service-group.name)"
internet-service-id:
-
id: "84 (source firewall.internet-service.id)"
jitter-weight: "85"
latency-weight: "86"
link-cost-factor: "latency"
link-cost-threshold: "88"
member: "89"
mode: "auto"
name: "default_name_91"
packet-loss-weight: "92"
priority-members:
-
seq-num: "94 (source system.virtual-wan-link.members.seq-num)"
protocol: "95"
quality-link: "96"
route-tag: "97"
sla:
-
health-check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
id: "100"
src:
-
name: "default_name_102 (source firewall.address.name firewall.addrgrp.name)"
src-negate: "enable"
src6:
-
name: "default_name_105 (source firewall.address6.name firewall.addrgrp6.name)"
start-port: "106"
status: "enable"
tos: "<your_own_value>"
tos-mask: "<your_own_value>"
users:
-
name: "default_name_111 (source user.local.name)"
status: "disable"
Значения возврата
Общие значения возврата описаны здесь, следующие являются полями, уникальными для данного модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| build строка | всегда | Номер сборки образа fortigate Пример: 1547 |
| http_method строка | всегда | Последний метод, использованный для предоставления контента в FortiGate Пример: PUT |
| http_status строка | всегда | Последний результат, предоставленный FortiGate по последней применённой операции Пример: 200 |
| mkey строка | успех | Главный ключ (id), использованный в последнем вызове FortiGate Пример: id |
| name строка | всегда | Имя таблицы, используемой для выполнения запроса Пример: urlfilter |
| path строка | всегда | Путь таблицы, используемой для выполнения запроса Пример: webfilter |
| revision строка | всегда | Внутренний номер ревизии Пример: 17.0.2.10658 |
| serial строка | всегда | Серийный номер устройства Пример: FGVMEVYYQT3AB5352 |
| status строка | всегда | Указание результата операции Пример: успех |
| vdom строка | всегда | Используемая виртуальная область Пример: root |
| version строка | всегда | Версия FortiGate Пример: v5.6.3 |
Статус
- Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
- Данный модуль поддерживается сообществом Ansible. [сообщество]
Авторы
- Miguel Angel Munoz (@mamunozgonzalez)
- Nicolas Thomas (@thomnico)
Подсказка
Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/fortios_system_virtual_wan_link_module.html