модуль fortinet.fortimanager.fmgr_ztna_webproxy_apigateway – настройка шлюза API IPv4.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_ztna_webproxy_apigateway.
Добавлено в 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 / обязательный | Директива для создания, обновления или удаления объекта. Варианты:
|
web-proxy string | Устарело, используйте «web_proxy» |
web_proxy string | Параметр (web-proxy) в запрошенном URL. |
workspace_locking_adom string | ADOM, блокируемый для FortiManager, работающего в режиме рабочей области; значением может быть global и другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время ожидания освобождения блокировки рабочей области другим пользователем, в секундах. По умолчанию: |
ztna_webproxy_apigateway dictionary | Набор параметров верхнего уровня. |
|
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 Gateway. Варианты:
|
|
https_cookie_secure псевдонимы: https-cookie-secure string |
Включить/отключить проверку безопасности вставленных HTTPS cookie. Варианты:
|
|
id integer / обязательный |
Идентификатор API Gateway. |
|
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-адреса с виртуального сервера на реальный сервер. Варианты:
|
|
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 |
Количество битов, используемых при обмене Diffie-Hellman для шифрования сеансов 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-map. Варианты:
|
Примечания
Примечание
- Начиная с версии 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: Set IPv4 API Gateway.
fortinet.fortimanager.fmgr_ztna_webproxy_apigateway:
# workspace_locking_adom: <global or your adom name>
adom: <your own value>
web_proxy: <your own value>
state: present # <value in [present, absent]>
ztna_webproxy_apigateway:
id: 0 # Required variable, integer
# 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]>
# 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]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь; ниже перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_apigateway_module.html