fortinet.fortimanager.fmgr_vpn_ssl_settings модуль — Настройка SSL VPN.

Примечание

Этот модуль является частью коллекции fortinet.fortimanager (версия 2.7.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 строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
bypass_validation логическое	Устанавливается в True только при расхождениях схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
device строка / обязательно	Параметр (device) в запрошенном URL.
enable_log логическое	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
forticloud_access_token строка	Проверка подлинности клиента Ansible с помощью токена доступа к API forticloud.
proposed_method строка	Переопределенный метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия завершения с ошибкой.
rc_succeeded список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия успешного завершения.
vdom строка / обязательно	Параметр (vdom) в запрошенном URL.
vpn_ssl_settings словарь	Параметры верхнего уровня.
algorithm строка	Принудительное изменение уровня безопасности SSL VPN. Варианты: `"default"` `"high"` `"low"` `"medium"`
auth_session_check_source_ip строка	Включить/выключить проверку исходного IP-адреса для сессии аутентификации. Варианты: `"disable"` `"enable"`
auth_timeout целое число	Таймаут аутентификации SSL VPN.
authentication_rule список / элементы=словарь	Правило аутентификации.
auth строка	Ограничение метода аутентификации SSL VPN. Варианты: `"any"` `"local"` `"radius"` `"ldap"` `"tacacs+"` `"peer"`
cipher строка	Уровень шифрования SSL VPN. Варианты: `"any"` `"high"` `"medium"`
client_cert строка	Включить/выключить ограничение на использование SSL сертификата клиента VPN. Варианты: `"disable"` `"enable"`
groups любой	(список или строка) Пользовательские группы.
id целое число	Идентификатор.
portal строка	Портал SSL VPN.
realm строка	Сфера SSL VPN.

source-address any	(list or str) Устарело, переименуйте в source_address. Исходный адрес входящего трафика.
source-address-negate string	Устарело, переименуйте в source_address_negate. Включить/выключить сопоставление с отрицательным исходным адресом. Choices: `"disable"` `"enable"`
source-address6 any	(list or str) Устарело, переименуйте в source_address6. IPv6-адрес источника входящего трафика.
source-address6-negate string	Устарело, переименуйте в source_address6_negate. Включить/выключить сопоставление с отрицательным исходным IPv6-адресом. Choices: `"disable"` `"enable"`
source-interface any	(list or str) Устарело, переименуйте в source_interface. Исходный интерфейс SSL VPN входящего трафика.
user-peer string	Устарело, переименуйте в user_peer. Имя пользовательского узла.
users any	(list or str) Имя пользователя.
auto-tunnel-static-route string	Устарело, переименуйте в auto_tunnel_static_route. Включить/выключить автоматическое создание статических маршрутов для туннеля SSL VPN… Choices: `"disable"` `"enable"`
banned-cipher list / elements=string	Устарело, переименуйте в banned_cipher. Выберите одну или несколько технологий шифрования, которые не могут использоваться в SSL VPN… Choices: `"RSA"` `"DH"` `"DHE"` `"ECDH"` `"ECDHE"` `"DSS"` `"ECDSA"` `"AES"` `"AESGCM"` `"CAMELLIA"` `"3DES"` `"SHA1"` `"SHA256"` `"SHA384"` `"STATIC"` `"CHACHA20"` `"ARIA"` `"AESCCM"`
browser-language-detection string	Устарело, переименуйте в browser_language_detection. Включить/выключить переопределение настроенного системного языка на основе… Choices: `"disable"` `"enable"`
check-referer string	Устарело, переименуйте в check_referer. Включить/выключить проверку поля referer в заголовке HTTP-запроса. Choices: `"disable"` `"enable"`
ciphersuite list / elements=string	Выберите один или несколько наборов TLS 1. Choices: `"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"`
client-sigalgs string	Устарело, переименуйте в client_sigalgs. Установите алгоритмы подписи, связанные с аутентификацией клиента. Choices: `"no-rsa-pss"` `"all"`
default-portal string	Устарело, переименуйте в default_portal. Портал SSL VPN по умолчанию.
deflate-compression-level integer	Устарело, переименуйте в deflate_compression_level. Уровень сжатия
deflate-min-data-size integer	Устарело, переименуйте в deflate_min_data_size. Минимальный объем данных, который запускает сжатие
dns-server1 string	Устарело, переименуйте в dns_server1. DNS-сервер 1.
dns-server2 string	Устарело, переименуйте в dns_server2. DNS-сервер 2.
dns-suffix string	Устарело, переименуйте в dns_suffix. DNS-суффикс, используемый для клиентов SSL VPN.

dtls-heartbeat-fail-count integer	Устарело, переименуйте в dtls_heartbeat_fail_count. Количество пропущенных сигналов «сердцебиение» до того, как соединение будет считаться…
dtls-heartbeat-idle-timeout integer	Устарело, переименуйте в dtls_heartbeat_idle_timeout. Время ожидания бездействия перед отправкой сигнала «сердцебиение» DTLS.
dtls-heartbeat-interval integer	Устарело, переименуйте в dtls_heartbeat_interval. Интервал между сигналами «сердцебиение» DTLS.
dtls-hello-timeout integer	Устарело, переименуйте в dtls_hello_timeout. Максимальное время ожидания DTLS hello для SSLVPN.
dtls-max-proto-ver string	Устарело, переименуйте в dtls_max_proto_ver. Максимальная версия протокола DTLS. Варианты: `"dtls1-0"` `"dtls1-2"`
dtls-min-proto-ver string	Устарело, переименуйте в dtls_min_proto_ver. Минимальная версия протокола DTLS. Варианты: `"dtls1-0"` `"dtls1-2"`
dtls-tunnel string	Устарело, переименуйте в dtls_tunnel. Включить/выключить DTLS для предотвращения несанкционированного прослушивания, подмены или подделки сообщений. Варианты: `"disable"` `"enable"`
dual-stack-mode string	Устарело, переименуйте в dual_stack_mode. Режим туннеля Варианты: `"disable"` `"enable"`
encode-2f-sequence string	Устарело, переименуйте в encode_2f_sequence. Кодировать последовательность 2F в косую черту в URL-адресах. Варианты: `"disable"` `"enable"`
encrypt-and-store-password string	Устарело, переименуйте в encrypt_and_store_password. Шифровать и хранить пароли пользователей для веб-сессий SSL VPN. Варианты: `"disable"` `"enable"`
force-two-factor-auth string	Устарело, переименуйте в force_two_factor_auth. Включить/выключить только пользователей PKI с двухфакторной аутентификацией для SS… Варианты: `"disable"` `"enable"`
header-x-forwarded-for string	Устарело, переименуйте в header_x_forwarded_for. Переслать тот же, добавить или удалить HTTP-заголовок. Варианты: `"pass"` `"add"` `"remove"`
hsts-include-subdomains string	Устарело, переименуйте в hsts_include_subdomains. Добавить заголовок ответа HSTS includeSubDomains. Варианты: `"disable"` `"enable"`
http-compression string	Устарело, переименуйте в http_compression. Включить/выключить для разрешения сжатия HTTP по туннелям SSL VPN. Варианты: `"disable"` `"enable"`
http-only-cookie string	Устарело, переименуйте в http_only_cookie. Включить/выключить поддержку SSL VPN для файлов cookie HttpOnly. Варианты: `"disable"` `"enable"`
http-request-body-timeout integer	Устарело, переименуйте в http_request_body_timeout. Сеанс SSL VPN отключается, если тело HTTP-запроса не…
http-request-header-timeout integer	Устарело, переименуйте в http_request_header_timeout. Сеанс SSL VPN отключается, если заголовок HTTP-запроса…
https-redirect string	Устарело, переименуйте в https_redirect. Включить/выключить переадресацию порта 80 на порт SSL VPN. Варианты: `"disable"` `"enable"`

idle-timeout integer	Устарело, переименуйте в idle_timeout. SSL VPN отключается, если бездействует в течение указанного времени в секундах.
ipv6-dns-server1 string	Устарело, переименуйте в ipv6_dns_server1. IPv6 DNS-сервер 1.
ipv6-dns-server2 string	Устарело, переименуйте в ipv6_dns_server2. IPv6 DNS-сервер 2.
ipv6-wins-server1 string	Устарело, переименуйте в ipv6_wins_server1. IPv6 WINS-сервер 1.
ipv6-wins-server2 string	Устарело, переименуйте в ipv6_wins_server2. IPv6 WINS-сервер 2.
login-attempt-limit integer	Устарело, переименуйте в login_attempt_limit. Максимальное количество попыток входа в SSL VPN перед блокировкой
login-block-time integer	Устарело, переименуйте в login_block_time. Время, на которое пользователь блокируется после слишком большого количества неудачных поп…
login-timeout integer	Устарело, переименуйте в login_timeout. Максимальное время ожидания входа в SSLVPN
port integer	Порт доступа SSL VPN
port-precedence string	Устарело, переименуйте в port_precedence. Включить/выключить, Включить означает, что если соединения SSL VPN разрешены на… Варианты: `"disable"` `"enable"`
reqclientcert string	Включить/выключить требование клиентских сертификатов для всех пользователей SSL VPN. Варианты: `"disable"` `"enable"`
route-source-interface string	Устарело, переименуйте в route_source_interface. Включить/выключить, чтобы разрешить сеансам SSL VPN обходить маршрутизацию и bin… Варианты: `"disable"` `"enable"`
saml-redirect-port integer	Устарело, переименуйте в saml_redirect_port. Локальный порт перенаправления SAML на машине, на которой работает FortiClient
server-hostname string	Устарело, переименуйте в server_hostname. Имя сервера для HTTPS.
servercert string	Имя серверного сертификата, который будет использоваться для SSL VPN.
source-address any	(список или строка) Устарело, переименуйте в source_address. Исходный адрес входящего трафика.
source-address-negate string	Устарело, переименуйте в source_address_negate. Включить/выключить отрицательное соответствие исходного адреса. Варианты: `"disable"` `"enable"`
source-address6 any	(список или строка) Устарело, переименуйте в source_address6. IPv6 исходный адрес входящего трафика.
source-address6-negate string	Устарело, переименуйте в source_address6_negate. Включить/выключить отрицательное соответствие исходного IPv6 адреса. Варианты: `"disable"` `"enable"`
source-interface any	(список или строка) Устарело, переименуйте в source_interface. Исходный интерфейс SSL VPN для входящего трафика.
ssl-big-buffer string	Устарело, переименуйте в ssl_big_buffer. Отключить использование функции большого буфера SSLv3 для экономии памяти и принудительного повышения… Варианты: `"disable"` `"enable"`

ssl-client-renegotiation string	Устарело, переименуйте в ssl_client_renegotiation. Включить/отключить разрешение переговорного процесса клиентом со стороны сервера, если th… Choices: `"disable"` `"enable"`
ssl-insert-empty-fragment string	Устарело, переименуйте в ssl_insert_empty_fragment. Включить/отключить вставку пустого фрагмента. Choices: `"disable"` `"enable"`
ssl-max-proto-ver string	Устарело, переименуйте в ssl_max_proto_ver. Максимальная версия протокола SSL. Choices: `"tls1-0"` `"tls1-1"` `"tls1-2"` `"tls1-3"`
ssl-min-proto-ver string	Устарело, переименуйте в ssl_min_proto_ver. Минимальная версия протокола SSL. Choices: `"tls1-0"` `"tls1-1"` `"tls1-2"` `"tls1-3"`
sslv3 string	Sslv3. Choices: `"disable"` `"enable"`
status string	Включить/отключить SSL-VPN. Choices: `"disable"` `"enable"`
tlsv1-0 string	Устарело, переименуйте в tlsv1_0. Включить/отключить TLSv1. Choices: `"disable"` `"enable"`
tlsv1-1 string	Устарело, переименуйте в tlsv1_1. Включить/отключить TLSv1. Choices: `"disable"` `"enable"`
tlsv1-2 string	Устарело, переименуйте в tlsv1_2. Включить/отключить TLSv1. Choices: `"disable"` `"enable"`
tlsv1-3 string	Устарело, переименуйте в tlsv1_3. Tlsv1 3. Choices: `"disable"` `"enable"`
transform-backward-slashes string	Устарело, переименуйте в transform_backward_slashes. Преобразовать обратные косые черты в прямые косые черты в URL-адресах. Choices: `"disable"` `"enable"`
tunnel-addr-assigned-method string	Устарело, переименуйте в tunnel_addr_assigned_method. Метод, используемый для назначения адреса для туннеля. Choices: `"first-available"` `"round-robin"`
tunnel-connect-without-reauth string	Устарело, переименуйте в tunnel_connect_without_reauth. Включить/отключить подключение к туннелю без повторной авторизации i… Choices: `"disable"` `"enable"`
tunnel-ip-pools any	(list or str) Устарело, переименуйте в tunnel_ip_pools. Имена объектов брандмауэра IPv4 IP Pool, которые определяют …
tunnel-ipv6-pools any	(list or str) Устарело, переименуйте в tunnel_ipv6_pools. Имена объектов брандмауэра IPv6 IP Pool, которые определяют th…
tunnel-user-session-timeout integer	Устарело, переименуйте в tunnel_user_session_timeout. Значение тайм-аута для очистки сеанса пользователя после подключения к туннелю …
unsafe-legacy-renegotiation string	Устарело, переименуйте в unsafe_legacy_renegotiation. Включить/отключить небезопасное устаревшее повторное согласование. Choices: `"disable"` `"enable"`

url-obscuration string	Устаревший параметр, пожалуйста, переименуйте его на url_obscuration. Включить/выключить для маскировки имени хоста URL веб-браузера, … Варианты: `"disable"` `"enable"`
user-peer string	Устаревший параметр, пожалуйста, переименуйте его на user_peer. Имя пользователя-партнера.
web-mode-snat string	Устаревший параметр, пожалуйста, переименуйте его на web_mode_snat. Включить/выключить использование пулов IP-адресов, определенных в политике брандмауэра, при использовании веб-режима. Варианты: `"disable"` `"enable"`
wins-server1 string	Устаревший параметр, пожалуйста, переименуйте его на wins_server1. WINS-сервер 1.
wins-server2 string	Устаревший параметр, пожалуйста, переименуйте его на wins_server2. WINS-сервер 2.
x-content-type-options string	Устаревший параметр, пожалуйста, переименуйте его на x_content_type_options. Добавить заголовок HTTP X-Content-Type-Options. Варианты: `"disable"` `"enable"`
ztna-trusted-client string	Устаревший параметр, пожалуйста, переименуйте его на ztna_trusted_client. Включить/выключить проверку сертификата устройства для сеансов SSLVPN ZTNA… Варианты: `"disable"` `"enable"`
workspace_locking_adom string	ADOM для блокировки при работе FortiManager в рабочем пространстве; значение может быть глобальным и другими, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания, пока другой пользователь не разблокирует рабочее пространство. По умолчанию: `300`

Примечания

Примечание

Начиная с версии 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
  vars:
    ansible_httpapi_use_ssl: true
    ansible_httpapi_validate_certs: false
    ansible_httpapi_port: 443
  tasks:
    - name: Configure SSL VPN.
      fortinet.fortimanager.fmgr_vpn_ssl_settings:
        # 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, ...]
        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>

Значения возврата

Общие значения возврата документированы здесь, следующие являются полями, уникальными для данного модуля:

Ключ	Описание
meta словарь	Результат запроса. Возвращается: всегда
request_url строка	Полный URL запроса. Возвращается: всегда Пример: `"/sys/login/user"`
response_code целое число	Статус запроса API. Возвращается: всегда Пример: `0`
response_data список / элементы=строка	Ответ API. Возвращается: всегда
response_message строка	Описание ответа API. Возвращается: всегда Пример: `"OK."`
system_information словарь	Информация о целевой системе. Возвращается: всегда
rc целое число	Статус запроса. Возвращается: всегда Пример: `0`
version_check_warning список / элементы=строка	Предупреждение, если параметры, используемые в книге задач, не поддерживаются текущей версией FortiManager. Возвращается: сложное

Авторы

Xinwei Du (@dux-fortinet)
Xing Li (@lix-fortinet)
Jie Xue (@JieX19)
Link Zheng (@chillancezen)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

Ссылки на сборник

© 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_vpn_ssl_settings_module.html