Модуль fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway — настройка API-шлюза.

access-proxy

string

Устарело, используйте «access_proxy»

access_proxy

string

Параметр (access-proxy) в запрошенном URL.

access_token

string

Токен для доступа к FortiManager без использования имени пользователя и пароля.

adom

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

Параметр (adom) в запрошенном URL.

bypass_validation

boolean

Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит выполнение без проверки параметров.

Варианты:

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

enable_log

boolean

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

Варианты:

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

firewall_accessproxy_apigateway

dictionary

Набор параметров верхнего уровня.

application

any

(список) SaaS-приложение, управляемое этим Access Proxy.

h2_support

aliases: h2-support

string

Поддержка HTTP/2, по умолчанию включена.

Варианты:

• "disable"
• "enable"

h3_support

aliases: h3-support

string

Поддержка HTTP/3/QUIC, по умолчанию отключена.

Варианты:

• "disable"
• "enable"

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.

Варианты:

• "disable"
• "enable"

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.

Варианты:

• "disable"
• "same-ip"

https_cookie_secure

aliases: https-cookie-secure

string

Включить/отключить проверку безопасности вставленных HTTPS-cookie.

Варианты:

• "disable"
• "enable"

id

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

Идентификатор шлюза API.

ldb_method

aliases: ldb-method

string

Метод распределения сеансов между реальными серверами.

Варианты:

• "static"
• "round-robin"
• "weighted"
• "least-session"
• "least-rtt"
• "first-alive"
• "http-host"

persistence

string

Настройка способа, который гарантирует подключение клиентов к одному и тому же серверу при каждом запросе, относящемся к одной и той же…

Варианты:

• "none"
• "http-cookie"

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

Включить/отключить активную миграцию

Варианты:

• "disable"
• "enable"

grease_quic_bit

aliases: grease-quic-bit

string

Включить/отключить бит grease QUIC

Варианты:

• "disable"
• "enable"

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

Тип адреса.

Варианты:

• "fqdn"
• "ip"

address

string

Адрес или группа адресов реального сервера.

domain

string

Доменное имя с подстановочными знаками реального сервера.

external_auth

aliases: external-auth

string

Включить/отключить использование внешнего браузера в качестве пользовательского агента для аутентификации пользователей SAML.

Варианты:

• "disable"
• "enable"

health_check

aliases: health-check

string

Включить проверку доступности реального сервера перед пересылкой трафика.

Варианты:

• "disable"
• "enable"

health_check_proto

aliases: health-check-proto

string

Протокол монитора проверки доступности, используемый при опросе для определения состояния подключения серверов.

Варианты:

• "ping"
• "http"
• "tcp-connect"

holddown_interval

aliases: holddown-interval

string

Включить/отключить таймер удержания.

Варианты:

• "disable"
• "enable"

http_host

aliases: http-host

string

Доменное имя HTTP-сервера в заголовке HTTP.

id

integer

Идентификатор реального сервера.

ip

string

IP-адрес реального сервера.

mappedport

any

(список или строка) Порт для связи с реальным сервером.

port

integer

Порт для связи с реальным сервером.

ssh_client_cert

aliases: ssh-client-cert

string

Задать профиль сертификата SSH-клиента для Access Proxy.

ssh_host_key

aliases: ssh-host-key

any

(список или строка) Один или несколько ключей хоста сервера.

ssh_host_key_validation

aliases: ssh-host-key-validation

string

Включить/отключить проверку ключа хоста SSH-реального сервера.

Варианты:

• "disable"
• "enable"

status

string

Установить для реального сервера активный статус, чтобы он мог принимать трафик, либо перевести его в режим ожидания или отключить, чтобы трафик не…

Варианты:

• "active"
• "standby"
• "disable"

translate_host

aliases: translate-host

string

Включить/отключить преобразование имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера.

Варианты:

• "disable"
• "enable"

tunnel_encryption

aliases: tunnel-encryption

string

Шифрование туннеля.

Варианты:

• "disable"
• "enable"

type

string

Тип сервера перенаправления TCP.

Варианты:

• "tcp-forwarding"
• "ssh"

verify_cert

псевдонимы: verify-cert

string

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

Варианты:

• "disable"
• "enable"

weight

integer

Вес реального сервера.

saml_redirect

псевдонимы: saml-redirect

string

Включить или отключить перенаправление SAML после успешной аутентификации.

Варианты:

• "disable"
• "enable"

saml_server

псевдонимы: saml-server

string

Конфигурация поставщика услуг SAML для аутентификации VIP.

service

string

Служба.

Варианты:

• "http"
• "https"
• "tcp-forwarding"
• "samlsp"
• "web-portal"
• "saas"

ssl_algorithm

псевдонимы: ssl-algorithm

string

Допустимые алгоритмы шифрования для серверной стороны сеансов SSL в режиме full в соответствии с уровнем стойкости шифрования.

Варианты:

• "high"
• "medium"
• "low"
• "custom"

ssl_cipher_suites

псевдонимы: ssl-cipher-suites

list / elements=dictionary

Наборы шифров SSL.

cipher

string

Название набора шифров.

Варианты:

• "TLS-RSA-WITH-RC4-128-MD5"
• "TLS-RSA-WITH-RC4-128-SHA"
• "TLS-RSA-WITH-DES-CBC-SHA"
• "TLS-RSA-WITH-3DES-EDE-CBC-SHA"
• "TLS-RSA-WITH-AES-128-CBC-SHA"
• "TLS-RSA-WITH-AES-256-CBC-SHA"
• "TLS-RSA-WITH-AES-128-CBC-SHA256"
• "TLS-RSA-WITH-AES-256-CBC-SHA256"
• "TLS-RSA-WITH-CAMELLIA-128-CBC-SHA"
• "TLS-RSA-WITH-CAMELLIA-256-CBC-SHA"
• "TLS-RSA-WITH-CAMELLIA-128-CBC-SHA256"
• "TLS-RSA-WITH-CAMELLIA-256-CBC-SHA256"
• "TLS-RSA-WITH-SEED-CBC-SHA"
• "TLS-RSA-WITH-ARIA-128-CBC-SHA256"
• "TLS-RSA-WITH-ARIA-256-CBC-SHA384"
• "TLS-DHE-RSA-WITH-DES-CBC-SHA"
• "TLS-DHE-RSA-WITH-3DES-EDE-CBC-SHA"
• "TLS-DHE-RSA-WITH-AES-128-CBC-SHA"
• "TLS-DHE-RSA-WITH-AES-256-CBC-SHA"
• "TLS-DHE-RSA-WITH-AES-128-CBC-SHA256"
• "TLS-DHE-RSA-WITH-AES-256-CBC-SHA256"
• "TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA"
• "TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA"
• "TLS-DHE-RSA-WITH-CAMELLIA-128-CBC-SHA256"
• "TLS-DHE-RSA-WITH-CAMELLIA-256-CBC-SHA256"
• "TLS-DHE-RSA-WITH-SEED-CBC-SHA"
• "TLS-DHE-RSA-WITH-ARIA-128-CBC-SHA256"
• "TLS-DHE-RSA-WITH-ARIA-256-CBC-SHA384"
• "TLS-ECDHE-RSA-WITH-RC4-128-SHA"
• "TLS-ECDHE-RSA-WITH-3DES-EDE-CBC-SHA"
• "TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA"
• "TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA"
• "TLS-ECDHE-RSA-WITH-CHACHA20-POLY1305-SHA256"
• "TLS-ECDHE-ECDSA-WITH-CHACHA20-POLY1305-SHA256"
• "TLS-DHE-RSA-WITH-CHACHA20-POLY1305-SHA256"
• "TLS-DHE-RSA-WITH-AES-128-GCM-SHA256"
• "TLS-DHE-RSA-WITH-AES-256-GCM-SHA384"
• "TLS-DHE-DSS-WITH-AES-128-CBC-SHA"
• "TLS-DHE-DSS-WITH-AES-256-CBC-SHA"
• "TLS-DHE-DSS-WITH-AES-128-CBC-SHA256"
• "TLS-DHE-DSS-WITH-AES-128-GCM-SHA256"
• "TLS-DHE-DSS-WITH-AES-256-CBC-SHA256"
• "TLS-DHE-DSS-WITH-AES-256-GCM-SHA384"
• "TLS-ECDHE-RSA-WITH-AES-128-CBC-SHA256"
• "TLS-ECDHE-RSA-WITH-AES-128-GCM-SHA256"
• "TLS-ECDHE-RSA-WITH-AES-256-CBC-SHA384"
• "TLS-ECDHE-RSA-WITH-AES-256-GCM-SHA384"
• "TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA"
• "TLS-ECDHE-ECDSA-WITH-AES-128-CBC-SHA256"
• "TLS-ECDHE-ECDSA-WITH-AES-128-GCM-SHA256"
• "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA384"
• "TLS-ECDHE-ECDSA-WITH-AES-256-GCM-SHA384"
• "TLS-RSA-WITH-AES-128-GCM-SHA256"
• "TLS-RSA-WITH-AES-256-GCM-SHA384"
• "TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA"
• "TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA"
• "TLS-DHE-DSS-WITH-CAMELLIA-128-CBC-SHA256"
• "TLS-DHE-DSS-WITH-CAMELLIA-256-CBC-SHA256"
• "TLS-DHE-DSS-WITH-SEED-CBC-SHA"
• "TLS-DHE-DSS-WITH-ARIA-128-CBC-SHA256"
• "TLS-DHE-DSS-WITH-ARIA-256-CBC-SHA384"
• "TLS-ECDHE-RSA-WITH-ARIA-128-CBC-SHA256"
• "TLS-ECDHE-RSA-WITH-ARIA-256-CBC-SHA384"
• "TLS-ECDHE-ECDSA-WITH-ARIA-128-CBC-SHA256"
• "TLS-ECDHE-ECDSA-WITH-ARIA-256-CBC-SHA384"
• "TLS-DHE-DSS-WITH-3DES-EDE-CBC-SHA"
• "TLS-DHE-DSS-WITH-DES-CBC-SHA"
• "TLS-AES-128-GCM-SHA256"
• "TLS-AES-256-GCM-SHA384"
• "TLS-CHACHA20-POLY1305-SHA256"
• "TLS-ECDHE-ECDSA-WITH-AES-256-CBC-SHA"

priority

integer

Приоритет наборов шифров SSL/TLS.

versions

list / elements=string

Версии SSL/TLS, с которыми можно использовать этот набор шифров.

Варианты:

• "tls-1.0"
• "tls-1.1"
• "tls-1.2"
• "tls-1.3"

ssl_dh_bits

псевдонимы: ssl-dh-bits

string

Количество битов, используемых при обмене Diffie-Hellman для шифрования сеансов SSL с помощью RSA.

Варианты:

• "768"
• "1024"
• "1536"
• "2048"
• "3072"
• "4096"

ssl_max_version

псевдонимы: ssl-max-version

string

Наиболее высокая версия SSL/TLS, допустимая для сервера.

Варианты:

• "tls-1.0"
• "tls-1.1"
• "tls-1.2"
• "tls-1.3"

ssl_min_version

псевдонимы: ssl-min-version

string

Наиболее низкая версия SSL/TLS, допустимая для сервера.

Варианты:

• "tls-1.0"
• "tls-1.1"
• "tls-1.2"
• "tls-1.3"

ssl_renegotiation

псевдонимы: ssl-renegotiation

string

Включить или отключить безопасное повторное согласование в соответствии с RFC 5746.

Варианты:

• "disable"
• "enable"

ssl_vpn_web_portal

псевдонимы: ssl-vpn-web-portal

string

Веб-портал SSL-VPN.

url_map

псевдонимы: url-map

string

Шаблон URL для сопоставления.

url_map_type

псевдонимы: url-map-type

string

Тип url-map.

Варианты:

• "sub-string"
• "wildcard"
• "regex"

virtual_host

псевдонимы: virtual-host

string

Виртуальный хост.

forticloud_access_token

string

Аутентификация клиента Ansible с помощью токена доступа к API FortiCloud.

proposed_method

string

Переопределяемый метод для базового запроса Json RPC.

Варианты:

• "update"
• "set"
• "add"

rc_failed

list / elements=integer

Список кодов rc, переопределяющий условия сбоя.

rc_succeeded

list / elements=integer

Список кодов rc, переопределяющий условия успеха.

revision_note

string

Примечание об изменении, которое можно указать при создании или обновлении объекта.

state

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

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

Варианты:

• "present"
• "absent"

workspace_locking_adom

string

ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области. В качестве значения можно указать global или другие ADOM, включая root.

workspace_locking_timeout

integer

Максимальное время ожидания в секундах, пока другой пользователь снимет блокировку рабочей области.

По умолчанию: 300

meta

dictionary

Результат запроса.

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

request_url

string

Полный URL запроса.

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

Пример: "/sys/login/user"

response_code

integer

Статус запроса API.

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

Пример: 0

response_data

list / elements=string

Ответ API.

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

response_message

string

Описание ответа API.

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

Пример: "OK."

system_information

dictionary

Информация о целевой системе.

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

rc

integer

Статус запроса.

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

Пример: 0

version_check_warning

list / elements=string

Предупреждение о том, что используемые в сценарии параметры не поддерживаются текущей версией FortiManager.

Возвращается: в сложных случаях