модуль fortinet.fortimanager.fmgr_ztna_webportal — настройка веб-портала ZTNA.

Примечание

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

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

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

Чтобы использовать коллекцию в плейбуке, укажите: fortinet.fortimanager.fmgr_ztna_webportal.

Добавлено в fortinet.fortimanager 2.12.0

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

Обзор

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

Параметры

Параметр	Комментарии
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token string	Аутентификация клиента Ansible с помощью токена доступа к API forticloud.
proposed_method string	Переопределённый метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается неудачным.
rc_succeeded list / элементы=integer	Список кодов rc, переопределяющий условия, при которых выполнение считается успешным.
revision_note string	Примечание об изменении, которое можно указать при создании или обновлении объекта.
state string / обязательный	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
workspace_locking_adom string	ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`
ztna_webportal dictionary	Набор параметров верхнего уровня.
auth_portal псевдонимы: auth-portal string	Включить/отключить портал аутентификации. Варианты: `"disable"` `"enable"`
auth_rule псевдонимы: auth-rule list / элементы=string	Правило аутентификации.
auth_virtual_host псевдонимы: auth-virtual-host list / элементы=string	Виртуальный хост для портала аутентификации.
bookmarks list / элементы=string	Закладки.
clipboard string	Включить поддержку буфера обмена RDP/VPC. Варианты: `"disable"` `"enable"`
cookie_age псевдонимы: cookie-age integer	Время в минутах, в течение которого браузеры клиентов должны хранить cookie.
customize_forticlient_download_url псевдонимы: customize-forticlient-download-url string	Включить поддержку настраиваемого URL-адреса загрузки FortiClient. Варианты: `"disable"` `"enable"`
decrypted_traffic_mirror псевдонимы: decrypted-traffic-mirror list / элементы=string	Зеркалирование расшифрованного трафика.
default_window_height псевдонимы: default-window-height integer	Высота экрана
default_window_width псевдонимы: default-window-width integer	Ширина экрана
display_bookmark псевдонимы: display-bookmark string	Включить отображение виджета закладок веб-портала. Варианты: `"disable"` `"enable"`
display_history псевдонимы: display-history string	Включить отображение виджета истории входов пользователей на веб-портал. Варианты: `"disable"` `"enable"`
display_status псевдонимы: display-status string	Включить отображение виджета состояния веб-портала. Варианты: `"disable"` `"enable"`
focus_bookmark псевдонимы: focus-bookmark string	Включить приоритетное размещение раздела закладок над разделом быстрого подключения на веб-портале ZTNA. Варианты: `"disable"` `"enable"`
forticlient_download псевдонимы: forticlient-download string	Включить/отключить возможность загрузки FortiClient. Варианты: `"disable"` `"enable"`
forticlient_download_method псевдонимы: forticlient-download-method string	Способ загрузки FortiClient. Варианты: `"direct"` `"ssl-vpn"`
heading string	Заголовок веб-портала.
host list / элементы=string	Имя виртуального или реального хоста.
llm_profile псевдонимы: llm-profile list / элементы=string	Профиль LLM.
llm_proxy псевдонимы: llm-proxy string	Прокси LLM. Варианты: `"disable"` `"enable"`
log_blocked_traffic псевдонимы: log-blocked-traffic string	Включить/отключить ведение журнала заблокированного трафика. Варианты: `"disable"` `"enable"`
macos_forticlient_download_url псевдонимы: macos-forticlient-download-url string	URL-адрес загрузки FortiClient для Mac.
name string / обязательный	Имя прокси ZTNA.
policy_auth_sso псевдонимы: policy-auth-sso string	Включить аутентификацию SSO на основе политики. Варианты: `"disable"` `"enable"`
theme string	Цветовая схема веб-портала. Варианты: `"melongene"` `"mariner"` `"neutrino"` `"jade"` `"graphite"` `"dark-matter"` `"onyx"` `"eclipse"` `"jet-stream"` `"security-fabric"`
vip list / элементы=string	Имя виртуального IP-адреса.
vip6 list / элементы=string	Имя виртуального IPv6-адреса.
windows_forticlient_download_url псевдонимы: windows-forticlient-download-url string	URL-адрес загрузки FortiClient для Windows.

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы именуются в соответствии с соглашением об использовании подчёркивания (snake_case). Замените аргументы, например «var-name», на «var_name». Старые имена аргументов по-прежнему доступны, но при их использовании будут выдаваться предупреждения об устаревании. Чтобы игнорировать это предупреждение, установите deprecation_warnings=False в ansible.cfg.
Этот модуль FortiManager поддерживает работу в режиме блокировки рабочей области. Для этого используются параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout.
Обычно выполнение одного модуля может завершиться ошибкой при возврате ненулевого значения rc. Условия, при которых выполнение считается неудачным или успешным, можно переопределить с помощью параметров rc_failed и rc_succeeded.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Configure ztna web-portal.
      fortinet.fortimanager.fmgr_ztna_webportal:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        state: present # <value in [present, absent]>
        ztna_webportal:
          name: "your value" # Required variable, string
          # auth_portal: <value in [disable, enable]>
          # auth_rule: <list or string>
          # auth_virtual_host: <list or string>
          # bookmarks: <list or string>
          # clipboard: <value in [disable, enable]>
          # cookie_age: <integer>
          # customize_forticlient_download_url: <value in [disable, enable]>
          # decrypted_traffic_mirror: <list or string>
          # default_window_height: <integer>
          # default_window_width: <integer>
          # display_bookmark: <value in [disable, enable]>
          # display_history: <value in [disable, enable]>
          # display_status: <value in [disable, enable]>
          # focus_bookmark: <value in [disable, enable]>
          # forticlient_download: <value in [disable, enable]>
          # forticlient_download_method: <value in [direct, ssl-vpn]>
          # heading: <string>
          # host: <list or string>
          # log_blocked_traffic: <value in [disable, enable]>
          # macos_forticlient_download_url: <string>
          # policy_auth_sso: <value in [disable, enable]>
          # theme: <value in [melongene, mariner, neutrino, ...]>
          # vip: <list or string>
          # windows_forticlient_download_url: <string>
          # vip6: <list or string>
          # llm_profile: <list or string>
          # llm_proxy: <value in [disable, enable]>

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

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

Ключ	Описание
meta dictionary	Результат запроса. Возвращается: всегда
request_url string	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code integer	Статус запроса API. Возвращается: всегда Пример: `0`
response_data list / elements=string	Ответ API. Возвращается: всегда
response_message string	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information dictionary	Информация о целевой системе. Возвращается: всегда
rc integer	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning list / elements=string	Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при сложном сценарии

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на коллекцию

© 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/fortimanager/fmgr_ztna_webportal_module.html