модуль fortinet.fortios.fortios_system_fabric_vpn — настройка автоматически обнаруживаемой VPN для самостоятельно оркестрируемой фабрики в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

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

Обзор

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

Требования

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

ansible>=2.16

Параметры

Параметр	Комментарии
access_token string	Аутентификация на основе токена. Токен создается в графическом интерфейсе FortiGate.
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path string	Путь к атрибуту элемента, с которым выполняется операция. Если атрибутов несколько, они разделяются символом косой черты. Параметр с указанным member_path можно использовать для операций с элементами.
member_state string	Добавить или удалить элемент по указанному пути к атрибуту. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
system_fabric_vpn dictionary	Настройка автоматически обнаруживаемой VPN для самостоятельно оркестрируемой фабрики.
advertised_subnets list / элементы=dictionary	Объявляемые локальные подсети.
access string	Направление политики доступа. Варианты: `"inbound"` `"bidirectional"`
bgp_network integer	Соответствующая сеть BGP. Источник: router.bgp.network.id.
firewall_address string	Соответствующий адрес межсетевого экрана. Источник: firewall.address.name.
id integer / обязательный	Идентификатор. См. раздел <a href=’#notes’>Примечания</a>.
policies list / элементы=integer	Соответствующие политики. Источник: firewall.policy.policyid.
prefix string	Префикс сети.
bgp_as string	Номер автономной системы маршрутизатора BGP в формате asplain/asdot/asdot+.
branch_name string	Имя филиала.
health_checks list / элементы=string	Соответствующие проверки работоспособности. Источник: system.sdwan.health-check.name.
loopback_address_block string	IPv4-адрес и маска подсети для loopback-адреса хаба; формат: X.X.X.X/24.
loopback_advertised_subnet integer	Ссылка на объявляемую loopback-подсеть. Источник: system.fabric-vpn.advertised-subnets.id.
loopback_interface string	Loopback-интерфейс. Источник: system.interface.name.
overlays list / элементы=dictionary	Таблица локальных оверлейных интерфейсов.
bgp_neighbor string	Соответствующая запись соседа BGP. Источник: router.bgp.neighbor.ip.
bgp_neighbor_group string	Соответствующая запись группы соседей BGP. Источник: router.bgp.neighbor-group.name.
bgp_neighbor_range integer	Соответствующая запись диапазона соседей BGP. Источник: router.bgp.neighbor-range.id.
bgp_network integer	Соответствующая сеть BGP. Источник: router.bgp.network.id.
interface string	Имя соответствующего интерфейса. Источник: system.interface.name.
ipsec_network_id integer	Идентификатор сети VPN-шлюза.
ipsec_phase1 string	Интерфейс IPsec. Источник: vpn.ipsec.phase1-interface.name.
name string / обязательный	Имя оверлея.
overlay_policy integer	Политика оверлея, разрешающая транзитный трафик ADVPN. Источник: firewall.policy.policyid.
overlay_tunnel_block string	IPv4-адрес и маска подсети для туннеля оверлея; формат: X.X.X.X/24.
remote_gw string	IP-адрес шлюза хаба (задается хабом).
route_policy integer	Соответствующая политика маршрутизатора. Источник: router.policy.seq-num.
sdwan_member integer	Ссылка на запись участника SD-WAN. Источник: system.sdwan.members.seq-num.
policy_rule string	Правило создания политики. Варианты: `"health-check"` `"manual"` `"auto"`
psksecret string	Предварительно заданный общий секрет для ADVPN.
sdwan_zone string	Ссылка на созданную зону SD-WAN. Источник: system.sdwan.zone.name.
status string	Включить/отключить Fabric VPN. Варианты: `"enable"` `"disable"`
sync_mode string	Настройка синхронизируется фабрикой или задается вручную. Варианты: `"enable"` `"disable"`
vpn_role string	Роль Fabric VPN. Варианты: `"hub"` `"spoke"`
vdom string	Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: `"root"`

Примечания

Примечание

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

Примеры

- name: Setup for self orchestrated fabric auto discovery VPN.
  fortinet.fortios.fortios_system_fabric_vpn:
      vdom: "{{ vdom }}"
      system_fabric_vpn:
          advertised_subnets:
              -
                  access: "inbound"
                  bgp_network: "0"
                  firewall_address: "<your_own_value> (source firewall.address.name)"
                  id: "7"
                  policies: "<your_own_value> (source firewall.policy.policyid)"
                  prefix: "<your_own_value>"
          bgp_as: "<your_own_value>"
          branch_name: "<your_own_value>"
          health_checks: "<your_own_value> (source system.sdwan.health-check.name)"
          loopback_address_block: "<your_own_value>"
          loopback_advertised_subnet: "0"
          loopback_interface: "<your_own_value> (source system.interface.name)"
          overlays:
              -
                  bgp_neighbor: "<your_own_value> (source router.bgp.neighbor.ip)"
                  bgp_neighbor_group: "<your_own_value> (source router.bgp.neighbor-group.name)"
                  bgp_neighbor_range: "0"
                  bgp_network: "0"
                  interface: "<your_own_value> (source system.interface.name)"
                  ipsec_network_id: "0"
                  ipsec_phase1: "<your_own_value> (source vpn.ipsec.phase1-interface.name)"
                  name: "default_name_24"
                  overlay_policy: "0"
                  overlay_tunnel_block: "<your_own_value>"
                  remote_gw: "<your_own_value>"
                  route_policy: "0"
                  sdwan_member: "0"
          policy_rule: "health-check"
          psksecret: "<your_own_value>"
          sdwan_zone: "<your_own_value> (source system.sdwan.zone.name)"
          status: "enable"
          sync_mode: "enable"
          vpn_role: "hub"

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

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

Ключ	Описание
build string	Номер сборки образа FortiGate Возвращается: всегда Пример: `"1547"`
http_method string	Последний метод, использованный для передачи содержимого на FortiGate Возвращается: всегда Пример: `"PUT"`
http_status string	Последний результат операции, возвращенный FortiGate Возвращается: всегда Пример: `"200"`
mkey string	Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успехе Пример: `"id"`
name string	Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: `"urlfilter"`
path string	Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: `"webfilter"`
revision string	Внутренний номер ревизии Возвращается: всегда Пример: `"17.0.2.10658"`
serial string	Серийный номер устройства Возвращается: всегда Пример: `"FGVMEVYYQT3AB5352"`
status string	Результат операции Возвращается: всегда Пример: `"success"`
vdom string	Используемый виртуальный домен Возвращается: всегда Пример: `"root"`
version string	Версия FortiGate Возвращается: всегда Пример: `"v5.6.3"`

Авторы

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

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_system_fabric_vpn_module.html