модуль fortinet.fortimanager.fmgr_vpn_ssl_settings — Настройка SSL VPN.
Примечание
Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.14.0).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.
Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_vpn_ssl_settings.
Добавлено в fortinet.fortimanager 2.1.0
Краткое описание
- Этот модуль предназначен для настройки устройства FortiManager.
- Примеры содержат все параметры и значения, которые необходимо настроить в соответствии с источниками данных перед использованием.
Параметры
Параметр | Комментарии |
|---|---|
access_token string | Токен для доступа к FortiManager без использования имени пользователя и пароля. |
bypass_validation boolean | Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. Модуль продолжит выполнение без проверки параметров. Варианты:
|
device string / обязательный | Параметр (device) в запрашиваемом URL. |
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, переопределяющий условия успешного выполнения. |
vdom string / обязательный | Параметр (vdom) в запрашиваемом URL. |
vpn_ssl_settings dictionary | Набор параметров верхнего уровня. |
|
algorithm string |
Принудительно задать уровень безопасности SSL VPN. Варианты:
|
|
auth_session_check_source_ip aliases: auth-session-check-source-ip string |
Включить/отключить проверку исходного IP-адреса для сеанса аутентификации. Варианты:
|
|
auth_timeout aliases: auth-timeout integer |
Тайм-аут аутентификации SSL VPN |
|
authentication_rule aliases: authentication-rule list / elements=dictionary |
Правило аутентификации. |
|
auth string |
Ограничение метода аутентификации SSL VPN. Варианты:
|
|
cipher string |
Уровень стойкости шифра SSL VPN. Варианты:
|
|
client_cert aliases: client-cert string |
Включить/отключить ограничение по сертификату клиента SSL VPN. Варианты:
|
|
groups any |
(список или строка) Группы пользователей. |
|
id integer |
Идентификатор |
|
portal string |
Портал SSL VPN. |
|
realm string |
Область SSL VPN. |
|
source_address aliases: source-address any |
(список или строка) Исходный адрес входящего трафика. |
|
source_address6 aliases: source-address6 any |
(список или строка) Исходный IPv6-адрес входящего трафика. |
|
source_address6_negate aliases: source-address6-negate string |
Включить/отключить инвертированное сопоставление исходного IPv6-адреса. Варианты:
|
|
source_address_negate aliases: source-address-negate string |
Включить/отключить инвертированное сопоставление исходного адреса. Варианты:
|
|
source_interface aliases: source-interface any |
(список или строка) Исходный интерфейс SSL VPN для входящего трафика. |
|
user_peer aliases: user-peer string |
Имя узла пользователя. |
|
users any |
(список или строка) Имя пользователя. |
|
auto_tunnel_static_route aliases: auto-tunnel-static-route string |
Включить/отключить автоматическое создание статических маршрутов для IP-адресов туннеля SSL VPN. Варианты:
|
|
banned_cipher aliases: banned-cipher list / elements=string |
Выберите одну или несколько криптографических технологий, которые нельзя использовать при согласовании параметров SSL VPN. Варианты:
|
|
browser_language_detection aliases: browser-language-detection string |
Включить/отключить переопределение настроенного системного языка на основе предпочитаемого языка браузера. Варианты:
|
|
check_referer aliases: check-referer string |
Включить/отключить проверку поля referer в заголовке HTTP-запроса. Варианты:
|
|
ciphersuite list / elements=string |
Выберите один или несколько наборов шифров TLS 1. Варианты:
|
|
client_sigalgs aliases: client-sigalgs string |
Задать алгоритмы подписи для аутентификации клиента. Варианты:
|
|
default_portal aliases: default-portal string |
Портал SSL VPN по умолчанию. |
|
deflate_compression_level aliases: deflate-compression-level integer |
Уровень сжатия |
|
deflate_min_data_size aliases: deflate-min-data-size integer |
Минимальный объем данных, при котором запускается сжатие |
|
dns_server1 aliases: dns-server1 string |
DNS-сервер 1. |
|
dns_server2 aliases: dns-server2 string |
DNS-сервер 2. |
|
dns_suffix aliases: dns-suffix string |
Суффикс DNS, используемый клиентами SSL VPN. |
|
dtls_heartbeat_fail_count aliases: dtls-heartbeat-fail-count integer |
Количество пропущенных сигналов проверки активности, после которого соединение считается разорванным. |
|
dtls_heartbeat_idle_timeout aliases: dtls-heartbeat-idle-timeout integer |
Тайм-аут простоя перед отправкой сигнала проверки активности DTLS. |
|
dtls_heartbeat_interval aliases: dtls-heartbeat-interval integer |
Интервал между сигналами проверки активности DTLS. |
|
dtls_hello_timeout aliases: dtls-hello-timeout integer |
Максимальный тайм-аут приветственного сообщения DTLS для SSLVPN |
|
dtls_max_proto_ver aliases: dtls-max-proto-ver string |
Максимальная версия протокола DTLS. Варианты:
|
|
dtls_min_proto_ver aliases: dtls-min-proto-ver string |
Минимальная версия протокола DTLS. Варианты:
|
|
dtls_tunnel aliases: dtls-tunnel string |
Включить/отключить DTLS для защиты от перехвата, изменения или подделки сообщений. Варианты:
|
|
dual_stack_mode aliases: dual-stack-mode string |
Режим туннеля Варианты:
|
|
encode_2f_sequence aliases: encode-2f-sequence string |
Кодировать последовательность 2F как косую черту в URL-адресах. Варианты:
|
|
encrypt_and_store_password aliases: encrypt-and-store-password string |
Шифровать и сохранять пароли пользователей для веб-сеансов SSL VPN. Варианты:
|
|
force_two_factor_auth aliases: force-two-factor-auth string |
Включить/отключить требование двухфакторной аутентификации только для пользователей PKI в SSL VPN. Варианты:
|
|
header_x_forwarded_for aliases: header-x-forwarded-for string |
Пересылать исходный HTTP-заголовок, добавлять его или удалять. Варианты:
|
|
hsts_include_subdomains aliases: hsts-include-subdomains string |
Добавить в ответ заголовок HSTS includeSubDomains. Варианты:
|
|
http_compression aliases: http-compression string |
Включить/отключить сжатие HTTP-трафика в туннелях SSL VPN. Варианты:
|
|
http_only_cookie aliases: http-only-cookie string |
Включить/отключить поддержку файлов cookie HttpOnly в SSL VPN. Варианты:
|
|
http_request_body_timeout aliases: http-request-body-timeout integer |
Сеанс SSL VPN отключается, если тело HTTP-запроса не получено в течение этого времени. |
|
http_request_header_timeout aliases: http-request-header-timeout integer |
Сеанс SSL VPN отключается, если заголовок HTTP-запроса не получен в течение этого времени. |
|
https_redirect aliases: https-redirect string |
Включить/отключить перенаправление с порта 80 на порт SSL VPN. Варианты:
|
|
idle_timeout aliases: idle-timeout integer |
SSL VPN отключается при отсутствии активности в течение указанного времени в секундах. |
|
ipv6_dns_server1 aliases: ipv6-dns-server1 string |
DNS-сервер IPv6 1. |
|
ipv6_dns_server2 aliases: ipv6-dns-server2 string |
DNS-сервер IPv6 2. |
|
ipv6_wins_server1 aliases: ipv6-wins-server1 string |
WINS-сервер IPv6 1. |
|
ipv6_wins_server2 aliases: ipv6-wins-server2 string |
WINS-сервер IPv6 2. |
|
login_attempt_limit aliases: login-attempt-limit integer |
Максимальное количество попыток входа в SSL VPN до блокировки. |
|
login_block_time aliases: login-block-time integer |
Время, в течение которого пользователю запрещен вход после слишком большого количества неудачных попыток авторизации. |
|
login_timeout aliases: login-timeout integer |
Максимальное время ожидания входа в SSL VPN. |
|
port integer |
Порт доступа SSL VPN. |
|
port_precedence aliases: port-precedence string |
Включить/отключить приоритет порта: если на интерфейсе разрешены подключения SSL VPN, подключения к административному интерфейсу GUI блокируются на … Варианты:
|
|
remote_https_cert_check aliases: remote-https-cert-check string |
Настройка проверки сертификата удаленного HTTPS-сервера устройством FortiGate и его реакции на результат проверки. Варианты:
|
|
reqclientcert string |
Включить/отключить обязательное требование сертификатов клиента для всех пользователей SSL VPN. Варианты:
|
|
route_source_interface aliases: route-source-interface string |
Включить/отключить возможность обхода маршрутизации сеансами SSL VPN и привязки к входящему интерфейсу. Варианты:
|
|
saml_redirect_port aliases: saml-redirect-port integer |
Локальный порт перенаправления SAML на компьютере, где запущен FortiClient. |
|
server_hostname aliases: server-hostname string |
Имя хоста сервера для HTTPS. |
|
servercert string |
Имя сертификата сервера, используемого для SSL VPN. |
|
source_address aliases: source-address any |
(список или строка) Адрес источника входящего трафика. |
|
source_address6 aliases: source-address6 any |
(список или строка) Адрес источника IPv6 для входящего трафика. |
|
source_address6_negate aliases: source-address6-negate string |
Включить/отключить инвертированное сопоставление адреса источника IPv6. Варианты:
|
|
source_address_negate aliases: source-address-negate string |
Включить/отключить инвертированное сопоставление адреса источника. Варианты:
|
|
source_interface aliases: source-interface any |
(список или строка) Исходный интерфейс SSL VPN для входящего трафика. |
|
ssl_big_buffer aliases: ssl-big-buffer string |
Отключить использование большого буфера SSLv3 для экономии памяти и повышения безопасности. Варианты:
|
|
ssl_client_renegotiation aliases: ssl-client-renegotiation string |
Включить/отключить разрешение серверу выполнять повторное согласование с клиентом при разрыве туннеля. Варианты:
|
|
ssl_insert_empty_fragment aliases: ssl-insert-empty-fragment string |
Включить/отключить вставку пустого фрагмента. Варианты:
|
|
ssl_max_proto_ver aliases: ssl-max-proto-ver string |
Максимальная версия протокола SSL. Варианты:
|
|
ssl_min_proto_ver aliases: ssl-min-proto-ver string |
Минимальная версия протокола SSL. Варианты:
|
|
sslv3 string |
SSLv3. Варианты:
|
|
status string |
Включить/отключить SSL VPN. Варианты:
|
|
tls_groups aliases: tls-groups list / elements=string |
Настройка групп, поддерживаемых при согласовании TLS. Варианты:
|
|
tlsv1_0 aliases: tlsv1-0 string |
Включить/отключить TLSv1. Варианты:
|
|
tlsv1_1 aliases: tlsv1-1 string |
Включить/отключить TLSv1. Варианты:
|
|
tlsv1_2 aliases: tlsv1-2 string |
Включить/отключить TLSv1. Варианты:
|
|
tlsv1_3 aliases: tlsv1-3 string |
TLSv1.3. Варианты:
|
|
transform_backward_slashes aliases: transform-backward-slashes string |
Преобразовывать обратные косые черты в прямые в URL-адресах. Варианты:
|
|
tunnel_addr_assigned_method aliases: tunnel-addr-assigned-method string |
Метод назначения адреса туннелю. Варианты:
|
|
tunnel_connect_without_reauth aliases: tunnel-connect-without-reauth string |
Включить/отключить подключение к туннелю без повторной авторизации, если предыдущее подключение было разорвано. Варианты:
|
|
tunnel_ip_pools aliases: tunnel-ip-pools any |
(список или строка) Имена объектов межсетевого экрана IP Pool IPv4, определяющих IP-адреса, зарезервированные для удаленных клиентов. |
|
tunnel_ipv6_pools aliases: tunnel-ipv6-pools any |
(list or str) Имена объектов межсетевого экрана пула IP-адресов IPv6, определяющих IP-адреса, зарезервированные для удалённых клиентов. |
|
tunnel_user_session_timeout aliases: tunnel-user-session-timeout integer |
Время ожидания перед очисткой пользовательского сеанса после разрыва туннельного соединения |
|
unsafe_legacy_renegotiation aliases: unsafe-legacy-renegotiation string |
Включить или отключить небезопасное устаревшее повторное согласование. Варианты:
|
|
url_obscuration aliases: url-obscuration string |
Включить или отключить сокрытие имени хоста в URL, отображаемом в веб-браузере. Варианты:
|
|
user_peer aliases: user-peer string |
Имя однорангового узла пользователя. |
|
web_mode_snat aliases: web-mode-snat string |
Включить или отключить использование пулов IP-адресов, определённых в политике межсетевого экрана, при работе в режиме веб-доступа. Варианты:
|
|
wins_server1 aliases: wins-server1 string |
Сервер WINS 1. |
|
wins_server2 aliases: wins-server2 string |
Сервер WINS 2. |
|
x_content_type_options aliases: x-content-type-options string |
Добавить HTTP-заголовок X-Content-Type-Options. Варианты:
|
|
ztna_trusted_client aliases: ztna-trusted-client string |
Включить или отключить проверку сертификата устройства для сеанса SSLVPN ZTNA. Варианты:
|
workspace_locking_adom string | ADOM, который нужно заблокировать для FortiManager, работающего в режиме рабочей области; значением может быть global или другие варианты, включая root. |
workspace_locking_timeout integer | Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: |
Примечания
Примечание
- Начиная с версии 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.
Примеры
- name: Example playbook (generated based on argument schema)
hosts: fortimanagers
connection: httpapi
gather_facts: false
tasks:
- name: Configure SSL VPN.
fortinet.fortimanager.fmgr_vpn_ssl_settings:
# workspace_locking_adom: <global or your adom name>
device: <your own value>
vdom: <your own value>
vpn_ssl_settings:
# algorithm: <value in [default, high, low, ...]>
# auth_session_check_source_ip: <value in [disable, enable]>
# auth_timeout: <integer>
# authentication_rule:
# - auth: <value in [any, local, radius, ...]>
# cipher: <value in [any, high, medium]>
# client_cert: <value in [disable, enable]>
# groups: <list or string>
# id: <integer>
# portal: <string>
# realm: <string>
# source_address: <list or string>
# source_address_negate: <value in [disable, enable]>
# source_address6: <list or string>
# source_address6_negate: <value in [disable, enable]>
# source_interface: <list or string>
# user_peer: <string>
# users: <list or string>
# auto_tunnel_static_route: <value in [disable, enable]>
# banned_cipher: ["RSA", "DH", "DHE", "ECDH", "ECDHE", "DSS", "ECDSA", "AES", "AESGCM",
# "CAMELLIA", "3DES", "SHA1", "SHA256", "SHA384", "STATIC", "CHACHA20",
# "ARIA", "AESCCM"]
# check_referer: <value in [disable, enable]>
# default_portal: <string>
# deflate_compression_level: <integer>
# deflate_min_data_size: <integer>
# dns_server1: <string>
# dns_server2: <string>
# dns_suffix: <string>
# dtls_hello_timeout: <integer>
# dtls_max_proto_ver: <value in [dtls1-0, dtls1-2]>
# dtls_min_proto_ver: <value in [dtls1-0, dtls1-2]>
# dtls_tunnel: <value in [disable, enable]>
# encode_2f_sequence: <value in [disable, enable]>
# encrypt_and_store_password: <value in [disable, enable]>
# force_two_factor_auth: <value in [disable, enable]>
# header_x_forwarded_for: <value in [pass, add, remove]>
# hsts_include_subdomains: <value in [disable, enable]>
# http_compression: <value in [disable, enable]>
# http_only_cookie: <value in [disable, enable]>
# http_request_body_timeout: <integer>
# http_request_header_timeout: <integer>
# https_redirect: <value in [disable, enable]>
# idle_timeout: <integer>
# ipv6_dns_server1: <string>
# ipv6_dns_server2: <string>
# ipv6_wins_server1: <string>
# ipv6_wins_server2: <string>
# login_attempt_limit: <integer>
# login_block_time: <integer>
# login_timeout: <integer>
# port: <integer>
# port_precedence: <value in [disable, enable]>
# reqclientcert: <value in [disable, enable]>
# route_source_interface: <value in [disable, enable]>
# servercert: <string>
# source_address: <list or string>
# source_address_negate: <value in [disable, enable]>
# source_address6: <list or string>
# source_address6_negate: <value in [disable, enable]>
# source_interface: <list or string>
# ssl_client_renegotiation: <value in [disable, enable]>
# ssl_insert_empty_fragment: <value in [disable, enable]>
# ssl_max_proto_ver: <value in [tls1-0, tls1-1, tls1-2, ...]>
# ssl_min_proto_ver: <value in [tls1-0, tls1-1, tls1-2, ...]>
# tlsv1_0: <value in [disable, enable]>
# tlsv1_1: <value in [disable, enable]>
# tlsv1_2: <value in [disable, enable]>
# tlsv1_3: <value in [disable, enable]>
# transform_backward_slashes: <value in [disable, enable]>
# tunnel_connect_without_reauth: <value in [disable, enable]>
# tunnel_ip_pools: <list or string>
# tunnel_ipv6_pools: <list or string>
# tunnel_user_session_timeout: <integer>
# unsafe_legacy_renegotiation: <value in [disable, enable]>
# url_obscuration: <value in [disable, enable]>
# user_peer: <string>
# wins_server1: <string>
# wins_server2: <string>
# x_content_type_options: <value in [disable, enable]>
# sslv3: <value in [disable, enable]>
# ssl_big_buffer: <value in [disable, enable]>
# client_sigalgs: <value in [no-rsa-pss, all]>
# ciphersuite: ["TLS-AES-128-GCM-SHA256", "TLS-AES-256-GCM-SHA384",
# "TLS-CHACHA20-POLY1305-SHA256", "TLS-AES-128-CCM-SHA256",
# "TLS-AES-128-CCM-8-SHA256"]
# dual_stack_mode: <value in [disable, enable]>
# tunnel_addr_assigned_method: <value in [first-available, round-robin]>
# browser_language_detection: <value in [disable, enable]>
# saml_redirect_port: <integer>
# status: <value in [disable, enable]>
# web_mode_snat: <value in [disable, enable]>
# ztna_trusted_client: <value in [disable, enable]>
# dtls_heartbeat_fail_count: <integer>
# dtls_heartbeat_idle_timeout: <integer>
# dtls_heartbeat_interval: <integer>
# server_hostname: <string>
# remote_https_cert_check: <value in [no-check, warn-on-error, reject-on-error]>
# tls_groups: ["P-521", "P-384", "P-256", "ML-KEM512", "ML-KEM768", "ML-KEM1024",
# "P-384-MLKEM1024", "P-256-MLKEM768", "X25519-MLKEM768", "X448", "X25519",
# "FFDHE2048", "FFDHE3072", "FFDHE4096", "FFDHE6144", "FFDHE8192"]
Возвращаемые значения
Общие возвращаемые значения описаны здесь; далее перечислены поля, уникальные для этого модуля:
Ключ | Описание |
|---|---|
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_vpn_ssl_settings_module.html