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

Примечание

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

Вам, возможно, эта коллекция уже установлена, если вы используете пакет 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.15

Параметры

Параметр	Комментарии
access_token строка	Аутентификация на основе токена. Сгенерировано в интерфейсе Fortigate.
enable_log логический	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
member_path строка	Путь к атрибуту члена для обработки. Разделяется слэшем, если атрибутов несколько. Параметр с member_path допустим для операций с членом.
member_state строка	Добавление или удаление члена по указанному пути атрибута. Если указан member_state, параметр state игнорируется. Варианты: `"present"` `"absent"`
vdom строка	Виртуальная область, среди ранее определённых. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельная единица. По умолчанию: `"root"`
vpn_ocvpn словарь	Настройка параметров VPN Overlay Controller.
auto_discovery строка	Включить/отключить ярлыки автоматического обнаружения. Варианты: `"enable"` `"disable"`
auto_discovery_shortcut_mode строка	Управление удалением дочерних туннелей-ярлыков, когда родительский туннель выходит из строя. Варианты: `"independent"` `"dependent"`
eap строка	Включить/отключить аутентификацию EAP клиента. Варианты: `"enable"` `"disable"`
eap_users строка	Группа пользователей аутентификации EAP. Источник user.group.name.
forticlient_access словарь	Настройка параметров FortiClient.
auth_groups список / элементы=словарь	Группы аутентификации пользователей FortiClient.
auth_group строка	Группа аутентификации пользователей для доступа FortiClient. Источник user.group.name.
name строка / обязательно	Имя группы.
overlays список / элементы=словарь	OCVPN-перекрытия для разрешения доступа.
overlay_name строка / обязательно	Имя перекрытия. Источник vpn.ocvpn.overlays.overlay-name.
psksecret строка	Предварительно согласованный секрет для аутентификации FortiClient PSK (строка ASCII или шестнадцатеричное кодирование с ведущим 0x).
status строка	Включить/отключить доступ FortiClient к OCVPN сетям. Варианты: `"enable"` `"disable"`
ha_alias строка	Скрытый псевдоним HA.
ip_allocation_block строка	Подсеть класса B, резервируемая для присвоения частного IP-адреса.
multipath строка	Включить/отключить многопутевую избыточность. Варианты: `"enable"` `"disable"`

END_OF_DOCUMENT_MARKER

nat string	Включить/отключить поддержку NAT. Варианты: `"enable"` `"disable"`
overlays list / elements=dictionary	сетевые наложения для регистрации в службе Overlay Controller VPN.
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 / required	Имя наложения.
subnets list / elements=dictionary	Внутренние подсети для регистрации в службе OCVPN.
id integer / required	Идентификатор. см. <a href=’#notes’>Примечания</a>.
interface string	Интерфейс LAN. Источник system.interface.name.
subnet string	IPv4-адрес и маска подсети.
type string	Тип подсети. Варианты: `"subnet"` `"interface"`
poll_interval integer	Интервал опроса Overlay Controller VPN.
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 / elements=dictionary	Внутренние подсети для регистрации в службе Overlay Controller VPN.
id integer / required	Идентификатор. см. <a href=’#notes’>Примечания</a>.
interface string	Интерфейс LAN. Источник system.interface.name.
subnet string	IPv4-адрес и маска подсети.
type string	Тип подсети. Варианты: `"subnet"` `"interface"`

wan_interface list / elements=dictionary	Интерфейсы FortiGate WAN для использования с OCVPN.
name string / required	Имя интерфейса. Источник system.interface.name.

Примечания

Примечание

Устаревший fortiosapi был снят с поддержки, httpapi — предпочтительный способ запуска playbook'ов

Примеры

- 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	Главный ключ (id), используемый в последнем вызове 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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortios/fortios_vpn_ocvpn_module.html