Модуль fortinet.fortios.fortios_vpn_ssl_web_portal — Портал в 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_ssl_web_portal.
Добавлена в fortinet.fortios 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию vpn_ssl_web и категорию портала. Примеры включают в себя все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Проверено на FOS v6.0.0
Требования
Ниже перечислены требования, которые необходимы на хосте, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано из графического интерфейса Fortigate. |
enable_log логический тип | Включить/выключить ведение журнала для задачи. Выбори:
|
member_path строка | Путь к атрибуту элемента для обработки. Разделяется символом «/» если атрибутов несколько. Параметр, помеченный как member_path, подходит для выполнения операций с элементами. |
member_state строка | Добавить или удалить элемент по указанному пути к атрибуту. Когда member_state указан, опция state игнорируется. Выбори:
|
state строка / обязательно | Указывает, нужно ли создать или удалить объект. Выбори:
|
vdom строка | Виртуальная область, среди ранее определённых. VDOM — это виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельное устройство. По умолчанию: |
vpn_ssl_web_portal словарь | Портал. |
|
allow_user_access список / элементы=строка |
Разрешить пользователям доступ к приложениям SSL-VPN. Выбори:
|
|
auto_connect строка |
Включить/выключить автоматическое подключение клиентом при включении системы. Выбори:
|
|
bookmark_group список / элементы=словарь |
Группа закладок портала. |
|
bookmarks список / элементы=словарь |
Таблица закладок. |
|
additional_params строка |
Дополнительные параметры. |
|
apptype строка |
Тип приложения. Выбори:
|
|
color_depth строка |
Глубина цвета на пиксель. Выбори:
|
|
description строка |
Описание. |
|
domain строка |
Домен входа. |
|
folder строка |
Параметр сетевой общей папки. |
|
form_data список / элементы=словарь |
Данные формы. |
|
name строка / обязательно |
Имя. |
|
value строка |
Значение. |
|
height integer |
Высота экрана (диапазон от 0 до 65535). |
|
host string |
Имя хоста/IP-параметр. |
|
keyboard_layout string |
Раскладка клавиатуры. Choices:
|
|
listening_port integer |
Порт прослушивания (0 - 65535). |
|
load_balancing_info string |
Информация о балансировке нагрузки или cookie, которые должны быть предоставлены брокеру подключений. |
|
logon_password string |
Пароль для входа. |
|
logon_user string |
Пользователь для входа. |
|
name string / required |
Имя закладки. |
|
port integer |
Удаленный порт. |
|
preconnection_blob string |
Произвольная строка, которая идентифицирует источник RDP. |
|
preconnection_id integer |
Числовой ID источника RDP (0-4294967295). |
|
remote_port integer |
Удаленный порт (0 - 65535). |
|
restricted_admin string |
Включить/отключить режим ограниченного администратора для RDP. Choices:
|
|
security string |
Режим безопасности для RDP-подключения. Choices:
|
|
send_preconnection_id string |
Включить/отключить отправку ID предварительного подключения. Choices:
|
|
server_layout string |
Раскладка клавиатуры на стороне сервера. Choices:
|
|
show_status_window string |
Включить/отключить отображение окна состояния. Choices:
|
|
sso string |
Единый вход. Choices:
|
|
sso_credential string |
Учётные данные для единого входа. Choices:
|
|
sso_credential_sent_once string |
Учётные данные для единого входа отправляются на удалённый сервер только один раз. Choices:
|
|
sso_password string |
Пароль SSO. |
|
sso_username string |
Имя пользователя SSO. |
|
url string |
Параметр URL. |
|
vnc_keyboard_layout string |
Раскладка клавиатуры. Choices:
|
|
width integer |
Ширина экрана (диапазон от 0 до 65535). |
|
name string / required |
Имя группы закладок. |
|
client_src_range string |
Разрешить клиенту добавить диапазон источников для трафика туннеля. Choices:
|
|
clipboard string |
Включить поддержку функциональности буфера обмена RDP/VPC. Choices:
|
|
custom_lang string |
Изменить язык отображения веб-портала. Переопределяет глобально установленный язык системы конфигурации. Вы можете использовать config system custom-language и выполнить system custom-language, чтобы добавить пользовательские языковые файлы. Источник system.custom-language.name. |
|
customize_forticlient_download_url string |
Включить поддержку настраиваемого URL-адреса загрузки для FortiClient. Choices:
|
|
default_protocol string |
Тип приложения, устанавливаемый по умолчанию. Choices:
|
|
default_window_height integer |
Высота экрана (диапазон от 0 до 65535). |
|
default_window_width integer |
Ширина экрана (диапазон от 0 до 65535). |
|
dhcp6_ra_linkaddr string |
Адрес ссылки IPv6 агента ретрансляции, который будет использоваться в запросах DHCP6. |
|
dhcp_ip_overlap string |
Настроить назначение перекрывающегося распределения IP-адресов DHCP. Choices:
|
|
dhcp_ra_giaddr string |
IP-адрес шлюза агента ретрансляции, который будет использоваться в поле giaddr запросов DHCP. |
|
display_bookmark string |
Включить отображение виджета закладок веб-портала. Choices:
|
|
display_connection_tools string |
Включить отображение виджета инструментов подключения веб-портала. Choices:
|
|
display_history string |
Включить отображение виджета истории входа пользователей веб-портала. Choices:
|
|
display_status string |
Включить отображение виджета состояния веб-портала. Choices:
|
|
dns_server1 string |
DNS-сервер IPv4 1. |
|
dns_server2 string |
DNS-сервер IPv4 2. |
|
dns_suffix string |
Суффикс DNS. |
|
exclusive_routing string |
Включить/отключить прохождение всего трафика только через туннель. Choices:
|
|
focus_bookmark string |
Включить приоритетное размещение раздела закладок над разделом быстрого подключения в приложении SSL-VPN. Choices:
|
|
forticlient_download string |
Включить/отключить опцию загрузки FortiClient. Choices:
|
|
forticlient_download_method string |
Метод загрузки FortiClient. Choices:
|
|
heading string |
Заголовок веб-портала. |
|
hide_sso_credential string |
Включить, чтобы предотвратить отправку учетных данных SSO клиенту. Choices:
|
|
host_check string |
Тип проверки узла, выполняемой на конечных точках. Choices:
|
|
host_check_interval integer |
Периодический интервал проверки узла. Значение 0 означает отключено, и проверка узла происходит только при подключении конечной точки. |
|
host_check_policy list / elements=dictionary |
Одна или несколько политик, требующих от конечной точки наличия определенного программного обеспечения безопасности. |
|
name string / required |
Имя списка программного обеспечения для проверки узла. Источник vpn.ssl.web.host-check-software.name. |
|
ip_mode string |
Метод, с помощью которого пользователи этого туннеля SSL-VPN получают IP-адреса. Choices:
|
|
ip_pools list / elements=dictionary |
Объекты исходных адресов брандмауэра IPv4, зарезервированные для клиентов режима туннеля SSL-VPN. |
|
name string / required |
Имя адреса. Источник firewall.address.name firewall.addrgrp.name. |
|
ipv6_dns_server1 string |
Сервер IPv6 DNS 1. |
|
ipv6_dns_server2 string |
Сервер IPv6 DNS 2. |
|
ipv6_exclusive_routing string |
Включить/отключить прохождение всего трафика IPv6 только через туннель. Choices:
|
|
ipv6_pools list / elements=dictionary |
Объекты исходных адресов брандмауэра IPv6, зарезервированные для клиентов в режиме туннеля SSL-VPN. |
|
name string / required |
Имя адреса. Источник firewall.address6.name firewall.addrgrp6.name. |
|
ipv6_service_restriction string |
Включить/отключить ограничение службы туннеля IPv6. Choices:
|
|
ipv6_split_tunneling string |
Включить/отключить разделение туннелирования IPv6. Choices:
|
|
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. Choices:
|
|
ipv6_tunnel_mode string |
Включить/отключить режим туннеля IPv6 SSL-VPN. Choices:
|
|
ipv6_wins_server1 string |
Сервер IPv6 WINS 1. |
|
ipv6_wins_server2 string |
Сервер IPv6 WINS 2. |
|
keep_alive string |
Включить/отключить автоматическое переподключение для соединений FortiClient. Choices:
|
|
landing_page dictionary |
Параметры целевой страницы. |
|
form_data list / elements=dictionary |
Данные формы. |
|
name string / required |
Имя. |
|
value string |
Значение. |
|
logout_url string |
URL выхода с целевой страницы. |
|
sso string |
Единый вход. Choices:
|
|
sso_credential string |
Учётные данные единого входа. Choices:
|
|
sso_password string |
Пароль SSO. |
|
sso_username string |
Имя пользователя SSO. |
|
url string |
URL целевой страницы. |
|
landing_page_mode string |
Включить/отключить режим целевой страницы SSL-VPN. Choices:
|
|
limit_user_logins string |
Включить, чтобы ограничить каждого пользователя одним сеансом SSL-VPN за раз. Choices:
|
|
mac_addr_action string |
Действие с MAC-адресом клиента. Choices:
|
|
mac_addr_check string |
Включить/отключить проверку хоста по MAC-адресу. Choices:
|
|
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 загрузки для Mac FortiClient. |
|
name string / required |
Имя портала. |
|
os_check string |
Включить, чтобы разрешить FortiGate принимать решение на основе ОС клиента. Choices:
|
|
os_check_list list / elements=dictionary |
Проверки ОС SSL-VPN. |
|
action string |
Параметры проверки ОС. Choices:
|
|
latest_patch_level string |
Последний уровень патча ОС. |
|
name string / required |
Имя. |
|
tolerance integer |
Допуск уровня патча ОС. |
|
prefer_ipv6_dns string |
Приоритет запроса к IPv6 DNS-серверу, если включено. Choices:
|
|
redir_url string |
URL перенаправления входа клиента. |
|
rewrite_ip_uri_ui string |
Перезаписать содержимое для URI, содержащего IP и /ui/. Choices:
|
|
save_password string |
Включить/отключить сохранение пароля пользователя FortiClient. Choices:
|
|
service_restriction string |
Включить/отключить ограничение службы туннеля. Choices:
|
|
skip_check_for_browser string |
Включить, чтобы пропустить проверку узла на поддержку браузером. Choices:
|
|
skip_check_for_unsupported_browser string |
Включить, чтобы пропустить проверку узла, если браузер его не поддерживает. Choices:
|
|
skip_check_for_unsupported_os string |
Включить, чтобы пропустить проверку узла, если клиентская ОС его не поддерживает. Choices:
|
|
smb_max_version string |
Максимальная версия протокола клиента SMB. Choices:
|
|
smb_min_version string |
Минимальная версия протокола клиента SMB. Choices:
|
|
smb_ntlmv1_auth string |
Включить поддержку NTLMv1 для аутентификации Samba. Choices:
|
|
smbv1 string |
SMB версия 1. Choices:
|
|
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 |
ID. см. <a href=’#notes’>Примечания</a>. |
|
ipv6_dns_server1 string |
IPv6 DNS-сервер 1. |
|
ipv6_dns_server2 string |
IPv6 DNS-сервер 2. |
|
split_tunneling string |
Включить/отключить разделение туннелирования IPv4. Choices:
|
|
split_tunneling_routing_address list / elements=dictionary |
Объекты адресов брандмауэра в режиме туннелирования IPv4 SSL-VPN, которые переопределяют адреса назначения политики брандмауэра для управления доступом к разделению туннелирования. |
|
name string / required |
Имя адреса. Источник firewall.address.name firewall.addrgrp.name. |
|
split_tunneling_routing_negate string |
Включить, чтобы инвертировать адрес маршрутизации разделения туннелирования. Choices:
|
|
Тема строка |
Схема цветовой темы веб-портала. Выбоpы:
|
|
transform_backward_slashes строка |
Преобразовать обратные слэши в прямые в URL. Выбоpы:
|
|
tunnel_mode строка |
Включить/выключить режим туннеля IPv4 SSL-VPN. Выбоpы:
|
|
use_sdwan строка |
Использовать правила SD-WAN для получения выходного интерфейса. Выбоpы:
|
|
user_bookmark строка |
Включить, чтобы пользователи веб-портала могли создавать собственные закладки. Выбоpы:
|
|
user_group_bookmark строка |
Включить, чтобы пользователи веб-портала могли создавать закладки для всех пользователей в той же группе пользователей. Выбоpы:
|
|
web_mode строка |
Включить/выключить режим веб-портала SSL-VPN. Выбоpы:
|
|
windows_forticlient_download_url строка |
URL для загрузки Windows FortiClient. |
|
wins_server1 строка |
IPv4 WINS-сервер 1. |
|
wins_server2 строка |
IPv4 WINS-сервер 1. |
Примечания
Примечание
- Модуль fortiosapi устарел, предпочтительный способ выполнения playbook - 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>"
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_68 (source vpn.ssl.web.host-check-software.name)"
ip_mode: "range"
ip_pools:
-
name: "default_name_71 (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_76 (source firewall.address6.name firewall.addrgrp6.name)"
ipv6_service_restriction: "enable"
ipv6_split_tunneling: "enable"
ipv6_split_tunneling_routing_address:
-
name: "default_name_80 (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_88"
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_104"
macos_forticlient_download_url: "<your_own_value>"
name: "default_name_106"
os_check: "enable"
os_check_list:
-
action: "deny"
latest_patch_level: "<your_own_value>"
name: "default_name_111"
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: "129"
ipv6_dns_server1: "<your_own_value>"
ipv6_dns_server2: "<your_own_value>"
split_tunneling: "enable"
split_tunneling_routing_address:
-
name: "default_name_134 (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 строка | Номер сборки образа Fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для предоставления содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, предоставленный FortiGate по последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь к таблице, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на коллекцию
© 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_ssl_web_portal_module.html