Spec-Zone.ru › Ansible 2.11

fortinet.fortios.fortios_system_virtual_wan_link – Настройка резервных подключений к Интернету с помощью SD-WAN (ранее виртуальная WAN-ссылка) в FortiOS и FortiGate Fortinet.

Примечание

Этот плагин является частью коллекции fortinet.fortios (версия 1.1.8).

Для его установки используйте: ansible-galaxy collection install fortinet.fortios.

Для использования в книге задач укажите: fortinet.fortios.fortios_system_virtual_wan_link.

Новое в версии 2.8: of fortinet.fortios

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

Обзор

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

Требования

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

  • ansible>=2.9.0

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
access_token
строка
Аутентификация на основе токена. Сгенерирован из GUI Fortigate.
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
Режим адреса (IPv4 или IPv6).
failtime
целое число
Количество ошибок до того, как сервер считается потерянным (1 - 10).
http_get
строка
URL, используемый для связи с сервером, если протокол HTTP.
http_match
строка
Ожидаемая строка ответа от сервера, если протокол HTTP.
interval
целое число
Интервал проверки состояния или интервал времени между попытками подключения к серверу (1 - 3600 сек).
members
список / элементы=строка
Список номеров последовательности участников.
seq_num
целое число
Номер последовательности участника. Источник system.virtual-wan-link.members.seq-num.
name
строка / обязательно
Имя проверки состояния или проверки работоспособности.
packet_size
целое число
Размер пакета сеанса тестирования twamp.
password
строка
Пароль контроллера twamp в режиме аутентификации
port
целое число
Номер порта, используемый для связи с сервером по выбранному протоколу.
protocol
строка
    Варианты:
  • ping
  • tcp-echo
  • udp-echo
  • http
  • twamp
  • ping6
Протокол, используемый для определения возможности связи FortiGate с сервером.
recoverytime
целое число
Количество полученных успешных ответов перед тем, как сервер считается восстановленным (1 - 10).
security_mode
строка
    Варианты:
  • нет
  • аутентификация
Режим безопасности контроллера twamp.
server
строка
IP-адрес или FQDN сервера.
sla
список / элементы=строка
Соглашение об уровне обслуживания (SLA).
id
целое число / обязательно
Идентификатор SLA.
jitter_threshold
целое число
Задержка для принятия решения SLA в миллисекундах. (0 - 10000000).
latency_threshold
целое число
Задержка для принятия решения SLA в миллисекундах. (0 - 10000000).
link_cost_factor
строка
    Варианты:
  • latency
  • jitter
  • packet-loss
Критерий, на основании которого выбирается подключение.
packetloss_threshold
целое число
Потеря пакетов для принятия решения SLA в процентах. (0 - 100).
threshold_alert_jitter
целое число
Пороговое значение для отправки уведомления о задержке (мс).
threshold_alert_latency
целое число
Пороговое значение для отправки уведомления о задержке (мс).
threshold_alert_packetloss
целое число
Пороговое значение для отправки уведомления о потере пакетов (проценты).
threshold_warning_jitter
целое число
Пороговое значение для отправки предупреждения о задержке (мс).
threshold_warning_latency
целое число
Пороговое значение для отправки предупреждения о задержке (мс).
threshold_warning_packetloss
целое число
Пороговое значение для отправки предупреждения о потере пакетов (проценты).
update_cascade_interface
строка
    Варианты:
  • включить
  • выключить
Включение/выключение обновления интерфейса каскада.
update_static_route
строка
    Варианты:
  • включить
  • выключить
Включение/выключение обновления статического маршрута.
load_balance_mode
строка
    Варианты:
  • на основе исходного IP
  • на основе весов
  • на основе использования
  • на основе исходного и конечного IP
  • на основе измеренного объема
Алгоритм или режим для балансировки нагрузки интернет-трафика для участников SD-WAN.
members
список / элементы=строка
Физические интерфейсы FortiGate, добавленные к виртуальному WAN-соединению.
gateway
строка
Основной шлюз для этого интерфейса. Обычно основной шлюз интернет-провайдера, к которому подключен этот интерфейс.
gateway6
строка
IPv6 шлюз.
ingress_spillover_threshold
целое число
Пороговое значение для переполнения входящего трафика для этого интерфейса (0 - 16776000 кбит/с). Когда этот объем трафика превышен, новые сеансы переполняются на другие интерфейсы в SD-WAN.
interface
строка
Имя интерфейса. Источник system.interface.name.
priority
целое число
Приоритет интерфейса (0 - 4294967295). Используется для правил SD-WAN или правил приоритета.
seq_num
целое число
Номер последовательности (1-255).
source
string
Используемый в пакете проверки работоспособности исходный IP-адрес сервера.
source6
string
Используемый в пакете проверки работоспособности исходный IPv6-адрес сервера.
spillover_threshold
integer
Пороговое значение переполнения исходящего трафика для этого интерфейса (0-16776000 кбит/с). При достижении этого порога объёма трафика новые сеансы перенаправляются на другие интерфейсы в SD-WAN.
status
string
    Choices:
  • disable
  • enable
Включить/выключить этот интерфейс в SD-WAN.
volume_ratio
integer
Измеренное соотношение объёмов (это значение / сумма всех значений = процентная доля объёма канала, 0-255).
weight
integer
Вес этого интерфейса для взвешенного балансирования нагрузки. (0-255) Больше трафика направляется на интерфейсы с более высокими весами.
service
list / elements=string
Создать правила SD-WAN или правила приоритета (также называемые службами) для управления тем, как сеансы распределяются по физическим интерфейсам в SD-WAN.
addr_mode
string
    Choices:
  • ipv4
  • ipv6
Режим адресации (IPv4 или IPv6).
bandwidth_weight
integer
Коэффициент обратной величины доступной двунаправленной пропускной способности в формуле custom-profile-1.
dscp_forward
string
    Choices:
  • enable
  • disable
Включить/выключить тег DSCP для передаваемого трафика.
dscp_forward_tag
string
Тег DSCP для передаваемого трафика.
dscp_reverse
string
    Choices:
  • enable
  • disable
Включить/выключить тег DSCP для обратного трафика.
dscp_reverse_tag
string
Тег DSCP для обратного трафика.
dst
list / elements=string
Имя назначения адреса.
name
string / required
Имя адреса или группы адресов. Источник firewall.address.name firewall.addrgrp.name.
dst6
list / elements=string
Имя адреса6 или группы адреса6.
name
string / required
Имя адреса6 или группы адреса6. Источник firewall.address6.name firewall.addrgrp6.name.
dst_negate
string
    Choices:
  • enable
  • disable
Включить/выключить инвертирование совпадения адреса назначения.
end_port
integer
Номер конечного порта назначения.
groups
list / elements=string
Пользовательские группы.
name
string / required
Имя группы. Источник user.group.name.
health_check
string
Проверка работоспособности. Источник system.virtual-wan-link.health-check.name.
id
integer / required
ID правила приоритета (1-4000).
input_device
list / elements=string
Имя исходного интерфейса.
name
string / required
Имя интерфейса. Источник system.interface.name.
internet_service
string
    Choices:
  • enable
  • disable
Включить/выключить использование интернет-службы для балансирования нагрузки на основе приложений.
internet_service_ctrl
list / elements=string
Список идентификаторов интернет-службы на основе управления.
id
integer / required
Идентификатор интернет-службы на основе управления.
internet_service_ctrl_group
list / elements=string
Список групп интернет-служб на основе управления.
name
string / required
Имя группы интернет-служб на основе управления. Источник application.group.name.
internet_service_custom
list / elements=string
Список имен пользовательских интернет-служб.
name
string / required
Имя пользовательской интернет-службы. Источник firewall.internet-service-custom.name.
internet_service_custom_group
list / elements=string
Список групп пользовательских интернет-служб.
name
string / required
Имя группы пользовательских интернет-служб. Источник firewall.internet-service-custom-group.name.
internet_service_group
list / elements=string
Список групп интернет-служб.
name
string / required
Имя группы интернет-служб. Источник firewall.internet-service-group.name.
internet_service_id
list / elements=string
Список идентификаторов интернет-служб.
id
integer / required
Идентификатор интернет-службы. Источник firewall.internet-service.id.
jitter_weight
integer
Коэффициент джиттера в формуле custom-profile-1.
latency_weight
integer
Коэффициент задержки в формуле custom-profile-1.
link_cost_factor
string
    Choices:
  • latency
  • jitter
  • packet-loss
  • inbandwidth
  • outbandwidth
  • bibandwidth
  • custom-profile-1
Фактор стоимости канала.
link_cost_threshold
integer
Процентный порог изменения значений стоимости канала, который приведет к перегенерации маршрута политики (0-10000000).
member
integer
Порядковый номер участника.
mode
string
    Варианты:
  • auto
  • manual
  • priority
  • sla
Управление тем, как правило приоритета устанавливает приоритет интерфейсов в SD-WAN.
name
string
Имя правила приоритета.
packet_loss_weight
integer
Коэффициент потерь пакетов в формуле пользовательского профиля 1.
priority_members
list / elements=string
Список порядковых номеров участников.
seq_num
integer
Порядковый номер участника. Источник системы.virtual-wan-link.members.seq-num.
protocol
integer
Номер протокола.
quality_link
integer
Оценка качества.
route_tag
integer
Тег маршрута карты маршрутизации IPv4.
sla
list / elements=string
Соглашение об уровне обслуживания (SLA).
health_check
string
Проверка работоспособности виртуального WAN-соединения. Источник системы.virtual-wan-link.health-check.name.
id
integer
Идентификатор SLA.
src
list / elements=string
Имя источника адреса.
name
string / required
Имя адреса или группы адресов. Источник firewall.address.name firewall.addrgrp.name.
src6
list / elements=string
Имя источника адреса6.
name
string / required
Имя адреса6 или группы адресов6. Источник firewall.address6.name firewall.addrgrp6.name.
src_negate
string
    Варианты:
  • enable
  • disable
Включить/отключить инверсию соответствия источнику адреса.
start_port
integer
Начальный номер порта назначения.
status
string
    Варианты:
  • enable
  • disable
Включить/отключить услугу SD-WAN.
tos
string
Битовая схема типа обслуживания.
tos_mask
string
Оцениваемые биты типа обслуживания.
users
list / elements=string
Имя пользователя.
name
string / required
Имя пользователя. Источник user.local.name.
status
string
    Варианты:
  • disable
  • enable
Включить/отключить SD-WAN.
vdom
string
По умолчанию:
"root"
Виртуальная область, определённая ранее. VDOM — виртуальная копия FortiGate, которую можно настроить и использовать как отдельное устройство.

Примечания

Примечание

  • Модуль fortiosapi устарел, httpapi — предпочтительный способ запуска скриптов.

Примеры

- hosts: fortigates
  collections:
    - fortinet.fortios
  connection: httpapi
  vars:
   vdom: "root"
   ansible_httpapi_use_ssl: yes
   ansible_httpapi_validate_certs: no
   ansible_httpapi_port: 443
  tasks:
  - name: Configure redundant internet connections using SD-WAN (formerly virtual WAN link).
    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"
            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:
         -
            gateway: "<your_own_value>"
            gateway6: "<your_own_value>"
            ingress_spillover_threshold: "40"
            interface: "<your_own_value> (source system.interface.name)"
            priority: "42"
            seq_num: "43"
            source: "<your_own_value>"
            source6: "<your_own_value>"
            spillover_threshold: "46"
            status: "disable"
            volume_ratio: "48"
            weight: "49"
        service:
         -
            addr_mode: "ipv4"
            bandwidth_weight: "52"
            dscp_forward: "enable"
            dscp_forward_tag: "<your_own_value>"
            dscp_reverse: "enable"
            dscp_reverse_tag: "<your_own_value>"
            dst:
             -
                name: "default_name_58 (source firewall.address.name firewall.addrgrp.name)"
            dst_negate: "enable"
            dst6:
             -
                name: "default_name_61 (source firewall.address6.name firewall.addrgrp6.name)"
            end_port: "62"
            groups:
             -
                name: "default_name_64 (source user.group.name)"
            health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
            id:  "66"
            input_device:
             -
                name: "default_name_68 (source system.interface.name)"
            internet_service: "enable"
            internet_service_ctrl:
             -
                id:  "71"
            internet_service_ctrl_group:
             -
                name: "default_name_73 (source application.group.name)"
            internet_service_custom:
             -
                name: "default_name_75 (source firewall.internet-service-custom.name)"
            internet_service_custom_group:
             -
                name: "default_name_77 (source firewall.internet-service-custom-group.name)"
            internet_service_group:
             -
                name: "default_name_79 (source firewall.internet-service-group.name)"
            internet_service_id:
             -
                id:  "81 (source firewall.internet-service.id)"
            jitter_weight: "82"
            latency_weight: "83"
            link_cost_factor: "latency"
            link_cost_threshold: "85"
            member: "86"
            mode: "auto"
            name: "default_name_88"
            packet_loss_weight: "89"
            priority_members:
             -
                seq_num: "91 (source system.virtual-wan-link.members.seq-num)"
            protocol: "92"
            quality_link: "93"
            route_tag: "94"
            sla:
             -
                health_check: "<your_own_value> (source system.virtual-wan-link.health-check.name)"
                id:  "97"
            src:
             -
                name: "default_name_99 (source firewall.address.name firewall.addrgrp.name)"
            src_negate: "enable"
            src6:
             -
                name: "default_name_102 (source firewall.address6.name firewall.addrgrp6.name)"
            start_port: "103"
            status: "enable"
            tos: "<your_own_value>"
            tos_mask: "<your_own_value>"
            users:
             -
                name: "default_name_108 (source user.local.name)"
        status: "disable"

Значения возврата

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

Ключ Возвращаемое значение Описание
build
string
всегда
Номер сборки образа FortiGate

Пример:
1547
http_method
string
всегда
Последний метод, использованный для предоставления содержимого в FortiGate

Пример:
PUT
http_status
string
всегда
Последний результат, возвращённый FortiGate при последнем применённом действии

Пример:
200
mkey
string
успех
Главный ключ (id), использованный в последнем запросе к FortiGate

Пример:
id
name
string
всегда
Имя таблицы, использованной для выполнения запроса

Пример:
urlfilter
path
string
всегда
Путь таблицы, использованной для выполнения запроса

Пример:
webfilter
revision
string
всегда
Внутренний номер версии

Пример:
17.0.2.10658
serial
string
всегда
Серийный номер устройства

Пример:
FGVMEVYYQT3AB5352
status
string
всегда
Указание результата операции

Пример:
успех
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–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortios/fortios_system_virtual_wan_link_module.html

Spec-Zone.ru

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