Модуль fortinet.fortimanager.fmgr_ztna_trafficforwardproxy — настройка прокси-сервера пересылки трафика ZTNA.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать модуль в плейбуке, укажите: fortinet.fortimanager.fmgr_ztna_trafficforwardproxy.
Добавлено в 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 / элементы типа integer | Список кодов rc, которыми будут переопределены условия сбоя. |
rc_succeeded list / элементы типа integer | Список кодов rc, которыми будут переопределены условия успешного выполнения. |
revision_note string | Примечание об изменении, которое можно указать при создании или обновлении объекта. |
state string / обязательный | Указание на создание, обновление или удаление объекта. Возможные значения:
|
workspace_locking_adom string | ADOM, который необходимо заблокировать для FortiManager, работающего в режиме рабочей области. Значением может быть global или другой ADOM, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания освобождения блокировки рабочей области другим пользователем в секундах. По умолчанию: |
ztna_trafficforwardproxy dictionary | Набор параметров верхнего уровня. |
|
auth_portal псевдонимы: auth-portal string |
Включить/отключить портал аутентификации. Возможные значения:
|
|
auth_virtual_host псевдонимы: auth-virtual-host list / элементы типа string |
Виртуальный хост для портала аутентификации. |
|
client_cert псевдонимы: client-cert string |
Сертификат клиента. Возможные значения:
|
|
comment string |
Комментарий. |
|
decrypted_traffic_mirror псевдонимы: decrypted-traffic-mirror list / элементы типа string |
Зеркалирование расшифрованного трафика. |
|
empty_cert_action псевдонимы: empty-cert-action string |
Действие при отсутствии сертификата. Возможные значения:
|
|
h3_support псевдонимы: h3-support string |
Поддержка H3. Возможные значения:
|
|
host list / элементы типа string |
Имя виртуального или реального хоста. |
|
interface list / элементы типа string |
Интерфейс. |
|
log_blocked_traffic псевдонимы: log-blocked-traffic string |
Включить/отключить ведение журнала заблокированного трафика. Возможные значения:
|
|
name string / обязательный |
Имя прокси-сервера ZTNA. |
|
port string |
Порт. |
|
quic dictionary |
QUIC. |
|
ack_delay_exponent псевдонимы: 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 |
Максимальная задержка подтверждения. |
|
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. |
|
ssl_accept_ffdhe_groups aliases: ssl-accept-ffdhe-groups string |
Группы FFDHE, принимаемые SSL. Варианты:
|
|
ssl_algorithm aliases: ssl-algorithm string |
Алгоритм SSL. Варианты:
|
|
ssl_certificate aliases: ssl-certificate list / elements=string |
Сертификат SSL. |
|
ssl_cipher_suites aliases: ssl-cipher-suites list / elements=dictionary |
Наборы шифров SSL. |
|
cipher string |
Шифр. Варианты:
|
|
priority integer |
Приоритет. |
|
versions list / elements=string |
Версии. Варианты:
|
|
ssl_client_fallback aliases: ssl-client-fallback string |
Резервный вариант клиента SSL. Варианты:
|
|
ssl_client_rekey_count aliases: ssl-client-rekey-count integer |
Количество повторных согласований ключей клиента SSL. |
|
ssl_client_renegotiation aliases: ssl-client-renegotiation string |
Повторное согласование SSL клиента. Варианты:
|
|
ssl_client_session_state_max aliases: ssl-client-session-state-max integer |
Максимальное количество состояний сеансов SSL клиента. |
|
ssl_client_session_state_timeout aliases: ssl-client-session-state-timeout integer |
Время ожидания состояния сеанса SSL клиента. |
|
ssl_client_session_state_type aliases: ssl-client-session-state-type string |
Тип состояния сеанса SSL клиента. Варианты:
|
|
ssl_dh_bits aliases: ssl-dh-bits string |
Битовая длина параметров DH для SSL. Варианты:
|
|
ssl_hpkp aliases: ssl-hpkp string |
HPKP для SSL. Варианты:
|
|
ssl_hpkp_age aliases: ssl-hpkp-age integer |
Срок действия HPKP для SSL. |
|
ssl_hpkp_backup aliases: ssl-hpkp-backup list / elements=string |
Резервные ключи HPKP для SSL. |
|
ssl_hpkp_include_subdomains aliases: ssl-hpkp-include-subdomains string |
Включать поддомены в HPKP для SSL. Варианты:
|
|
ssl_hpkp_primary aliases: ssl-hpkp-primary list / elements=string |
Основные ключи HPKP для SSL. |
|
ssl_hpkp_report_uri aliases: ssl-hpkp-report-uri string |
URI для отправки отчетов HPKP через SSL. |
|
ssl_hsts aliases: ssl-hsts string |
HSTS для SSL. Варианты:
|
|
ssl_hsts_age aliases: ssl-hsts-age integer |
Срок действия HSTS для SSL. |
|
ssl_hsts_include_subdomains aliases: ssl-hsts-include-subdomains string |
Включать поддомены в HSTS для SSL. Варианты:
|
|
ssl_http_location_conversion aliases: ssl-http-location-conversion string |
Преобразование HTTP Location для SSL. Варианты:
|
|
ssl_http_match_host aliases: ssl-http-match-host string |
Сопоставление имени узла HTTP для SSL. Варианты:
|
|
ssl_max_version aliases: ssl-max-version string |
Максимальная версия SSL. Варианты:
|
|
ssl_min_version aliases: ssl-min-version string |
Минимальная версия SSL. Варианты:
|
|
ssl_mode aliases: ssl-mode string |
Режим SSL. Варианты:
|
|
ssl_pfs aliases: ssl-pfs string |
Прямая секретность SSL (PFS). Варианты:
|
|
ssl_send_empty_frags aliases: ssl-send-empty-frags string |
Отправлять пустые фрагменты SSL. Варианты:
|
|
ssl_server_algorithm aliases: ssl-server-algorithm string |
Алгоритм сервера SSL. Варианты:
|
|
ssl_server_cipher_suites aliases: ssl-server-cipher-suites list / elements=dictionary |
Наборы шифров сервера SSL. |
|
cipher string |
Шифр. Варианты:
|
|
priority integer |
Приоритет. |
|
versions list / elements=string |
Версии. Варианты:
|
|
ssl_server_max_version aliases: ssl-server-max-version string |
Максимальная версия SSL-сервера. Варианты:
|
|
ssl_server_min_version aliases: ssl-server-min-version string |
Минимальная версия SSL-сервера. Варианты:
|
|
ssl_server_renegotiation aliases: ssl-server-renegotiation string |
Повторное согласование SSL-сервера. Варианты:
|
|
ssl_server_session_state_max aliases: ssl-server-session-state-max integer |
Максимальное количество состояний сеансов SSL-сервера. |
|
ssl_server_session_state_timeout aliases: ssl-server-session-state-timeout integer |
Время ожидания состояния сеанса SSL-сервера. |
|
ssl_server_session_state_type aliases: ssl-server-session-state-type string |
Тип состояния сеанса SSL-сервера. Варианты:
|
|
status string |
Статус. Варианты:
|
|
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 |
Время жизни пула серверов. |
|
url_route aliases: url-route list / elements=dictionary |
Маршрут URL. |
|
name string |
Имя. |
|
service_connector aliases: service-connector list / elements=string |
Коннектор службы. |
|
url_pattern aliases: url-pattern string |
Шаблон URL. |
|
user_agent_detect aliases: user-agent-detect string |
Обнаружение User-Agent. Варианты:
|
|
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 traffic forward proxy.
fortinet.fortimanager.fmgr_ztna_trafficforwardproxy:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
state: present # <value in [present, absent]>
ztna_trafficforwardproxy:
name: "your value" # Required variable, string
# 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]>
# url_route:
# - name: <string>
# service_connector: <list or string>
# url_pattern: <string>
# vip: <list or string>
# ssl_client_session_state_max: <integer>
# ssl_send_empty_frags: <value in [disable, enable]>
# ssl_server_max_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
# ssl_accept_ffdhe_groups: <value in [disable, enable]>
# empty_cert_action: <value in [accept, block, accept-unmanageable]>
# 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>
# ssl_server_session_state_max: <integer>
# ssl_client_session_state_type: <value in [disable, time, count, ...]>
# ssl_hpkp_age: <integer>
# ssl_hpkp_report_uri: <string>
# ssl_min_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
# ssl_mode: <value in [half, full]>
# ssl_client_session_state_timeout: <integer>
# ssl_hsts_age: <integer>
# interface: <list or string>
# ssl_client_renegotiation: <value in [allow, deny, secure]>
# ssl_server_session_state_timeout: <integer>
# ssl_server_min_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
# 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: ["ssl-3.0", "tls-1.0", "tls-1.1", "tls-1.2", "tls-1.3"]
# ssl_client_rekey_count: <integer>
# svr_pool_server_max_request: <integer>
# ssl_dh_bits: <value in [768, 1024, 1536, ...]>
# port: <string>
# ssl_http_match_host: <value in [disable, enable]>
# ssl_server_session_state_type: <value in [disable, time, count, ...]>
# status: <value in [disable, enable]>
# svr_pool_multiplex: <value in [disable, enable]>
# ssl_hpkp: <value in [disable, enable, report-only]>
# ssl_hsts: <value in [disable, enable]>
# svr_pool_server_max_concurrent_request: <integer>
# h3_support: <value in [disable, enable]>
# ssl_http_location_conversion: <value in [disable, enable]>
# comment: <string>
# ssl_pfs: <value in [require, deny, allow]>
# ssl_hsts_include_subdomains: <value in [disable, enable]>
# ssl_certificate: <list or string>
# ssl_max_version: <value in [ssl-3.0, tls-1.0, tls-1.1, ...]>
# ssl_hpkp_backup: <list or string>
# client_cert: <value in [disable, enable]>
# ssl_client_fallback: <value in [disable, enable]>
# vip6: <list or string>
# ssl_algorithm: <value in [high, low, medium, ...]>
# ssl_server_algorithm: <value in [high, low, medium, ...]>
# ssl_hpkp_include_subdomains: <value in [disable, enable]>
# user_agent_detect: <value in [disable, enable]>
# ssl_server_renegotiation: <value in [disable, enable]>
# svr_pool_ttl: <integer>
# ssl_server_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: ["ssl-3.0", "tls-1.0", "tls-1.1", "tls-1.2", "tls-1.3"]
# ssl_hpkp_primary: <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_trafficforwardproxy_module.html