Spec-Zone.ru › Ansible

модуль fortinet.fortios.fortios_vpn_ocvpn — настройка параметров VPN Overlay Controller в Fortinet FortiOS и FortiGate.

Примечание

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

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

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

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

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

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции vpn и категории ocvpn. В примерах указаны все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием. Проверено на 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"

vdom

string

Виртуальный домен из числа ранее определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство.

По умолчанию: "root"

vpn_ocvpn

dictionary

Настройка параметров VPN Overlay Controller.

auto_discovery

string

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

Допустимые значения:

  • "enable"
  • "disable"

auto_discovery_shortcut_mode

string

Управление удалением дочерних туннелей shortcut при отключении родительского туннеля.

Допустимые значения:

  • "independent"
  • "dependent"

eap

string

Включить или отключить аутентификацию клиента EAP.

Допустимые значения:

  • "enable"
  • "disable"

eap_users

string

Группа пользователей для аутентификации EAP. Источник: user.group.name.

forticlient_access

dictionary

Настройка параметров FortiClient.

auth_groups

list / элементы=dictionary

Группы аутентификации пользователей FortiClient.

auth_group

string

Группа пользователей для аутентификации при доступе через FortiClient. Источник: user.group.name.

name

string / обязательный

Имя группы.

overlays

list / элементы=dictionary

Оверлеи OCVPN, доступ к которым разрешен.

overlay_name

string / обязательный

Имя оверлея. Источник: vpn.ocvpn.overlays.overlay-name.

psksecret

string

Предварительно заданный секрет для аутентификации FortiClient по PSK (строка ASCII или шестнадцатеричное значение с префиксом 0x).

status

string

Включить или отключить доступ FortiClient к сетям OCVPN.

Допустимые значения:

  • "enable"
  • "disable"

ha_alias

string

Скрытый псевдоним HA.

ip_allocation_block

string

Подсеть класса B, зарезервированная для назначения частных IP-адресов.

multipath

string

Включить или отключить резервирование с использованием нескольких путей.

Допустимые значения:

  • "enable"
  • "disable"

nat

string

Включить или отключить поддержку NAT.

Допустимые значения:

  • "enable"
  • "disable"

overlays

list / элементы=dictionary

Сетевые оверлеи для регистрации в службе VPN Overlay Controller.

assign_ip

string

Включить или отключить назначение адреса в режиме mode-cfg.

Допустимые значения:

  • "enable"
  • "disable"

id

integer

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

inter_overlay

string

Разрешить или запретить трафик из других оверлеев.

Допустимые значения:

  • "allow"
  • "deny"

ipv4_end_ip

string

Конечный адрес диапазона IPv4.

ipv4_start_ip

string

Начальный адрес диапазона IPv4.

name

string

Имя оверлея.

overlay_name

string / обязательный

Имя оверлея.

subnets

list / элементы=dictionary

Внутренние подсети для регистрации в службе OCVPN.

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

interface

string

Интерфейс LAN. Источник: system.interface.name.

subnet

string

IPv4-адрес и маска подсети.

type

string

Тип подсети.

Допустимые значения:

  • "subnet"
  • "interface"

poll_interval

integer

Интервал опроса VPN Overlay Controller.

role

string

Задать роль устройства.

Допустимые значения:

  • "spoke"
  • "primary-hub"
  • "secondary-hub"

sdwan

string

Включить или отключить добавление туннелей OCVPN в SD-WAN.

Допустимые значения:

  • "enable"
  • "disable"

sdwan_zone

string

Задать зону SD-WAN. Источник: system.sdwan.zone.name.

status

string

Включить или отключить VPN с поддержкой облака Overlay Controller.

Допустимые значения:

  • "enable"
  • "disable"

subnets

list / элементы=dictionary

Внутренние подсети для регистрации в службе VPN Overlay Controller.

id

integer / обязательный

Идентификатор. См. <a href=’#notes’>Примечания</a>.

interface

string

Интерфейс LAN. Источник: system.interface.name.

subnet

string

IPv4-адрес и маска подсети.

type

string

Тип подсети.

Допустимые значения:

  • "subnet"
  • "interface"

wan_interface

list / элементы=dictionary

Интерфейсы WAN FortiGate, используемые с OCVPN.

name

string / обязательный

Имя интерфейса. Источник: system.interface.name.

Примечания

Примечание

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

Примеры

- name: Configure Overlay Controller VPN settings.
  fortinet.fortios.fortios_vpn_ocvpn:
      vdom: "{{ vdom }}"
      vpn_ocvpn:
          auto_discovery: "enable"
          auto_discovery_shortcut_mode: "independent"
          eap: "enable"
          eap_users: "<your_own_value> (source user.group.name)"
          forticlient_access:
              auth_groups:
                  -
                      auth_group: "<your_own_value> (source user.group.name)"
                      name: "default_name_10"
                      overlays:
                          -
                              overlay_name: "<your_own_value> (source vpn.ocvpn.overlays.overlay-name)"
              psksecret: "<your_own_value>"
              status: "enable"
          ha_alias: "<your_own_value>"
          ip_allocation_block: "<your_own_value>"
          multipath: "enable"
          nat: "enable"
          overlays:
              -
                  assign_ip: "enable"
                  id: "21"
                  inter_overlay: "allow"
                  ipv4_end_ip: "<your_own_value>"
                  ipv4_start_ip: "<your_own_value>"
                  name: "default_name_25"
                  overlay_name: "<your_own_value>"
                  subnets:
                      -
                          id: "28"
                          interface: "<your_own_value> (source system.interface.name)"
                          subnet: "<your_own_value>"
                          type: "subnet"
          poll_interval: "30"
          role: "spoke"
          sdwan: "enable"
          sdwan_zone: "<your_own_value> (source system.sdwan.zone.name)"
          status: "enable"
          subnets:
              -
                  id: "38"
                  interface: "<your_own_value> (source system.interface.name)"
                  subnet: "<your_own_value>"
                  type: "subnet"
          wan_interface:
              -
                  name: "default_name_43 (source system.interface.name)"

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

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

Ключ

Описание

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_vpn_ocvpn_module.html

Spec-Zone.ru

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