Модуль fortinet.fortios.fortios_ztna_web_proxy — настройка веб-прокси ZTNA в Fortinet FortiOS и FortiGate.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля могут потребоваться дополнительные компоненты; подробности см. в разделе Требования.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_ztna_web_proxy.
Добавлено в fortinet.fortios 2.0.0
Обзор
- Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), задавая и изменяя параметры функций ztna и категории web_proxy. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Протестировано с 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, который можно настроить и использовать как отдельное устройство. По умолчанию: |
ztna_web_proxy dictionary | Настройка веб-прокси ZTNA. |
|
api_gateway list / elements=dictionary |
Настройка шлюза API IPv4. |
|
h2_support string |
Поддержка HTTP/2, по умолчанию включена. Варианты:
|
|
h3_support string |
Поддержка HTTP/3/QUIC, по умолчанию отключена. Варианты:
|
|
http_cookie_age integer |
Время в минутах, в течение которого веб-браузеры клиентов должны хранить файл cookie. Значение по умолчанию — 60 минут. 0 = без ограничения по времени. |
|
http_cookie_domain string |
Домен, для которого должна применяться привязка HTTP-сеанса с помощью файлов cookie. |
|
http_cookie_domain_from_host string |
Включить/отключить использование домена HTTP-cookie из поля host в HTTP. Варианты:
|
|
http_cookie_generation integer |
Поколение HTTP-cookie, которое будет приниматься. При изменении все существующие файлы cookie становятся недействительными. |
|
http_cookie_path string |
Ограничить привязку HTTP-сеанса с помощью файлов cookie указанным путем. |
|
string |
Управление совместным использованием файлов cookie между шлюзами API. При использовании значения same-ip файл cookie одного виртуального сервера можно использовать на другом. Значение Disable запрещает совместное использование файлов cookie. Варианты:
|
|
https_cookie_secure string |
Включить/отключить проверку защищенности добавленных HTTPS-cookie. Варианты:
|
|
id integer / обязательный |
Идентификатор шлюза API. См. <a href=’#notes’>Примечания</a>. |
|
ldb_method string |
Метод распределения сеансов между реальными серверами. Варианты:
|
|
persistence string |
Настройка способа, обеспечивающего подключение клиентов к одному и тому же серверу при каждом запросе в рамках одного сеанса. Варианты:
|
|
quic dictionary |
Настройка QUIC. |
|
ack_delay_exponent integer |
Показатель степени задержки ACK (1–20). |
|
active_connection_id_limit integer |
Ограничение числа активных идентификаторов соединения (1–8). |
|
active_migration string |
Включить/отключить активную миграцию. Варианты:
|
|
grease_quic_bit string |
Включить/отключить бит GREASE QUIC. Варианты:
|
|
max_ack_delay integer |
Максимальная задержка ACK в миллисекундах (1–16383). |
|
max_datagram_frame_size integer |
Максимальный размер кадра дейтаграммы в байтах (1–1500). |
|
max_idle_timeout integer |
Максимальное время ожидания бездействия в миллисекундах (1–60000). |
|
max_udp_payload_size integer |
Максимальный размер полезной нагрузки UDP в байтах (1200–1500). |
|
realservers list / elements=dictionary |
Выберите реальные серверы, на которые этот прокси доступа будет распределять трафик. |
|
addr_type string |
Тип адреса. Варианты:
|
|
address string |
Адрес или группа адресов реального сервера. Источник: firewall.address.name, firewall.addrgrp.name. |
|
health_check string |
Включите проверку доступности реального сервера перед перенаправлением трафика. Варианты:
|
|
health_check_proto string |
Протокол монитора проверки работоспособности, используемый при опросе для определения состояния подключения сервера. Варианты:
|
|
holddown_interval string |
Включить или отключить таймер ожидания. Сервер будет считаться активным и доступным по истечении периода ожидания (30 секунд). Варианты:
|
|
http_host string |
Доменное имя HTTP-сервера в заголовке HTTP. |
|
id integer / required |
Идентификатор реального сервера. См. <a href=’#notes’>примечания</a>. |
|
ip string |
IP-адрес реального сервера. |
|
port integer |
Порт для связи с реальным сервером. |
|
status string |
Установите для реального сервера состояние «активен», чтобы он мог принимать трафик, или «ожидание» либо «отключен», чтобы трафик на него не отправлялся. Варианты:
|
|
translate_host string |
Включить или отключить преобразование имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера. Варианты:
|
|
verify_cert string |
Включить или отключить проверку сертификата реального сервера. Варианты:
|
|
weight integer |
Вес реального сервера. Если включена балансировка нагрузки с учетом весов, сервер с наибольшим весом получает больше подключений. |
|
service string |
Служба. Варианты:
|
|
ssl_algorithm string |
Допустимые алгоритмы шифрования для серверной стороны сеансов SSL в режиме полного шифрования, упорядоченные по уровню стойкости шифрования. Варианты:
|
|
ssl_cipher_suites list / elements=dictionary |
Наборы шифров SSL/TLS, предлагаемые серверу, в порядке приоритета. |
|
cipher string |
Название набора шифров. Варианты:
|
|
priority integer / required |
Приоритет набора шифров SSL/TLS. См. <a href=’#notes’>примечания</a>. |
|
versions list / elements=string |
Версии SSL/TLS, с которыми можно использовать набор шифров. Варианты:
|
|
ssl_dh_bits string |
Количество битов для обмена Диффи — Хеллмана при шифровании сеансов SSL с помощью RSA. Варианты:
|
|
ssl_max_version string |
Наивысшая допустимая версия SSL/TLS от сервера. Варианты:
|
|
ssl_min_version string |
Наименьшая допустимая версия SSL/TLS от сервера. Варианты:
|
|
ssl_renegotiation string |
Включить/отключить безопасное повторное согласование в соответствии с RFC 5746. Варианты:
|
|
url_map string |
Шаблон URL для сопоставления. |
|
url_map_type string |
Тип сопоставления URL. Варианты:
|
|
api_gateway6 list / elements=dictionary |
Настройка шлюза API для IPv6. |
|
h2_support string |
Поддержка HTTP/2; по умолчанию включена. Варианты:
|
|
h3_support string |
Поддержка HTTP/3/QUIC; по умолчанию отключена. Варианты:
|
|
http_cookie_age integer |
Время в минутах, в течение которого браузеры клиентов должны хранить cookie. Значение по умолчанию — 60 минут. 0 = без ограничения по времени. |
|
http_cookie_domain string |
Домен, для которого применяется сохранение состояния с помощью HTTP-cookie. |
|
http_cookie_domain_from_host string |
Включить/отключить использование домена HTTP-cookie из поля host в HTTP. Варианты:
|
|
http_cookie_generation integer |
Поколение принимаемых HTTP-cookie. Изменение этого значения аннулирует все существующие cookie. |
|
http_cookie_path string |
Ограничить сохранение состояния с помощью HTTP-cookie указанным путем. |
|
string |
Управление совместным использованием cookie между шлюзами API. При использовании same-ip cookie одного виртуального сервера можно использовать на другом. Отключение запрещает совместное использование cookie. Варианты:
|
|
https_cookie_secure string |
Включить/отключить проверку безопасности добавляемых HTTPS-cookie. Варианты:
|
|
id integer / обязательный |
Идентификатор шлюза API. См. <a href=’#notes’>Примечания</a>. |
|
ldb_method string |
Метод распределения сеансов между реальными серверами. Варианты:
|
|
persistence string |
Настройка способа, обеспечивающего подключение клиентов к одному и тому же серверу при каждом запросе, относящемся к тому же сеансу. Варианты:
|
|
quic dictionary |
Настройки QUIC. |
|
ack_delay_exponent integer |
Экспонента задержки ACK (1–20). |
|
active_connection_id_limit integer |
Ограничение на количество активных идентификаторов подключений (1–8). |
|
active_migration string |
Включить/отключить активную миграцию. Варианты:
|
|
grease_quic_bit string |
Включить/отключить бит GREASE QUIC. Варианты:
|
|
max_ack_delay integer |
Максимальная задержка ACK в миллисекундах (1–16383). |
|
max_datagram_frame_size integer |
Максимальный размер кадра дейтаграммы в байтах (1–1500). |
|
max_idle_timeout integer |
Максимальное время ожидания бездействия в миллисекундах (1–60000). |
|
max_udp_payload_size integer |
Максимальный размер полезной нагрузки UDP в байтах (1200–1500). |
|
realservers list / elements=dictionary |
Выберите реальные серверы, на которые этот прокси доступа будет распределять трафик. |
|
addr_type string |
Тип адреса. Варианты:
|
|
address string |
Адрес или группа адресов реального сервера. Источник: firewall.address6.name, firewall.addrgrp6.name. |
|
health_check string |
Включите проверку отклика реального сервера перед пересылкой трафика. Варианты:
|
|
health_check_proto string |
Протокол монитора проверки работоспособности, используемый для опроса и определения состояния подключения сервера. Варианты:
|
|
holddown_interval string |
Включить или отключить таймер задержки. Сервер будет считаться активным и доступным по истечении периода задержки (30 секунд). Варианты:
|
|
http_host string |
Доменное имя HTTP-сервера в заголовке HTTP. |
|
id integer / required |
Идентификатор реального сервера. См. <a href=’#notes’>Примечания</a>. |
|
ip string |
Адрес IPv6 реального сервера. |
|
port integer |
Порт для связи с реальным сервером. |
|
status string |
Установите для реального сервера состояние «активен», чтобы он мог принимать трафик, либо состояние ожидания или «отключен», чтобы на него не отправлялся трафик. Варианты:
|
|
translate_host string |
Включить или отключить преобразование имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера. Варианты:
|
|
verify_cert string |
Включить или отключить проверку сертификата реального сервера. Варианты:
|
|
weight integer |
Вес реального сервера. Если включена балансировка нагрузки с учетом весов, сервер с наибольшим весом получает больше подключений. |
|
service string |
Служба. Варианты:
|
|
ssl_algorithm string |
Допустимые алгоритмы шифрования для серверной стороны сеансов SSL в полном режиме, упорядоченные по уровню стойкости шифрования. Варианты:
|
|
ssl_cipher_suites list / elements=dictionary |
Наборы шифров SSL/TLS, предлагаемые серверу в порядке приоритета. |
|
cipher string |
Название набора шифров. Варианты:
|
|
priority integer / required |
Приоритет набора шифров SSL/TLS. См. <a href=’#notes’>Примечания</a>. |
|
versions list / elements=string |
Версии SSL/TLS, с которыми можно использовать этот набор шифров. Варианты:
|
|
ssl_dh_bits string |
Количество бит для использования в обмене Диффи — Хеллмана при шифровании сеансов SSL с помощью RSA. Варианты:
|
|
ssl_max_version string |
Наивысшая версия SSL/TLS, допустимая для сервера. Варианты:
|
|
ssl_min_version string |
Наименьшая версия SSL/TLS, допустимая для сервера. Варианты:
|
|
ssl_renegotiation string |
Включить или отключить безопасное повторное согласование в соответствии с RFC 5746. Варианты:
|
|
url_map string |
Шаблон URL для сопоставления. |
|
url_map_type string |
Тип сопоставления URL. Варианты:
|
|
auth_portal string |
Включить или отключить портал аутентификации. Варианты:
|
|
auth_virtual_host string |
Виртуальный хост для портала аутентификации. Источник: firewall.access-proxy-virtual-host.name. |
|
decrypted_traffic_mirror string |
Зеркало расшифрованного трафика. Источник: firewall.decrypted-traffic-mirror.name. |
|
host string |
Имя виртуального или реального хоста. Источник: firewall.access-proxy-virtual-host.name. |
|
log_blocked_traffic string |
Включить или отключить ведение журнала заблокированного трафика. Варианты:
|
|
name string / обязательный |
Имя прокси-сервера ZTNA. |
|
svr_pool_multiplex string |
Включить или отключить мультиплексирование пула серверов. Использовать подключенный сервер совместно в шлюзах API HTTP и HTTPS. Варианты:
|
|
svr_pool_server_max_concurrent_request integer |
Максимальное количество одновременных запросов, которые могут обрабатывать серверы в пуле серверов. |
|
svr_pool_server_max_request integer |
Максимальное количество запросов, которые серверы в пуле серверов обрабатывают до отключения. |
|
svr_pool_ttl integer |
Время жизни неактивных соединений с серверами в пуле серверов. |
|
vip string |
Имя виртуального IP-адреса. Источник: firewall.vip.name. |
|
vip6 string |
Имя виртуального IPv6-адреса. Источник: firewall.vip6.name. |
Примечания
Примечание
- Устаревший fortiosapi больше не рекомендуется; предпочтительный способ запуска плейбуков — httpapi
Примеры
- name: Configure ZTNA web-proxy.
fortinet.fortios.fortios_ztna_web_proxy:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
ztna_web_proxy:
api_gateway:
-
h2_support: "enable"
h3_support: "enable"
http_cookie_age: "60"
http_cookie_domain: "<your_own_value>"
http_cookie_domain_from_host: "disable"
http_cookie_generation: "0"
http_cookie_path: "<your_own_value>"
http_cookie_share: "disable"
https_cookie_secure: "disable"
id: "13"
ldb_method: "static"
persistence: "none"
quic:
ack_delay_exponent: "3"
active_connection_id_limit: "2"
active_migration: "enable"
grease_quic_bit: "enable"
max_ack_delay: "25"
max_datagram_frame_size: "1500"
max_idle_timeout: "30000"
max_udp_payload_size: "1500"
realservers:
-
addr_type: "ip"
address: "<your_own_value> (source firewall.address.name firewall.addrgrp.name)"
health_check: "disable"
health_check_proto: "ping"
holddown_interval: "enable"
http_host: "myhostname"
id: "32"
ip: "<your_own_value>"
port: "443"
status: "active"
translate_host: "enable"
verify_cert: "enable"
weight: "1"
service: "http"
ssl_algorithm: "high"
ssl_cipher_suites:
-
cipher: "TLS-AES-128-GCM-SHA256"
priority: "<you_own_value>"
versions: "tls-1.0"
ssl_dh_bits: "768"
ssl_max_version: "tls-1.0"
ssl_min_version: "tls-1.0"
ssl_renegotiation: "enable"
url_map: "<your_own_value>"
url_map_type: "sub-string"
api_gateway6:
-
h2_support: "enable"
h3_support: "enable"
http_cookie_age: "60"
http_cookie_domain: "<your_own_value>"
http_cookie_domain_from_host: "disable"
http_cookie_generation: "0"
http_cookie_path: "<your_own_value>"
http_cookie_share: "disable"
https_cookie_secure: "disable"
id: "61"
ldb_method: "static"
persistence: "none"
quic:
ack_delay_exponent: "3"
active_connection_id_limit: "2"
active_migration: "enable"
grease_quic_bit: "enable"
max_ack_delay: "25"
max_datagram_frame_size: "1500"
max_idle_timeout: "30000"
max_udp_payload_size: "1500"
realservers:
-
addr_type: "ip"
address: "<your_own_value> (source firewall.address6.name firewall.addrgrp6.name)"
health_check: "disable"
health_check_proto: "ping"
holddown_interval: "enable"
http_host: "myhostname"
id: "80"
ip: "<your_own_value>"
port: "443"
status: "active"
translate_host: "enable"
verify_cert: "enable"
weight: "1"
service: "http"
ssl_algorithm: "high"
ssl_cipher_suites:
-
cipher: "TLS-AES-128-GCM-SHA256"
priority: "<you_own_value>"
versions: "tls-1.0"
ssl_dh_bits: "768"
ssl_max_version: "tls-1.0"
ssl_min_version: "tls-1.0"
ssl_renegotiation: "enable"
url_map: "<your_own_value>"
url_map_type: "sub-string"
auth_portal: "disable"
auth_virtual_host: "myhostname (source firewall.access-proxy-virtual-host.name)"
decrypted_traffic_mirror: "<your_own_value> (source firewall.decrypted-traffic-mirror.name)"
host: "myhostname (source firewall.access-proxy-virtual-host.name)"
log_blocked_traffic: "disable"
name: "default_name_104"
svr_pool_multiplex: "enable"
svr_pool_server_max_concurrent_request: "0"
svr_pool_server_max_request: "0"
svr_pool_ttl: "15"
vip: "<your_own_value> (source firewall.vip.name)"
vip6: "<your_own_value> (source firewall.vip6.name)"
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
build string | Номер сборки образа FortiGate Возвращается: всегда Пример: |
http_method string | Последний метод, использованный для передачи содержимого в FortiGate Возвращается: всегда Пример: |
http_status string | Последний результат, полученный от FortiGate при выполнении последней операции Возвращается: всегда Пример: |
mkey string | Мастер-ключ (идентификатор), использованный при последнем обращении к FortiGate Возвращается: при успехе Пример: |
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_ztna_web_proxy_module.html