Модуль fortinet.fortios.fortios_vpn_ssl_web_portal – портал в 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_ssl_web_portal.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функции vpn_ssl_web и категории portal. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0
Требования
На узле, выполняющем этот модуль, должны быть установлены следующие компоненты.
- ansible>=2.16
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Аутентификация на основе токена. Создается в графическом интерфейсе FortiGate. |
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
member_path string | Путь к атрибуту элемента, с которым нужно выполнить операцию. Если атрибутов несколько, они разделяются символом косой черты. Параметр с пометкой member_path можно использовать для выполнения операции с элементом. |
member_state string | Добавить или удалить элемент по указанному пути к атрибуту. Если задан параметр member_state, параметр state игнорируется. Варианты:
|
state string / обязательный | Указывает, следует ли создать или удалить объект. Варианты:
|
vdom string | Виртуальный домен из числа предварительно определенных. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство. По умолчанию: |
vpn_ssl_web_portal dictionary | Портал. |
|
allow_user_access list / elements=string |
Разрешить пользователям доступ к приложениям VPN без клиента. Варианты:
|
|
auto_connect string |
Включить или отключить автоматическое подключение клиента при запуске системы. Варианты:
|
|
bookmark_group list / elements=dictionary |
Группа закладок портала. |
|
bookmarks list / elements=dictionary |
Таблица закладок. |
|
additional_params string |
Дополнительные параметры. |
|
apptype string |
Тип приложения. Варианты:
|
|
color_depth string |
Глубина цвета на пиксель. Варианты:
|
|
description string |
Описание. |
|
domain string |
Домен для входа. |
|
folder string |
Параметр папки общей сетевой папки. |
|
form_data list / elements=dictionary |
Данные формы. |
|
name string / обязательный |
Имя. |
|
value string |
Значение. |
|
height integer |
Высота экрана (диапазон от 0 до 65535). |
|
host string |
Параметр имени хоста/IP-адреса. |
|
keyboard_layout string |
Раскладка клавиатуры. Варианты:
|
|
listening_port integer |
Порт прослушивания (0–65535). |
|
load_balancing_info string |
Информация о балансировке нагрузки или cookie, которые следует передать брокеру подключений. |
|
logon_password string |
Пароль для входа. |
|
logon_user string |
Пользователь для входа. |
|
name string / обязательный |
Имя закладки. |
|
port integer |
Удаленный порт. |
|
preconnection_blob string |
Произвольная строка, идентифицирующая источник RDP. |
|
preconnection_id integer |
Числовой идентификатор источника RDP (0–4294967295). |
|
remote_port integer |
Удаленный порт (0–65535). |
|
restricted_admin string |
Включить или отключить режим ограниченного администрирования для RDP. Варианты:
|
|
security string |
Режим безопасности для RDP-подключения. Варианты:
|
|
send_preconnection_id string |
Включить или отключить отправку идентификатора предварительного подключения. Варианты:
|
|
server_layout string |
Раскладка клавиатуры на стороне сервера. Варианты:
|
|
show_status_window string |
Включить или отключить отображение окна состояния. Варианты:
|
|
sso string |
Единый вход. Варианты:
|
|
sso_credential string |
Учетные данные единого входа. Варианты:
|
|
sso_credential_sent_once string |
Учетные данные единого входа отправляются на удаленный сервер только один раз. Варианты:
|
|
sso_password string |
Пароль единого входа. |
|
sso_username string |
Имя пользователя единого входа. |
|
url string |
Параметр URL. |
|
vnc_keyboard_layout string |
Раскладка клавиатуры. Варианты:
|
|
width integer |
Ширина экрана (диапазон от 0 до 65535). |
|
name string / обязательный |
Имя группы закладок. |
|
client_src_range string |
Разрешить клиенту добавлять диапазон исходных адресов для туннельного трафика. Варианты:
|
|
clipboard string |
Включить поддержку функции буфера обмена RDP/VPC. Варианты:
|
|
custom_lang string |
Изменить язык отображения веб-портала. Переопределяет значение, заданное командой config system global set language. Чтобы добавить файлы пользовательских языков, можно использовать команды config system custom-language и execute system custom-language. Источник: system.custom-language.name. |
|
customize_forticlient_download_url string | Включить поддержку пользовательского URL для загрузки FortiClient. Варианты:
|
|
default_protocol string |
Тип приложения, установленный по умолчанию. Варианты:
|
|
default_window_height integer |
Высота экрана (от 0 до 65535). |
|
default_window_width integer |
Ширина экрана (от 0 до 65535). |
|
dhcp6_ra_linkaddr string |
IPv6-адрес канала ретрансляционного агента, используемый в запросах DHCP6. |
|
dhcp_ip_overlap string |
Настройка назначения перекрывающихся IP-адресов DHCP. Варианты:
|
|
dhcp_ra_giaddr string |
IP-адрес шлюза ретрансляционного агента, используемый в поле giaddr запросов DHCP. |
|
dhcp_reservation string |
Включить или отключить резервирование DHCP. Варианты:
|
|
display_bookmark string |
Включить отображение виджета закладок веб-портала. Варианты:
|
|
display_connection_tools string |
Включить отображение виджета инструментов подключения веб-портала. Варианты:
|
|
display_history string |
Включить отображение виджета истории входов пользователя на веб-портале. Варианты:
|
|
display_status string |
Включить отображение виджета состояния веб-портала. Варианты:
|
|
dns_server1 string |
DNS-сервер IPv4 1. |
|
dns_server2 string |
DNS-сервер IPv4 2. |
|
dns_suffix string |
Суффикс DNS. |
|
exclusive_routing string |
Включить или отключить передачу всего трафика только через туннель. Варианты:
|
|
focus_bookmark string |
Включить приоритетное размещение раздела закладок над разделом быстрого подключения в приложении Agentless VPN. Варианты:
|
|
forticlient_download string |
Включить или отключить возможность загрузки FortiClient. Варианты:
|
|
forticlient_download_method string |
Способ загрузки FortiClient. Варианты:
|
|
heading string |
Заголовок веб-портала. |
|
hide_sso_credential string |
Включить, чтобы учетные данные SSO не отправлялись клиенту. Варианты:
|
|
host_check string |
Тип проверки узла, выполняемой на конечных устройствах. Варианты:
|
|
host_check_interval integer |
Интервал периодической проверки узла. Значение 0 означает, что проверка отключена и выполняется только при подключении конечного устройства. |
|
host_check_policy list / elements=dictionary |
Одна или несколько политик, требующих наличия определенного защитного ПО на конечном устройстве. |
|
name string / required |
Имя списка ПО для проверки узла. Источник: vpn.ssl.web.host-check-software.name. |
|
ip_mode string |
Способ получения IP-адресов пользователями этого туннеля SSL-VPN. Варианты:
|
|
ip_pools list / elements=dictionary |
Объекты исходных адресов IPv4 брандмауэра, зарезервированные для клиентов туннельного режима SSL-VPN. |
|
name string / required |
Имя адреса. Источник: firewall.address.name, firewall.addrgrp.name. |
|
ipv6_dns_server1 string |
DNS-сервер IPv6 1. |
|
ipv6_dns_server2 string |
DNS-сервер IPv6 2. |
|
ipv6_exclusive_routing string |
Включить или отключить передачу всего трафика IPv6 только через туннель. Варианты:
|
|
ipv6_pools list / elements=dictionary |
Объекты исходных адресов IPv6 брандмауэра, зарезервированные для клиентов туннельного режима SSL-VPN. |
|
name string / required |
Имя адреса. Источник: firewall.address6.name, firewall.addrgrp6.name. |
|
ipv6_service_restriction string |
Включить или отключить ограничение служб туннеля IPv6. Варианты:
|
|
ipv6_split_tunneling string |
Включить или отключить раздельную туннелизацию IPv6. Варианты:
|
|
ipv6_split_tunneling_routing_address list / elements=dictionary |
Объекты адресов IPv6 брандмауэра для туннельного режима SSL-VPN, переопределяющие адреса назначения в политиках брандмауэра для управления доступом при раздельной туннелизации. |
|
name string / required |
Имя адреса. Источник: firewall.address6.name, firewall.addrgrp6.name. |
|
ipv6_split_tunneling_routing_negate string |
Включить инверсию адреса маршрутизации раздельной туннелизации IPv6. Варианты:
|
|
ipv6_tunnel_mode string |
Включить или отключить туннельный режим IPv6 SSL-VPN. Варианты:
|
|
ipv6_wins_server1 string |
WINS-сервер IPv6 1. |
|
ipv6_wins_server2 string |
WINS-сервер IPv6 2. |
|
keep_alive string |
Включить или отключить автоматическое повторное подключение для соединений FortiClient. Варианты:
|
|
landing_page dictionary |
Параметры целевой страницы. |
|
form_data list / elements=dictionary |
Данные формы. |
|
name string / required |
Имя. |
|
value string |
Значение. |
|
logout_url string |
URL-адрес выхода с целевой страницы. |
|
sso string |
Единый вход (SSO). Варианты:
|
|
sso_credential string |
Учетные данные единого входа (SSO). Варианты:
|
|
sso_password string |
Пароль SSO. |
|
sso_username string |
Имя пользователя SSO. |
|
url string |
URL-адрес целевой страницы. |
|
landing_page_mode string |
Включить или отключить режим целевой страницы Agentless VPN. Варианты:
|
|
limit_user_logins string |
Включить ограничение: для каждого пользователя может быть открыта только одна сессия Agentless VPN одновременно. Варианты:
|
|
mac_addr_action string |
Действие при обнаружении MAC-адреса клиента. Варианты:
|
|
mac_addr_check string |
Включить или отключить проверку MAC-адреса узла. Варианты:
|
|
mac_addr_check_rule list / elements=dictionary |
Правило проверки MAC-адреса клиента. |
|
mac_addr_list list / elements=dictionary |
Список MAC-адресов клиента. |
|
addr string / required |
MAC-адрес клиента. |
|
mac_addr_mask integer |
Маска MAC-адреса клиента. |
|
name string / required |
Имя правила проверки MAC-адреса клиента. |
|
macos_forticlient_download_url string |
URL загрузки FortiClient для Mac. |
|
name string / required |
Имя портала. |
|
os_check string |
Включите, чтобы FortiGate выбирал действие на основе ОС клиента. Варианты:
|
|
os_check_list list / elements=dictionary |
Проверки ОС для SSL-VPN. |
|
action string |
Параметры проверки ОС. Варианты:
|
|
latest_patch_level string |
Последний уровень исправлений ОС. |
|
name string / required |
Имя. |
|
tolerance integer |
Допуск для уровня исправлений ОС. |
|
prefer_ipv6_dns string |
Если параметр включен, сначала предпочтительно запрашивать DNS-сервер IPv6. Варианты:
|
|
redir_url string |
URL перенаправления клиента после входа в систему. |
|
rewrite_ip_uri_ui string |
Перезаписывать содержимое, если URI содержит IP-адрес и /ui/. Варианты:
|
|
save_password string |
Включить/отключить сохранение пароля пользователя в FortiClient. Варианты:
|
|
service_restriction string |
Включить/отключить ограничение туннельной службы. Варианты:
|
|
skip_check_for_browser string |
Включите, чтобы пропустить проверку узла на поддержку браузера. Варианты:
|
|
skip_check_for_unsupported_browser string |
Включите, чтобы пропустить проверку узла, если браузер не поддерживает ее. Варианты:
|
|
skip_check_for_unsupported_os string |
Включите, чтобы пропустить проверку узла, если ОС клиента не поддерживается. Варианты:
|
|
smb_max_version string |
Максимальная версия клиентского протокола SMB. Варианты:
|
|
smb_min_version string |
Минимальная версия клиентского протокола SMB. Варианты:
|
|
smb_ntlmv1_auth string |
Включить поддержку NTLMv1 для аутентификации Samba. Варианты:
|
|
smbv1 string |
Версия SMB 1. Варианты:
|
|
split_dns list / elements=dictionary |
Раздельный DNS для SSL-VPN. |
|
dns_server1 string |
DNS-сервер 1. |
|
dns_server2 string |
DNS-сервер 2. |
|
domains string |
Домены раздельного DNS для клиентов SSL-VPN, разделенные запятыми. |
|
id integer / required |
Идентификатор. См. <a href=’#notes’>Примечания</a>. |
|
ipv6_dns_server1 string |
DNS-сервер IPv6 1. |
|
ipv6_dns_server2 string |
DNS-сервер IPv6 2. |
|
split_tunneling string |
Включить/отключить раздельное туннелирование IPv4. Варианты:
|
|
split_tunneling_routing_address list / elements=dictionary |
Объекты адресов брандмауэра для режима туннеля SSL-VPN IPv4, переопределяющие адреса назначения в политике брандмауэра для управления доступом при раздельном туннелировании. |
|
name string / required |
Имя адреса. Источник: firewall.address.name, firewall.addrgrp.name. |
|
split_tunneling_routing_negate string |
Включите, чтобы инвертировать адрес маршрутизации раздельного туннелирования. Варианты:
|
|
theme string |
Цветовая схема веб-портала. Варианты:
|
|
transform_backward_slashes string |
Преобразовывать обратные косые черты в прямые косые черты в URL-адресах. Варианты:
|
|
tunnel_mode string |
Включить/отключить режим туннеля SSL-VPN IPv4. Варианты:
|
|
use_sdwan string |
Использовать правила SD-WAN для определения выходного интерфейса. Варианты:
|
|
user_bookmark string |
Включите, чтобы разрешить пользователям веб-портала создавать собственные закладки. Варианты:
|
|
user_group_bookmark string |
Включите, чтобы разрешить пользователям веб-портала создавать закладки для всех пользователей той же группы пользователей. Варианты:
|
|
web_mode string |
Включить/отключить веб-режим VPN без агента. Варианты:
|
|
windows_forticlient_download_url string |
URL загрузки FortiClient для Windows. |
|
wins_server1 string |
IPv4-сервер WINS 1. |
|
wins_server2 string |
IPv4-сервер WINS 1. |
Примечания
Примечание
- Устаревший fortiosapi объявлен нерекомендуемым; предпочтительный способ запуска плейбуков — httpapi.
- Модуль поддерживает check_mode.
Примеры
- name: Portal.
fortinet.fortios.fortios_vpn_ssl_web_portal:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
vpn_ssl_web_portal:
allow_user_access: "web"
auto_connect: "enable"
bookmark_group:
-
bookmarks:
-
additional_params: "<your_own_value>"
apptype: "ftp"
color_depth: "32"
description: "<your_own_value>"
domain: "<your_own_value>"
folder: "<your_own_value>"
form_data:
-
name: "default_name_14"
value: "<your_own_value>"
height: "768"
host: "myhostname"
keyboard_layout: "ar-101"
listening_port: "0"
load_balancing_info: "<your_own_value>"
logon_password: "<your_own_value>"
logon_user: "<your_own_value>"
name: "default_name_23"
port: "0"
preconnection_blob: "<your_own_value>"
preconnection_id: "2147483648"
remote_port: "0"
restricted_admin: "enable"
security: "any"
send_preconnection_id: "enable"
server_layout: "de-de-qwertz"
show_status_window: "enable"
sso: "disable"
sso_credential: "sslvpn-login"
sso_credential_sent_once: "enable"
sso_password: "<your_own_value>"
sso_username: "<your_own_value>"
url: "myurl.com"
vnc_keyboard_layout: "default"
width: "1024"
name: "default_name_41"
client_src_range: "enable"
clipboard: "enable"
custom_lang: "<your_own_value> (source system.custom-language.name)"
customize_forticlient_download_url: "enable"
default_protocol: "web"
default_window_height: "768"
default_window_width: "1024"
dhcp_ip_overlap: "use-new"
dhcp_ra_giaddr: "<your_own_value>"
dhcp_reservation: "enable"
dhcp6_ra_linkaddr: "<your_own_value>"
display_bookmark: "enable"
display_connection_tools: "enable"
display_history: "enable"
display_status: "enable"
dns_server1: "<your_own_value>"
dns_server2: "<your_own_value>"
dns_suffix: "<your_own_value>"
exclusive_routing: "enable"
focus_bookmark: "enable"
forticlient_download: "enable"
forticlient_download_method: "direct"
heading: "<your_own_value>"
hide_sso_credential: "enable"
host_check: "none"
host_check_interval: "0"
host_check_policy:
-
name: "default_name_69 (source vpn.ssl.web.host-check-software.name)"
ip_mode: "range"
ip_pools:
-
name: "default_name_72 (source firewall.address.name firewall.addrgrp.name)"
ipv6_dns_server1: "<your_own_value>"
ipv6_dns_server2: "<your_own_value>"
ipv6_exclusive_routing: "enable"
ipv6_pools:
-
name: "default_name_77 (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_service_restriction: "enable"
ipv6_split_tunneling: "enable"
ipv6_split_tunneling_routing_address:
-
name: "default_name_81 (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_split_tunneling_routing_negate: "enable"
ipv6_tunnel_mode: "enable"
ipv6_wins_server1: "<your_own_value>"
ipv6_wins_server2: "<your_own_value>"
keep_alive: "enable"
landing_page:
form_data:
-
name: "default_name_89"
value: "<your_own_value>"
logout_url: "<your_own_value>"
sso: "disable"
sso_credential: "sslvpn-login"
sso_password: "<your_own_value>"
sso_username: "<your_own_value>"
url: "myurl.com"
landing_page_mode: "enable"
limit_user_logins: "enable"
mac_addr_action: "allow"
mac_addr_check: "enable"
mac_addr_check_rule:
-
mac_addr_list:
-
addr: "<your_own_value>"
mac_addr_mask: "48"
name: "default_name_105"
macos_forticlient_download_url: "<your_own_value>"
name: "default_name_107"
os_check: "enable"
os_check_list:
-
action: "deny"
latest_patch_level: "<your_own_value>"
name: "default_name_112"
tolerance: "0"
prefer_ipv6_dns: "enable"
redir_url: "<your_own_value>"
rewrite_ip_uri_ui: "enable"
save_password: "enable"
service_restriction: "enable"
skip_check_for_browser: "enable"
skip_check_for_unsupported_browser: "enable"
skip_check_for_unsupported_os: "enable"
smb_max_version: "smbv1"
smb_min_version: "smbv1"
smb_ntlmv1_auth: "enable"
smbv1: "enable"
split_dns:
-
dns_server1: "<your_own_value>"
dns_server2: "<your_own_value>"
domains: "<your_own_value>"
id: "130"
ipv6_dns_server1: "<your_own_value>"
ipv6_dns_server2: "<your_own_value>"
split_tunneling: "enable"
split_tunneling_routing_address:
-
name: "default_name_135 (source firewall.address.name firewall.addrgrp.name)"
split_tunneling_routing_negate: "enable"
theme: "jade"
transform_backward_slashes: "enable"
tunnel_mode: "enable"
use_sdwan: "enable"
user_bookmark: "enable"
user_group_bookmark: "enable"
web_mode: "enable"
windows_forticlient_download_url: "<your_own_value>"
wins_server1: "<your_own_value>"
wins_server2: "<your_own_value>"
Возвращаемые значения
Общие возвращаемые значения описаны здесь, ниже приведены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для предоставления содержимого FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Главный ключ (идентификатор), использованный при последнем вызове FortiGate Возвращается: success Пример: |
name string | Имя таблицы, использованной для выполнения запроса Возвращается: всегда Пример: |
path string | Путь к таблице, использованной для выполнения запроса Возвращается: всегда Пример: |
revision string | Внутренний номер редакции Возвращается: всегда Пример: |
serial string | Серийный номер устройства Возвращается: всегда Пример: |
status string | Результат операции Возвращается: всегда Пример: |
vdom string | Используемый виртуальный домен Возвращается: всегда Пример: |
version string | Версия FortiGate Возвращается: всегда Пример: |
Ссылки коллекции
© 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_ssl_web_portal_module.html