Spec-Zone.ru › Ansible

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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.0).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortimanager.

Чтобы использовать её в плейбуке, укажите: fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway.

Новое в fortinet.fortimanager 2.1.0

  • Описание
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Описание

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

Параметры

Параметр

Комментарии

access-proxy

строка

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

access_proxy

строка

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

access_token

строка

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

adom

строка / обязательно

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

bypass_validation

булево

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

Варианты:

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

enable_log

булево

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

Варианты:

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

firewall_accessproxy_apigateway

словарь

Настройка параметров верхнего уровня.

application

любой

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

h2_support

строка

Устарело, переименуйте на h2_support. Поддержка HTTP2, по умолчанию — Включено.

Варианты:

  • "disable"
  • "enable"

h3_support

строка

Устарело, переименуйте на h3_support. Поддержка HTTP3/QUIC, по умолчанию — Отключено.

Варианты:

  • "disable"
  • "enable"

http_cookie_age

целое число

Устарело, переименуйте на http_cookie_age. Время в минутах, которое веб-браузеры клиента должны хранить cookie.

http_cookie_domain

строка

Устарело, переименуйте на http_cookie_domain. Домен, к которому должно применяться сохранение HTTP cookie.

http_cookie_domain_from_host

строка

Устарело, переименуйте на http_cookie_domain_from_host. Включить/отключить использование домена HTTP cookie из поля хоста в …

Варианты:

  • "disable"
  • "enable"

http_cookie_generation

целое число

Устарело, переименуйте на http_cookie_generation. Генерирование принимаемого HTTP cookie.

http_cookie_path

строка

Устарело, переименуйте на http_cookie_path. Ограничить сохранение HTTP cookie указанным путем.

http_cookie_share

строка

Устарело, переименуйте на http_cookie_share. Управление совместным использованием cookie через API Gateway.

Варианты:

  • "disable"
  • "same-ip"

https_cookie_secure

строка

Устарело, переименуйте на https_cookie_secure. Включить/отключить проверку, что вставленные HTTPS cookie безопасны.

Варианты:

  • "disable"
  • "enable"

id

целое число / обязательно

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

ldb_method

строка

Устарело, переименуйте на ldb_method. Метод, используемый для распределения сессий реальным серверам.

Варианты:

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

persistence

string

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

Choices:

  • "none"
  • "http-cookie"

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. Включить/выключить активную миграцию

Choices:

  • "disable"
  • "enable"

grease-quic-bit

string

Устарело, переименуйте в grease_quic_bit. Включить/выключить бит grease QUIC

Choices:

  • "disable"
  • "enable"

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. Тип адреса.

Choices:

  • "fqdn"
  • "ip"

address

string

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

domain

string

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

external-auth

string

Устарело, переименуйте в external_auth. Включить/выключить использование внешнего браузера в качестве user-agent для пользователя SAML …

Choices:

  • "disable"
  • "enable"

health-check

string

Устарело, переименуйте в health_check. Включить проверку доступности реального сервера перед переадресацией…

Choices:

  • "disable"
  • "enable"

health-check-proto

string

Устарело, переименуйте в health_check_proto. Протокол монитора проверки работоспособности, используемый при опросе для…

Choices:

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

holddown-interval

string

Устарело, переименуйте в holddown_interval. Включить/выключить таймер holddown.

Choices:

  • "disable"
  • "enable"

http-host

string

Устарело, переименуйте в http_host. Доменное имя HTTP-сервера в HTTP-заголовке.

id

integer

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

ip

string

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

mappedport

any

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

port

integer

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

ssh-client-cert

string

Устаревшее, пожалуйста, переименуйте на ssh_client_cert. Установка профиля сертификата SSH клиента для доступа к прокси.

ssh-host-key

any

(список или строка) Устаревшее, пожалуйста, переименуйте на ssh_host_key. Один или несколько ключей хоста сервера.

ssh-host-key-validation

string

Устаревшее, пожалуйста, переименуйте на ssh_host_key_validation. Включить/выключить проверку ключа хоста SSH реального сервера.

Варианты:

  • "disable"
  • "enable"

status

string

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

Варианты:

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

translate-host

string

Устаревшее, пожалуйста, переименуйте на translate_host. Включить/выключить преобразование имени хоста/IP-адреса с виртуального сервера на реальный…

Варианты:

  • "disable"
  • "enable"

tunnel-encryption

string

Устаревшее, пожалуйста, переименуйте на tunnel_encryption. Шифрование туннеля.

Варианты:

  • "disable"
  • "enable"

type

string

Тип сервера для TCP-переадресации.

Варианты:

  • "tcp-forwarding"
  • "ssh"

weight

integer

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

saml-redirect

string

Устаревшее, пожалуйста, переименуйте на saml_redirect. Включить/выключить перенаправление SAML после успешной аутентификации.

Варианты:

  • "disable"
  • "enable"

saml-server

string

Устаревшее, пожалуйста, переименуйте на saml_server. Конфигурация поставщика услуг SAML для аутентификации VIP.

service

string

Сервис.

Варианты:

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

ssl-algorithm

string

Устаревшее, пожалуйста, переименуйте на ssl_algorithm. Разрешенные алгоритмы шифрования для серверной стороны сессии SSL полного режима…

Варианты:

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

ssl-cipher-suites

list / elements=dictionary

Устаревшее, пожалуйста, переименуйте на ssl_cipher_suites. Наборы шифров 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

string

Устарело, пожалуйста, переименуйте на ssl_dh_bits. Количество бит для использования в обмене Диффи-Хеллмана для RSA-шифрования SS…

Варианты:

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

ssl-max-version

string

Устарело, пожалуйста, переименуйте на ssl_max_version. Максимальная версия SSL/TLS, приемлемая от сервера.

Варианты:

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

ssl-min-version

string

Устарело, пожалуйста, переименуйте на ssl_min_version. Минимальная версия SSL/TLS, приемлемая от сервера.

Варианты:

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

ssl-renegotiation

string

Устарело, пожалуйста, переименуйте на ssl_renegotiation. Включить/отключить безопасное возобновление, чтобы соответствовать RFC 5746.

Варианты:

  • "disable"
  • "enable"

ssl-vpn-web-portal

string

Устарело, пожалуйста, переименуйте на ssl_vpn_web_portal. Веб-портал SSL-VPN.

url-map

string

Устарело, пожалуйста, переименуйте на url_map. Шаблон URL для сопоставления.

url-map-type

string

Устарело, пожалуйста, переименуйте на url_map_type. Тип url-map.

Варианты:

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

virtual-host

string

Устарело, пожалуйста, переименуйте на virtual_host. Виртуальный хост.

forticloud_access_token

string

Авторизует клиента Ansible с помощью токена доступа к API forticloud.

proposed_method

string

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

Варианты:

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

rc_failed

list / elements=integer

Список rc кодов, при которых условия будут отменены.

rc_succeeded

список / элементы=целое число

Список кодов rc, при которых условия будут считаться выполненными.

state

строка / обязательное

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

Варианты:

  • "present"
  • "absent"

workspace_locking_adom

строка

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

workspace_locking_timeout

целое число

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

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

Примечания

Примечание

  • Начиная с версии 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 API Gateway.
      fortinet.fortimanager.fmgr_firewall_accessproxy_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_proxy: <your own value>
        state: present # <value in [present, absent]>
        firewall_accessproxy_apigateway:
          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:
            -
              address: <string>
              health_check: <value in [disable, enable]>
              health_check_proto: <value in [ping, http, tcp-connect]>
              http_host: <string>
              id: <integer>
              ip: <string>
              mappedport: <list or string>
              port: <integer>
              status: <value in [active, standby, disable]>
              weight: <integer>
              addr_type: <value in [fqdn, ip]>
              domain: <string>
              holddown_interval: <value in [disable, enable]>
              ssh_client_cert: <string>
              ssh_host_key: <list or string>
              ssh_host_key_validation: <value in [disable, enable]>
              type: <value in [tcp-forwarding, ssh]>
              translate_host: <value in [disable, enable]>
              external_auth: <value in [disable, enable]>
              tunnel_encryption: <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, ...]>
          url_map: <string>
          url_map_type: <value in [sub-string, wildcard, regex]>
          virtual_host: <string>
          saml_redirect: <value in [disable, enable]>
          ssl_vpn_web_portal: <string>
          application: <list or 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 запроса.

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

Пример: "/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_firewall_accessproxy_apigateway_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API