Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_ztna_web_portal — настройка веб-портала ZTNA в FortiOS и FortiGate от Fortinet.

Примечание

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

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

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_ztna_web_portal.

Добавлено в fortinet.fortios 2.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), устанавливая и изменяя параметры функции ztna и категории web_portal. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на FOS v6.0.0

Требования

На узле, выполняющем этот модуль, должны быть соблюдены следующие требования.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Создаётся в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Варианты:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, для которого выполняется операция.

Если атрибутов больше одного, они разделяются символом косой черты.

Параметр с атрибутом member_path предназначен для выполнения операций с элементами.

member_state

string

Добавить или удалить элемент по указанному пути к атрибуту.

Если задан параметр member_state, параметр state игнорируется.

Варианты:

  • "present"
  • "absent"

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Варианты:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа определённых ранее. VDOM — это виртуальный экземпляр FortiGate, который можно настроить и использовать как отдельное устройство.

По умолчанию: "root"

ztna_web_portal

dictionary

Настройка веб-портала ZTNA.

auth_portal

string

Включить или отключить портал аутентификации.

Варианты:

  • "disable"
  • "enable"

auth_rule

string

Правило аутентификации. Источник: authentication.rule.name.

auth_virtual_host

string

Виртуальный хост для портала аутентификации. Источник: firewall.access-proxy-virtual-host.name.

clipboard

string

Включить поддержку функции буфера обмена RDP/VPC.

Варианты:

  • "enable"
  • "disable"

cookie_age

integer

Время в минутах, в течение которого веб-браузеры клиентов должны хранить cookie. По умолчанию — 60 минут. 0 = без ограничения времени.

customize_forticlient_download_url

string

Включить поддержку настраиваемого URL-адреса загрузки FortiClient.

Варианты:

  • "enable"
  • "disable"

decrypted_traffic_mirror

string

Зеркалирование расшифрованного трафика. Источник: firewall.decrypted-traffic-mirror.name.

default_window_height

integer

Высота экрана (диапазон от 0 до 65535).

default_window_width

integer

Ширина экрана (диапазон от 0 до 65535).

display_bookmark

string

Включить отображение виджета закладок веб-портала.

Варианты:

  • "enable"
  • "disable"

display_history

string

Включить отображение виджета истории входов пользователей на веб-портал.

Варианты:

  • "enable"
  • "disable"

display_status

string

Включить отображение виджета состояния веб-портала.

Варианты:

  • "enable"
  • "disable"

focus_bookmark

string

Включить приоритетное размещение раздела закладок над разделом быстрого подключения на веб-портале ZTNA.

Варианты:

  • "enable"
  • "disable"

forticlient_download

string

Включить или отключить возможность загрузки FortiClient.

Варианты:

  • "enable"
  • "disable"

forticlient_download_method

string

Способ загрузки FortiClient.

Варианты:

  • "direct"
  • "ssl-vpn"

heading

string

Заголовок веб-портала.

host

string

Имя виртуального или реального хоста. Источник: firewall.access-proxy-virtual-host.name.

log_blocked_traffic

string

Включить или отключить ведение журнала заблокированного трафика.

Варианты:

  • "disable"
  • "enable"

macos_forticlient_download_url

string

URL-адрес загрузки FortiClient для Mac.

name

string / обязательный

Имя прокси ZTNA.

policy_auth_sso

string

Включить аутентификацию SSO на основе политик.

Варианты:

  • "enable"
  • "disable"

theme

string

Цветовая схема веб-портала.

Варианты:

  • "jade"
  • "neutrino"
  • "mariner"
  • "graphite"
  • "melongene"
  • "jet-stream"
  • "security-fabric"
  • "dark-matter"
  • "onyx"
  • "eclipse"

vip

string

Имя виртуального IP-адреса. Источник: firewall.vip.name.

vip6

string

Имя виртуального IPv6-адреса. Источник: firewall.vip6.name.

windows_forticlient_download_url

string

URL-адрес загрузки FortiClient для Windows.

Примечания

Примечание

  • Устаревший fortiosapi объявлен нерекомендуемым; для запуска плейбуков предпочтительно использовать httpapi.

Примеры

- name: Configure ztna web-portal.
  fortinet.fortios.fortios_ztna_web_portal:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      ztna_web_portal:
          auth_portal: "disable"
          auth_rule: "<your_own_value> (source authentication.rule.name)"
          auth_virtual_host: "myhostname (source firewall.access-proxy-virtual-host.name)"
          clipboard: "enable"
          cookie_age: "60"
          customize_forticlient_download_url: "enable"
          decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
          default_window_height: "768"
          default_window_width: "1024"
          display_bookmark: "enable"
          display_history: "enable"
          display_status: "enable"
          focus_bookmark: "enable"
          forticlient_download: "enable"
          forticlient_download_method: "direct"
          heading: "<your_own_value>"
          host: "myhostname (source firewall.access-proxy-virtual-host.name)"
          log_blocked_traffic: "disable"
          macos_forticlient_download_url: "<your_own_value>"
          name: "default_name_22"
          policy_auth_sso: "enable"
          theme: "jade"
          vip: "<your_own_value> (source firewall.vip.name)"
          vip6: "<your_own_value> (source firewall.vip6.name)"
          windows_forticlient_download_url: "<your_own_value>"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи содержимого в FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API