Модуль fortinet.fortimanager.fmgr_firewall_accessproxy6_apigateway – Настройка шлюза API IPv4.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).
Эта коллекция может быть уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать его в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_accessproxy6_apigateway.
Новая версия в fortinet.fortimanager 2.2.0
Описание
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием, исходя из данных источников.
Параметры
Параметр | Комментарии |
|---|---|
access-proxy6 строка | Устарело, используйте «access_proxy6» |
access_proxy6 строка | Параметр (access-proxy6) в запрошенном URL. |
access_token строка | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
adom строка / обязательно | Параметр (adom) в запрошенном URL. |
bypass_validation логическое | Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты:
|
enable_log логическое | Включить/выключить логирование для задачи. Варианты:
|
firewall_accessproxy6_apigateway словарь | Настройка параметров верхнего уровня. |
|
application любой |
(список) SaaS-приложение, контролируемое этим Access Proxy. |
|
h2_support строка |
Устарело, переименуйте на h2_support. Поддержка HTTP2, по умолчанию - включена. Варианты:
|
|
h3_support строка |
Устарело, переименуйте на h3_support. Поддержка HTTP3/QUIC, по умолчанию - выключена. Варианты:
|
|
http_cookie_age целое число |
Устарело, переименуйте на http_cookie_age. Время в минутах, которое веб-браузеры клиента должны хранить куки. |
|
http_cookie_domain строка |
Устарело, переименуйте на http_cookie_domain. Домен, к которому должна применяться постоянство HTTP-куки. |
|
http_cookie_domain_from_host строка |
Устарело, переименуйте на http_cookie_domain_from_host. Включить/выключить использование домена HTTP-куки из поля host в … Варианты:
|
|
http_cookie_generation целое число |
Устарело, переименуйте на http_cookie_generation. Генерация принимаемой HTTP-куки. |
|
http_cookie_path строка |
Устарело, переименуйте на http_cookie_path. Ограничить постоянство HTTP-куки указанным путем. |
|
строка |
Устарело, переименуйте на http_cookie_share. Управление совместным использованием куки в API Gateway. Варианты:
|
|
https_cookie_secure строка |
Устарело, переименуйте на https_cookie_secure. Включить/выключить проверку того, что вставленные HTTPS-куки защищены. Варианты:
|
|
id целое число / обязательно |
ID API Gateway. |
|
ldb_method строка |
Устарело, переименуйте на ldb_method. Метод, используемый для распределения сессий на реальные серверы. Варианты:
|
|
persistence string |
Настройка способа обеспечения подключения клиентов к одному и тому же серверу при каждом запросе, являющемся частью одного… Варианты:
|
|
quic dictionary |
Quic. |
|
ack-delay-exponent integer |
Устарело, переименуйте в ack_delay_exponent. Показатель задержки ACK |
|
active-connection-id-limit integer |
Устарело, переименуйте в active_connection_id_limit. Лимит активных идентификаторов соединений |
|
active-migration string |
Устарело, переименуйте в active_migration. Включить/выключить активную миграцию Варианты:
|
|
grease-quic-bit string |
Устарело, переименуйте в grease_quic_bit. Включить/выключить бит grease QUIC Варианты:
|
|
max-ack-delay integer |
Устарело, переименуйте в max_ack_delay. Максимальная задержка ACK в миллисекундах |
|
max-datagram-frame-size integer |
Устарело, переименуйте в max_datagram_frame_size. Максимальный размер кадра датаграммы в байтах |
|
max-idle-timeout integer |
Устарело, переименуйте в max_idle_timeout. Максимальное время ожидания бездействия в миллисекундах |
|
max-udp-payload-size integer |
Устарело, переименуйте в max_udp_payload_size. Максимальный размер полезной нагрузки UDP в байтах |
|
realservers list / elements=dictionary |
Realservers. |
|
addr-type string |
Устарело, переименуйте в addr_type. Тип адреса. Варианты:
|
|
address string |
Адрес или группа адресов реального сервера. |
|
domain string |
Имя домена с подстановочными знаками для реального сервера. |
|
external-auth string |
Устарело, переименуйте в external_auth. Включить/выключить использование внешнего браузера в качестве user-agent для пользователя SAML … Варианты:
|
|
health-check string |
Устарело, переименуйте в health_check. Включить проверку отзывчивости реального сервера перед переадресацией… Варианты:
|
|
health-check-proto string |
Устарело, переименуйте в health_check_proto. Протокол монитора проверки работоспособности, используемый при опросе для de… Варианты:
|
|
holddown-interval string |
Устарело, переименуйте в holddown_interval. Включить/выключить таймер holddown. Варианты:
|
|
http-host string |
Устарело, переименуйте в http_host. Имя домена HTTP-сервера в HTTP-заголовке. |
|
id integer |
Идентификатор реального сервера. |
|
ip string |
IP-адрес реального сервера. |
|
mappedport any |
(список или str) Порт для связи с реальным сервером. |
|
port integer |
Порт для связи с реальным сервером. |
|
ssh-client-cert string |
Устарело, переименуйте в ssh_client_cert. Установите профиль сертификата клиента SSH для access-proxy. |
|
ssh-host-key any |
(список) Устарело, переименуйте в ssh_host_key. Один или несколько ключей хоста сервера. |
|
ssh-host-key-validation string |
Устарело, переименуйте в ssh_host_key_validation. Включить/отключить проверку ключа хоста реального сервера SSH. Варианты:
|
|
status string |
Установите статус реального сервера как активный, чтобы он мог принимать трафик, или как резервный или отключенный, чтобы не принимать трафик… Варианты:
|
|
translate-host string |
Устарело, переименуйте в translate_host. Включить/отключить преобразование имени хоста/IP с виртуального сервера на r… Варианты:
|
|
tunnel-encryption string |
Устарело, переименуйте в tunnel_encryption. Шифрование туннеля. Варианты:
|
|
type string |
Тип сервера TCP-переадресации. Варианты:
|
|
weight integer |
Вес реального сервера. |
|
saml-redirect string |
Устарело, переименуйте в saml_redirect. Включить/отключить перенаправление SAML после успешной аутентификации. Варианты:
|
|
saml-server string |
Устарело, переименуйте в saml_server. Конфигурация поставщика услуг SAML для аутентификации VIP. |
|
service string |
Сервис. Варианты:
|
|
ssl-algorithm string |
Устарело, переименуйте в ssl_algorithm. Допустимые алгоритмы шифрования для серверной стороны сеанса SSL в полном режиме… Варианты:
|
|
ssl-cipher-suites list / elements=dictionary |
Устарело, переименуйте в ssl_cipher_suites. Наборы шифров SSL. |
|
шифр строка |
Имя набора шифров. Варианты:
|
|
приоритет целое число |
Приоритет набора шифров SSL/TLS. |
|
версии список / элементы=строка |
Версии SSL/TLS, с которыми можно использовать набор шифров. Варианты:
|
|
ssl-dh-разрядность строка |
Устарело, пожалуйста, переименуйте на ssl_dh_bits. Количество бит, используемых в обмене Диффи-Хеллмана для шифрования RSA соединения SS… Варианты:
|
|
ssl-максимальная версия строка |
Устарело, пожалуйста, переименуйте на ssl_max_version. Наивысшая версия SSL/TLS, приемлемая от сервера. Варианты:
|
|
ssl-минимальная версия строка |
Устарело, пожалуйста, переименуйте на ssl_min_version. Наименьшая версия SSL/TLS, приемлемая от сервера. Варианты:
|
|
ssl-переподключение строка |
Устарело, пожалуйста, переименуйте на ssl_renegotiation. Включить/выключить безопасное переподключение для соответствия RFC 5746. Варианты:
|
|
ssl-vpn-веб-портал строка |
Устарело, пожалуйста, переименуйте на ssl_vpn_web_portal. Веб-портал SSL-VPN. |
|
url-карта строка |
Устарело, пожалуйста, переименуйте на url_map. Шаблон URL для сопоставления. |
|
тип-url-карты строка |
Устарело, пожалуйста, переименуйте на url_map_type. Тип url-карты. Варианты:
|
|
виртуальный хост строка |
Устарело, пожалуйста, переименуйте на virtual_host. Виртуальный хост. |
токен_доступа_forticloud строка | Авторизовать Ansible-клиент с токеном доступа к API forticloud. |
предложенный_метод строка | Переопределённый метод для основного запроса Json RPC. Варианты:
|
rc_неудача список / элементы=целое число | Список кодов rc, с которыми будут переопределены условия для отказа. |
rc_succeeded список / элементы=целое число | Список кодов rc, по которым будут переопределены условия успеха. |
state строка / обязательно | Директива для создания, обновления или удаления объекта. Варианты:
|
workspace_locking_adom строка | ADOM для блокировки FortiManager, работающего в режиме рабочего пространства. Значение может быть глобальным или другим, включая root. |
workspace_locking_timeout целое число | Максимальное время в секундах ожидания, пока другой пользователь не освободит блокировку рабочего пространства. По умолчанию: |
Примечания
Примечание
- Начиная с версии 2.4.0, все входные аргументы имеют наименование с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как “var-name”, на “var_name”. Старые имена аргументов все еще доступны, но вы получите предупреждения об устаревании. Вы можете проигнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
- В этом модуле FortiManager поддерживается работа в режиме блокировки рабочего пространства, для этого служат параметры workspace_locking_adom и workspace_locking_timeout.
- Для создания или обновления объекта используйте директиву state present.
- Для удаления объекта используйте директиву state absent.
- Обычно выполнение одного модуля может завершиться неудачей, когда возвращается ненулевой rc. Вы также можете переопределить условия для завершения неудачей или успехом с помощью параметров rc_failed и rc_succeeded
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
vars:
ansible_httpapi_use_ssl: true
ansible_httpapi_validate_certs: false
ansible_httpapi_port: 443
tasks:
- name: Set IPv4 API Gateway.
fortinet.fortimanager.fmgr_firewall_accessproxy6_apigateway:
# bypass_validation: false
workspace_locking_adom: <value in [global, custom adom including root]>
workspace_locking_timeout: 300
# rc_succeeded: [0, -2, -3, ...]
# rc_failed: [-2, -3, ...]
adom: <your own value>
access_proxy6: <your own value>
state: present # <value in [present, absent]>
firewall_accessproxy6_apigateway:
application: <list or string>
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]>
realservers:
-
addr_type: <value in [fqdn, ip]>
address: <string>
domain: <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>
mappedport: <list or string>
port: <integer>
ssh_client_cert: <string>
ssh_host_key: <list or string>
ssh_host_key_validation: <value in [disable, enable]>
status: <value in [active, standby, disable]>
type: <value in [tcp-forwarding, ssh]>
weight: <integer>
translate_host: <value in [disable, enable]>
external_auth: <value in [disable, enable]>
tunnel_encryption: <value in [disable, enable]>
saml_redirect: <value in [disable, enable]>
saml_server: <string>
service: <value in [http, https, tcp-forwarding, ...]>
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_vpn_web_portal: <string>
url_map: <string>
url_map_type: <value in [sub-string, wildcard, regex]>
virtual_host: <string>
ssl_renegotiation: <value in [disable, enable]>
h2_support: <value in [disable, enable]>
h3_support: <value in [disable, enable]>
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>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
meta словарь | Результат запроса. Возвращается: всегда |
|
request_url строка |
Полный URL запроса. Возвращается: всегда Пример: |
|
response_code целое число |
Статус API запроса. Возвращается: всегда Пример: |
|
response_data список / элементы=строка |
Ответ API. Возвращается: всегда |
|
response_message строка |
Дескриптивное сообщение ответа API. Возвращается: всегда Пример: |
|
system_information словарь |
Информация о целевой системе. Возвращается: всегда |
rc целое число | Статус запроса. Возвращается: всегда Пример: |
version_check_warning список / элементы=строка | Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное |
Ссылки на сборку
© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_accessproxy6_apigateway_module.html