Модуль fortinet.fortimanager.fmgr_ztna_webproxy — Настройка веб-прокси ZTNA.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_ztna_webproxy.
Новое в fortinet.fortimanager 2.12.0
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom string / обязательно | Параметр (adom) в запрашиваемом URL. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
enable_log boolean | Включить или отключить ведение журнала для задачи. Варианты:
|
forticloud_access_token string | Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud. |
proposed_method string | Переопределяемый метод для базового запроса Json RPC. Варианты:
|
rc_failed list / elements=integer | Список кодов rc, переопределяющий условия неудачного выполнения. |
rc_succeeded list / elements=integer | Список кодов rc, переопределяющий условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательно | Указание на создание, обновление или удаление объекта. Варианты:
|
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global и другие значения, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания снятия блокировки рабочей области другим пользователем. По умолчанию: |
ztna_webproxy dictionary | Набор параметров верхнего уровня. |
|
api_gateway псевдонимы: api-gateway list / elements=dictionary |
Шлюз API. |
|
h2_support псевдонимы: h2-support string |
Поддержка HTTP/2; по умолчанию включена. Варианты:
|
|
h3_support псевдонимы: h3-support string |
Поддержка HTTP/3/QUIC; по умолчанию отключена. Варианты:
|
|
http_cookie_age псевдонимы: http-cookie-age integer |
Время в минутах, в течение которого веб-браузеры клиентов должны хранить cookie. |
|
http_cookie_domain псевдонимы: http-cookie-domain string |
Домен, для которого применяется сохранение состояния с помощью HTTP cookie. |
|
http_cookie_domain_from_host псевдонимы: http-cookie-domain-from-host string |
Включить или отключить использование домена HTTP cookie из поля host в HTTP. Варианты:
|
|
http_cookie_generation псевдонимы: http-cookie-generation integer |
Поколение HTTP cookie, которое будет приниматься. |
|
http_cookie_path псевдонимы: http-cookie-path string |
Ограничить сохранение состояния HTTP cookie указанным путем. |
|
http_cookie_share псевдонимы: http-cookie-share string |
Управление совместным использованием cookie между шлюзами API. Варианты:
|
|
https_cookie_secure псевдонимы: https-cookie-secure string |
Включить или отключить проверку безопасности вставленных HTTPS cookie. Варианты:
|
|
id integer |
Идентификатор шлюза API. |
|
ldb_method псевдонимы: ldb-method string |
Метод распределения сеансов между реальными серверами. Варианты:
|
|
persistence string |
Настройка обеспечения подключения клиентов к одному и тому же серверу при каждом запросе, являющемся частью … Варианты:
|
|
quic dictionary |
Quic. |
|
ack_delay_exponent псевдонимы: ack-delay-exponent integer |
Показатель степени задержки ACK |
|
active_connection_id_limit псевдонимы: active-connection-id-limit integer |
Максимальное количество активных идентификаторов подключения |
|
active_migration псевдонимы: active-migration string |
Включить/отключить активную миграцию Варианты:
|
|
grease_quic_bit псевдонимы: grease-quic-bit string |
Включить/отключить бит grease QUIC Варианты:
|
|
max_ack_delay псевдонимы: max-ack-delay integer |
Максимальная задержка ACK в миллисекундах |
|
max_datagram_frame_size псевдонимы: max-datagram-frame-size integer |
Максимальный размер кадра дейтаграммы в байтах |
|
max_idle_timeout псевдонимы: max-idle-timeout integer |
Максимальный тайм-аут бездействия в миллисекундах |
|
max_udp_payload_size псевдонимы: max-udp-payload-size integer |
Максимальный размер полезной нагрузки UDP в байтах |
|
realservers list / elements=dictionary |
Реальные серверы. |
|
addr_type псевдонимы: addr-type string |
Тип адреса. Варианты:
|
|
address list / elements=string |
Адрес или группа адресов реального сервера. |
|
health_check псевдонимы: health-check string |
Включить проверку доступности реального сервера перед перенаправлением трафика. Варианты:
|
|
health_check_proto псевдонимы: health-check-proto string |
Протокол проверки состояния, используемый при опросе для определения состояния подключения серверов. Варианты:
|
|
holddown_interval псевдонимы: holddown-interval string |
Включить/отключить таймер задержки. Варианты:
|
|
http_host псевдонимы: http-host string |
Доменное имя HTTP-сервера в заголовке HTTP. |
|
id integer |
Идентификатор реального сервера. |
|
ip string |
IP-адрес реального сервера. |
|
port integer |
Порт для связи с реальным сервером. |
|
status string |
Установите для реального сервера активный статус, чтобы он мог принимать трафик, либо статус ожидания или отключения, чтобы никакой… Варианты:
|
|
translate_host псевдонимы: translate-host string |
Включить/отключить преобразование имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера. Варианты:
|
|
verify_cert псевдонимы: verify-cert string |
Включить/отключить проверку сертификата реального сервера. Варианты:
|
|
weight integer |
Вес реального сервера. |
|
service string |
Служба. Варианты:
|
|
ssl_algorithm aliases: ssl-algorithm string |
Допустимые алгоритмы шифрования для серверной стороны сеансов SSL в полном режиме в зависимости от стойкости шифрования. Варианты:
|
|
ssl_cipher_suites aliases: ssl-cipher-suites list / elements=dictionary |
Наборы шифров SSL. |
|
cipher string |
Название набора шифров. Варианты:
|
|
priority integer |
Приоритет наборов шифров SSL/TLS. |
|
versions list / elements=string |
Версии SSL/TLS, с которыми можно использовать набор шифров. Варианты:
|
|
ssl_dh_bits aliases: ssl-dh-bits string |
Количество битов для обмена Диффи — Хеллмана при шифровании сеансов SSL с помощью RSA. Варианты:
|
|
ssl_max_version aliases: ssl-max-version string |
Наивысшая допустимая версия SSL/TLS, используемая сервером. Варианты:
|
|
ssl_min_version aliases: ssl-min-version string |
Наименьшая допустимая версия SSL/TLS, используемая сервером. Варианты:
|
|
ssl_renegotiation aliases: ssl-renegotiation string |
Включить/отключить безопасное повторное согласование в соответствии с RFC 5746. Варианты:
|
|
url_map aliases: url-map string |
Шаблон URL для сопоставления. |
|
url_map_type aliases: url-map-type string |
Тип сопоставления URL. Варианты:
|
|
api_gateway6 aliases: api-gateway6 list / elements=dictionary |
Шлюз API 6. |
|
h2_support aliases: h2-support string |
Поддержка HTTP/2, по умолчанию включена. Варианты:
|
|
h3_support aliases: h3-support string |
Поддержка HTTP/3/QUIC, по умолчанию отключена. Варианты:
|
|
http_cookie_age aliases: http-cookie-age integer |
Время в минутах, в течение которого веб-браузеры клиентов должны хранить файл cookie. |
|
http_cookie_domain aliases: http-cookie-domain string |
Домен, для которого применяется постоянство HTTP-cookie. |
|
http_cookie_domain_from_host aliases: http-cookie-domain-from-host string |
Включить/отключить использование домена HTTP-cookie из поля host в HTTP. Варианты:
|
|
http_cookie_generation aliases: http-cookie-generation integer |
Поколение HTTP-cookie, которое будет принято. |
|
http_cookie_path aliases: http-cookie-path string |
Ограничить постоянство HTTP-cookie указанным путем. |
|
http_cookie_share aliases: http-cookie-share string |
Управление совместным использованием файлов cookie в шлюзе API. Варианты:
|
|
https_cookie_secure aliases: https-cookie-secure string |
Включить или отключить проверку безопасности вставленных файлов cookie HTTPS. Варианты:
|
|
id integer |
Идентификатор шлюза API. |
|
ldb_method aliases: ldb-method string |
Метод распределения сеансов между реальными серверами. Варианты:
|
|
persistence string |
Настройка способа, обеспечивающего подключение клиентов к одному и тому же серверу при каждом запросе, относящемся к … Варианты:
|
|
quic dictionary |
QUIC. |
|
ack_delay_exponent aliases: ack-delay-exponent integer |
Показатель степени задержки ACK |
|
active_connection_id_limit aliases: active-connection-id-limit integer |
Лимит идентификаторов активных подключений |
|
active_migration aliases: active-migration string |
Включить или отключить активную миграцию Варианты:
|
|
grease_quic_bit aliases: grease-quic-bit string |
Включить или отключить бит GREASE QUIC Варианты:
|
|
max_ack_delay aliases: max-ack-delay integer |
Максимальная задержка ACK в миллисекундах |
|
max_datagram_frame_size aliases: max-datagram-frame-size integer |
Максимальный размер кадра дейтаграммы в байтах |
|
max_idle_timeout aliases: max-idle-timeout integer |
Максимальное время ожидания бездействия в миллисекундах |
|
max_udp_payload_size aliases: max-udp-payload-size integer |
Максимальный размер полезной нагрузки UDP в байтах |
|
realservers list / elements=dictionary |
Реальные серверы. |
|
addr_type aliases: addr-type string |
Тип адреса. Варианты:
|
|
address list / elements=string |
Адрес или группа адресов реального сервера. |
|
health_check aliases: health-check string |
Включить проверку доступности реального сервера перед перенаправлением трафика. Варианты:
|
|
health_check_proto aliases: health-check-proto string |
Протокол проверки работоспособности, используемый при опросе для определения состояния подключения серверов. Варианты:
|
|
holddown_interval aliases: holddown-interval string |
Включить или отключить таймер удержания. Варианты:
|
|
http_host aliases: http-host string |
Доменное имя HTTP-сервера в заголовке HTTP. |
|
id integer |
Идентификатор реального сервера. |
|
ip string |
IPv6-адрес реального сервера. |
|
port integer |
Порт для связи с реальным сервером. |
|
status string |
Установите для реального сервера активный статус, чтобы он мог принимать трафик, либо переведите его в режим ожидания или отключите, чтобы он не… Варианты:
|
|
translate_host aliases: translate-host string |
Включить или отключить преобразование имени узла/IP-адреса виртуального сервера в имя узла/IP-адрес реального сервера. Варианты:
|
|
verify_cert aliases: verify-cert string |
Включить или отключить проверку сертификата реального сервера. Варианты:
|
|
weight integer |
Вес реального сервера. |
|
service string |
Служба. Варианты:
|
|
ssl_algorithm aliases: ssl-algorithm string |
Допустимые алгоритмы шифрования для серверной стороны сеансов SSL в режиме полного проксирования в зависимости от стойкости шифрования. Варианты:
|
|
ssl_cipher_suites aliases: ssl-cipher-suites list / elements=dictionary |
Наборы шифров SSL. |
|
cipher string |
Название набора шифров. Варианты:
|
|
priority integer |
Приоритет наборов шифров SSL/TLS. |
|
versions list / elements=string |
Версии SSL/TLS, с которыми можно использовать набор шифров. Варианты:
|
|
ssl_dh_bits aliases: ssl-dh-bits string |
Количество битов, используемых при обмене Диффи — Хеллмана для шифрования сеансов SSL с помощью RSA. Варианты:
|
|
ssl_max_version aliases: ssl-max-version string |
Максимальная допустимая версия SSL/TLS, предоставляемая сервером. Варианты:
|
|
ssl_min_version aliases: ssl-min-version string |
Минимальная допустимая версия SSL/TLS, предоставляемая сервером. Варианты:
|
|
ssl_renegotiation aliases: ssl-renegotiation string |
Включить или отключить безопасное повторное согласование в соответствии с RFC 5746. Варианты:
|
|
url_map aliases: url-map string |
Шаблон URL для сопоставления. |
|
url_map_type aliases: url-map-type string |
Тип сопоставления URL. Варианты:
|
|
auth_portal aliases: auth-portal string |
Включить или отключить портал аутентификации. Варианты:
|
|
auth_virtual_host aliases: auth-virtual-host list / elements=string |
Виртуальный узел портала аутентификации. |
|
decrypted_traffic_mirror aliases: decrypted-traffic-mirror list / elements=string |
Зеркалирование расшифрованного трафика. |
|
host list / elements=string |
Имя виртуального или реального узла. |
|
log_blocked_traffic aliases: log-blocked-traffic string |
Включить/отключить ведение журнала заблокированного трафика. Варианты:
|
|
name string / обязательный |
Имя прокси-сервера ZTNA. |
|
svr_pool_multiplex aliases: svr-pool-multiplex string |
Включить/отключить мультиплексирование пула серверов Варианты:
|
|
svr_pool_server_max_concurrent_request aliases: svr-pool-server-max-concurrent-request integer |
Максимальное количество параллельных запросов, которые могут обрабатывать серверы в пуле серверов |
|
svr_pool_server_max_request aliases: svr-pool-server-max-request integer |
Максимальное количество запросов, обрабатываемых серверами в пуле серверов до отключения |
|
svr_pool_ttl aliases: svr-pool-ttl integer |
Время жизни неактивных подключений к серверам в пуле серверов. |
|
vip list / elements=string |
Имя виртуального IP-адреса. |
|
vip6 list / elements=string |
Имя виртуального IPv6-адреса. |
Примечания
Примечание
- Начиная с версии 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-proxy.
fortinet.fortimanager.fmgr_ztna_webproxy:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
ztna_webproxy:
name: "your value" # Required variable, string
# api_gateway:
# - h2_support: <value in [disable, enable]>
# h3_support: <value in [disable, enable]>
# http_cookie_age: <integer>
# http_cookie_domain: <string>
# http_cookie_domain_from_host: <value in [disable, enable]>
# http_cookie_generation: <integer>
# http_cookie_path: <string>
# http_cookie_share: <value in [disable, same-ip]>
# https_cookie_secure: <value in [disable, enable]>
# id: <integer>
# ldb_method: <value in [static, round-robin, weighted, ...]>
# persistence: <value in [none, http-cookie]>
# quic:
# ack_delay_exponent: <integer>
# active_connection_id_limit: <integer>
# active_migration: <value in [disable, enable]>
# grease_quic_bit: <value in [disable, enable]>
# max_ack_delay: <integer>
# max_datagram_frame_size: <integer>
# max_idle_timeout: <integer>
# max_udp_payload_size: <integer>
# realservers:
# - addr_type: <value in [fqdn, ip]>
# address: <list or string>
# health_check: <value in [disable, enable]>
# health_check_proto: <value in [ping, http, tcp-connect]>
# holddown_interval: <value in [disable, enable]>
# http_host: <string>
# id: <integer>
# ip: <string>
# port: <integer>
# status: <value in [active, standby, disable]>
# translate_host: <value in [disable, enable]>
# verify_cert: <value in [disable, enable]>
# weight: <integer>
# service: <value in [http, https]>
# ssl_algorithm: <value in [high, medium, low]>
# ssl_cipher_suites:
# - cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
# priority: <integer>
# versions: ["tls-1.0", "tls-1.1", "tls-1.2", "tls-1.3"]
# ssl_dh_bits: <value in [768, 1024, 1536, ...]>
# ssl_max_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
# ssl_min_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
# ssl_renegotiation: <value in [disable, enable]>
# url_map: <string>
# url_map_type: <value in [sub-string, wildcard, regex]>
# api_gateway6:
# - h2_support: <value in [disable, enable]>
# h3_support: <value in [disable, enable]>
# http_cookie_age: <integer>
# http_cookie_domain: <string>
# http_cookie_domain_from_host: <value in [disable, enable]>
# http_cookie_generation: <integer>
# http_cookie_path: <string>
# http_cookie_share: <value in [disable, same-ip]>
# https_cookie_secure: <value in [disable, enable]>
# id: <integer>
# ldb_method: <value in [static, round-robin, weighted, ...]>
# persistence: <value in [none, http-cookie]>
# quic:
# ack_delay_exponent: <integer>
# active_connection_id_limit: <integer>
# active_migration: <value in [disable, enable]>
# grease_quic_bit: <value in [disable, enable]>
# max_ack_delay: <integer>
# max_datagram_frame_size: <integer>
# max_idle_timeout: <integer>
# max_udp_payload_size: <integer>
# realservers:
# - addr_type: <value in [fqdn, ip]>
# address: <list or string>
# health_check: <value in [disable, enable]>
# health_check_proto: <value in [ping, http, tcp-connect]>
# holddown_interval: <value in [disable, enable]>
# http_host: <string>
# id: <integer>
# ip: <string>
# port: <integer>
# status: <value in [active, standby, disable]>
# translate_host: <value in [disable, enable]>
# verify_cert: <value in [disable, enable]>
# weight: <integer>
# service: <value in [http, https]>
# ssl_algorithm: <value in [high, medium, low]>
# ssl_cipher_suites:
# - cipher: <value in [TLS-RSA-WITH-RC4-128-MD5, TLS-RSA-WITH-RC4-128-SHA, TLS-RSA-WITH-DES-CBC-SHA, ...]>
# priority: <integer>
# versions: ["tls-1.0", "tls-1.1", "tls-1.2", "tls-1.3"]
# ssl_dh_bits: <value in [768, 1024, 1536, ...]>
# ssl_max_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
# ssl_min_version: <value in [tls-1.0, tls-1.1, tls-1.2, ...]>
# ssl_renegotiation: <value in [disable, enable]>
# url_map: <string>
# url_map_type: <value in [sub-string, wildcard, regex]>
# auth_portal: <value in [disable, enable]>
# auth_virtual_host: <list or string>
# decrypted_traffic_mirror: <list or string>
# host: <list or string>
# log_blocked_traffic: <value in [disable, enable]>
# svr_pool_multiplex: <value in [disable, enable]>
# svr_pool_server_max_concurrent_request: <integer>
# svr_pool_server_max_request: <integer>
# svr_pool_ttl: <integer>
# vip: <list or string>
# vip6: <list or string>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
meta dictionary | Результат запроса. Возвращается: всегда |
|
request_url string |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code integer |
Статус запроса API. Возвращается: всегда Пример: |
|
response_data list / elements=string |
Ответ API. Возвращается: всегда |
|
response_message string |
Описание ответа API. Возвращается: всегда Пример: |
|
system_information dictionary |
Информация о целевой системе. Возвращается: всегда |
rc integer | Статус запроса. Возвращается: всегда Пример: |
version_check_warning list / elements=string | Предупреждение о том, что используемые в плейбуке параметры не поддерживаются текущей версией FortiManager. Возвращается: при определенных условиях |
Ссылки на коллекцию
© 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_webproxy_module.html