fortinet.fortimanager.fmgr_vpnsslweb_portal – Портал.

Примечание

Этот плагин является частью коллекции fortinet.fortimanager (версия 2.0.1).

Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager.

Для использования в плейбуке укажите: fortinet.fortimanager.fmgr_vpnsslweb_portal.

Новое в версии 2.10: of fortinet.fortimanager

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

Обзор

Этот модуль способен настроить устройство FortiManager.
Примеры включают все параметры и значения, которые необходимо скорректировать из источников данных перед использованием.

Параметры

Параметр					Варианты/Значения по умолчанию	Комментарии
adom строка / обязательный						параметр (adom) в запрошенном URL
bypass_validation логическое					Варианты: нет ← да	устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполняться без проверки параметров
rc_failed список / элементы=строка						список кодов rc, при которых условия будут игнорироваться
rc_succeeded список / элементы=строка						список кодов rc, при которых условия будут игнорироваться
state строка / обязательный					Варианты: present absent	директива для создания, обновления или удаления объекта
vpnsslweb_portal словарь						параметры верхнего уровня
	allow-user-access список / элементы=строка				Варианты: web ftp telnet smb vnc rdp ssh ping citrix portforward sftp	нет описания
	auto-connect строка				Варианты: disable enable	Включить/выключить автоматическое подключение клиентом при включении системы.
	bookmark-group список / элементы=строка					нет описания
		bookmarks список / элементы=строка				нет описания
			additional-params строка			Дополнительные параметры.
			apptype строка		Варианты: web telnet ssh ftp smb vnc rdp citrix rdpnative portforward sftp	Тип приложения.
			description строка			Описание.
			folder строка			Параметр сетевой общей папки.
			form-data список / элементы=строка			нет описания
				name строка		Имя.
				value строка		Значение.
			host строка			Имя хоста/IP-адрес.
			listening-port целое число			Порт прослушивания (0-65535).
			load-balancing-info строка			Информация о балансировке нагрузки или cookie, которые должны быть предоставлены брокеру соединения.
			logon-password строка			нет описания
			logon-user строка			Пользователь для входа.
			name строка			Имя закладки.
			port целое число			Удаленный порт.
			preconnection-blob строка			Произвольная строка, идентифицирующая источник RDP.
			preconnection-id целое число			Числовой идентификатор источника RDP (0-2147483648).
			remote-port целое число			Удаленный порт (0-65535).
			security строка		Варианты: rdp nla tls any	Режим безопасности для подключения RDP.
			server-layout строка		Варианты: en-us-qwerty de-de-qwertz fr-fr-azerty it-it-qwerty sv-se-qwerty failsafe en-gb-qwerty es-es-qwerty fr-ch-qwertz ja-jp-qwerty pt-br-qwerty tr-tr-qwerty	Макет клавиатуры сервера.
			show-status-window строка		Варианты: disable enable	Включить/выключить отображение окна состояния.
			sso строка		Варианты: disable static auto	Single Sign-On.
			sso-credential строка		Варианты: sslvpn-login alternative	Данные для Single Sign-On.
			sso-credential-sent-once строка		Варианты: disable enable	Данные для Single Sign-On отправляются на удаленный сервер только один раз.
			sso-password строка			нет описания
			sso-username строка			Имя пользователя SSO.
			url строка			Параметр URL.
		name строка				Имя группы закладок.
	custom-lang строка					Изменение языка отображения веб-портала. Переопределяет глобально установленный язык системы конфигурации. Можно использовать пользовательский язык системы конфигурации...
	customize-forticlient-download-url строка				Варианты: disable enable	Включить поддержку настраиваемого URL для скачивания FortiClient.
	display-bookmark строка				Варианты: disable enable	Включить отображение виджета закладок на веб-портале.
	display-connection-tools строка				Варианты: disable enable	Включить отображение виджета инструментов подключения на веб-портале.
	display-history строка				Варианты: disable enable	Включить отображение виджета истории входа пользователей на веб-портале.

display-status string		Варианты: disable enable	Включить отображение виджета состояния веб-портала.
dns-server1 string			DNS-сервер IPv4 1.
dns-server2 string			DNS-сервер IPv4 2.
dns-suffix string			Суффикс DNS.
exclusive-routing string		Варианты: disable enable	Включить/выключить маршрутизацию всего трафика только через туннель.
forticlient-download string		Варианты: disable enable	Включить/выключить возможность загрузки FortiClient.
forticlient-download-method string		Варианты: direct ssl-vpn	Метод загрузки FortiClient.
heading string			Заголовок сообщения веб-портала.
hide-sso-credential string		Варианты: disable enable	Включить для предотвращения отправки учетных данных SSO клиенту.
host-check string		Варианты: none av fw av-fw custom	Тип проверки хоста, выполняемой на конечных точках.
host-check-interval integer			Периодический интервал проверки хоста. Значение 0 означает отключение, и проверка хоста происходит только при подключении конечной точки.
host-check-policy string			Одна или несколько политик, требующих от конечной точки наличия определённого защитного ПО.
ip-mode string		Варианты: range user-group	Способ получения IP-адресов пользователями этого SSL-VPN туннеля.
ip-pools string			Объекты источников IPv4 адресов брандмауэра, зарезервированные для клиентов SSL-VPN туннеля.
ipv6-dns-server1 string			DNS-сервер IPv6 1.
ipv6-dns-server2 string			DNS-сервер IPv6 2.
ipv6-exclusive-routing string		Варианты: disable enable	Включить/выключить маршрутизацию всего трафика IPv6 только через туннель.
ipv6-pools string			Объекты источников IPv4 адресов брандмауэра, зарезервированные для клиентов SSL-VPN туннеля.
ipv6-service-restriction string		Варианты: disable enable	Включить/выключить ограничение службы IPv6 туннеля.
ipv6-split-tunneling string		Варианты: disable enable	Включить/выключить разделение туннеля IPv6.
ipv6-split-tunneling-routing-address string			Объекты адресов брандмауэра IPv6 SSL-VPN туннеля, которые переопределяют адреса назначения политики брандмауэра для управления разд...
ipv6-tunnel-mode string		Варианты: disable enable	Включить/выключить режим IPv6 SSL-VPN туннеля.
ipv6-wins-server1 string			Сервер WINS IPv6 1.
ipv6-wins-server2 string			Сервер WINS IPv6 2.
keep-alive string		Варианты: disable enable	Включить/выключить автоматическое переподключение для подключений FortiClient.
limit-user-logins string		Варианты: disable enable	Включить ограничение одного SSL-VPN сеанса на одного пользователя.
mac-addr-action string		Варианты: deny allow	Действие по MAC-адресу клиента.
mac-addr-check string		Варианты: disable enable	Включить/выключить проверку MAC-адреса хоста.
mac-addr-check-rule list / elements=string			нет описания
	mac-addr-list string		нет описания
	mac-addr-mask integer		Маска MAC-адреса клиента.
	name string		Имя правила проверки MAC-адреса клиента.
macos-forticlient-download-url string			URL для скачивания Mac FortiClient.
name string			Имя портала.
os-check string		Варианты: disable enable	Включить, чтобы FortiGate определял действие на основе операционной системы клиента.
redir-url string			URL перенаправления входа клиента.
save-password string		Варианты: disable enable	Включить/выключить сохранение пароля пользователя в FortiClient.
service-restriction string		Варианты: disable enable	Включить/выключить ограничение службы туннеля.
skip-check-for-unsupported-browser string		Варианты: disable enable	Включить пропуск проверки хоста, если браузер её не поддерживает.
skip-check-for-unsupported-os string		Варианты: disable enable	Включить пропуск проверки хоста, если операционная система клиента её не поддерживает.
smb-ntlmv1-auth string		Варианты: disable enable	Включить поддержку NTLMv1 для аутентификации Samba.
smbv1 string		Варианты: disable enable	Включить/выключить поддержку SMBv1 для Samba.
split-dns list / elements=string			нет описания
	dns-server1 string		DNS-сервер 1.
	dns-server2 string		DNS-сервер 2.
	domains string		Домены разделенного DNS, используемые для клиентов SSL-VPN, разделены запятыми (,).
	id integer		Идентификатор.
	ipv6-dns-server1 string		DNS-сервер IPv6 1.
	ipv6-dns-server2 string		DNS-сервер IPv6 2.
split-tunneling string		Варианты: disable enable	Включить/выключить разделение туннеля IPv4.

	split-tunneling-routing-address string		Объекты адресов брандмауэра режима туннелирования IPv4 SSL-VPN, которые переопределяют адреса назначения политики брандмауэра для управления адресами разделенного туннелирования...
	theme string	Варианты: серый синий оранжевый красный стальной синий темно-серый зелёный фиолетово-сиреневый красный маринер	Схема цветовой гаммы веб-портала.
	tunnel-mode string	Варианты: отключить включить	Включить/отключить режим туннелирования IPv4 SSL-VPN.
	user-bookmark string	Варианты: отключить включить	Включить, чтобы пользователи веб-портала могли создавать свои закладки.
	user-group-bookmark string	Варианты: отключить включить	Включить, чтобы пользователи веб-портала могли создавать закладки для всех пользователей в той же группе пользователей.
	web-mode string	Варианты: отключить включить	Включить/отключить веб-режим SSL VPN.
	windows-forticlient-download-url string		URL для загрузки Windows FortiClient.
	wins-server1 string		Сервер WINS IPv4 1.
	wins-server2 string		Сервер WINS IPv4 1.
workspace_locking_adom string			область, которую нужно заблокировать для FortiManager, работающего в режиме рабочего пространства; значение может быть глобальным и другими, включая корень
workspace_locking_timeout integer		По умолчанию: 300	максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство

Примечания

Примечание

В этом модуле FortiManager поддерживается работа в режиме блокировки рабочего пространства; параметры workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой, когда возвращается ненулевой код. Вы также можете переопределить условия для ошибки или успеха с помощью параметров rc_failed и rc_succeeded.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Portal.
     fmgr_vpnsslweb_portal:
        bypass_validation: False
        workspace_locking_adom: <value in [global, custom adom including root]>
        workspace_locking_timeout: 300
        rc_succeeded: [0, -2, -3, ...]
        rc_failed: [-2, -3, ...]
        adom: <your own value>
        state: <value in [present, absent]>
        vpnsslweb_portal:
           allow-user-access:
             - web
             - ftp
             - telnet
             - smb
             - vnc
             - rdp
             - ssh
             - ping
             - citrix
             - portforward
             - sftp
           auto-connect: <value in [disable, enable]>
           bookmark-group:
             -
                 bookmarks:
                   -
                       additional-params: <value of string>
                       apptype: <value in [web, telnet, ssh, ...]>
                       description: <value of string>
                       folder: <value of string>
                       form-data:
                         -
                             name: <value of string>
                             value: <value of string>
                       host: <value of string>
                       listening-port: <value of integer>
                       load-balancing-info: <value of string>
                       logon-password: <value of string>
                       logon-user: <value of string>
                       name: <value of string>
                       port: <value of integer>
                       preconnection-blob: <value of string>
                       preconnection-id: <value of integer>
                       remote-port: <value of integer>
                       security: <value in [rdp, nla, tls, ...]>
                       server-layout: <value in [en-us-qwerty, de-de-qwertz, fr-fr-azerty, ...]>
                       show-status-window: <value in [disable, enable]>
                       sso: <value in [disable, static, auto]>
                       sso-credential: <value in [sslvpn-login, alternative]>
                       sso-credential-sent-once: <value in [disable, enable]>
                       sso-password: <value of string>
                       sso-username: <value of string>
                       url: <value of string>
                 name: <value of string>
           custom-lang: <value of string>
           customize-forticlient-download-url: <value in [disable, enable]>
           display-bookmark: <value in [disable, enable]>
           display-connection-tools: <value in [disable, enable]>
           display-history: <value in [disable, enable]>
           display-status: <value in [disable, enable]>
           dns-server1: <value of string>
           dns-server2: <value of string>
           dns-suffix: <value of string>
           exclusive-routing: <value in [disable, enable]>
           forticlient-download: <value in [disable, enable]>
           forticlient-download-method: <value in [direct, ssl-vpn]>
           heading: <value of string>
           hide-sso-credential: <value in [disable, enable]>
           host-check: <value in [none, av, fw, ...]>
           host-check-interval: <value of integer>
           host-check-policy: <value of string>
           ip-mode: <value in [range, user-group]>
           ip-pools: <value of string>
           ipv6-dns-server1: <value of string>
           ipv6-dns-server2: <value of string>
           ipv6-exclusive-routing: <value in [disable, enable]>
           ipv6-pools: <value of string>
           ipv6-service-restriction: <value in [disable, enable]>
           ipv6-split-tunneling: <value in [disable, enable]>
           ipv6-split-tunneling-routing-address: <value of string>
           ipv6-tunnel-mode: <value in [disable, enable]>
           ipv6-wins-server1: <value of string>
           ipv6-wins-server2: <value of string>
           keep-alive: <value in [disable, enable]>
           limit-user-logins: <value in [disable, enable]>
           mac-addr-action: <value in [deny, allow]>
           mac-addr-check: <value in [disable, enable]>
           mac-addr-check-rule:
             -
                 mac-addr-list: <value of string>
                 mac-addr-mask: <value of integer>
                 name: <value of string>
           macos-forticlient-download-url: <value of string>
           name: <value of string>
           os-check: <value in [disable, enable]>
           redir-url: <value of string>
           save-password: <value in [disable, enable]>
           service-restriction: <value in [disable, enable]>
           skip-check-for-unsupported-browser: <value in [disable, enable]>
           skip-check-for-unsupported-os: <value in [disable, enable]>
           smb-ntlmv1-auth: <value in [disable, enable]>
           smbv1: <value in [disable, enable]>
           split-dns:
             -
                 dns-server1: <value of string>
                 dns-server2: <value of string>
                 domains: <value of string>
                 id: <value of integer>
                 ipv6-dns-server1: <value of string>
                 ipv6-dns-server2: <value of string>
           split-tunneling: <value in [disable, enable]>
           split-tunneling-routing-address: <value of string>
           theme: <value in [gray, blue, orange, ...]>
           tunnel-mode: <value in [disable, enable]>
           user-bookmark: <value in [disable, enable]>
           user-group-bookmark: <value in [disable, enable]>
           web-mode: <value in [disable, enable]>
           windows-forticlient-download-url: <value of string>
           wins-server1: <value of string>
           wins-server2: <value of string>

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

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

Ключ	Возвращаемое значение	Описание
request_url string	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code integer	всегда	Статус запроса API
response_message string	всегда	Дескриптивное сообщение ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_vpnsslweb_portal_module.html