Модуль fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway_realservers — выбор реальных серверов, на которые этот прокси доступа будет распределять трафик.

Примечание

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

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

Для установки используйте: ansible-galaxy collection install fortinet.fortimanager.

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

Добавлено в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр	Комментарии
access-proxy string	Устарело, используйте «access_proxy»
access_proxy string	Параметр (access-proxy) в запрошенном URL.
access_token string	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom string / обязательный	Параметр (adom) в запрошенном URL.
api-gateway string	Устарело, используйте «api_gateway»
api_gateway string	Параметр (api-gateway) в запрошенном URL.
bypass_validation boolean	Устанавливайте значение True только в том случае, если схема модуля отличается от структуры API FortiManager. В этом случае модуль продолжит работу без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log boolean	Включить или отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_accessproxy_apigateway_realservers dictionary	Набор параметров верхнего уровня.
addr_type псевдонимы: addr-type string	Тип адреса. Варианты: `"fqdn"` `"ip"`
address string	Адрес или группа адресов реального сервера.
domain string	Доменное имя с подстановочными символами реального сервера.
external_auth псевдонимы: external-auth string	Включить или отключить использование внешнего браузера в качестве пользовательского агента для аутентификации пользователей SAML. Варианты: `"disable"` `"enable"`
health_check псевдонимы: health-check string	Включить проверку доступности реального сервера перед перенаправлением трафика. Варианты: `"disable"` `"enable"`
health_check_proto псевдонимы: health-check-proto string	Протокол монитора проверки работоспособности, используемый при опросе для определения состояния подключения серверов. Варианты: `"ping"` `"http"` `"tcp-connect"`
holddown_interval псевдонимы: holddown-interval string	Включить или отключить таймер удержания. Варианты: `"disable"` `"enable"`
http_host псевдонимы: http-host string	Доменное имя HTTP-сервера в заголовке HTTP.
id integer / обязательный	Идентификатор реального сервера.
ip string	IP-адрес реального сервера.
mappedport any	(список или строка) Порт для связи с реальным сервером.
port integer	Порт для связи с реальным сервером.
ssh_client_cert псевдонимы: ssh-client-cert string	Установить профиль сертификата SSH-клиента прокси доступа.
ssh_host_key псевдонимы: ssh-host-key any	(список или строка) Один или несколько ключей хоста сервера.
ssh_host_key_validation псевдонимы: ssh-host-key-validation string	Включить или отключить проверку ключа хоста SSH-реального сервера. Варианты: `"disable"` `"enable"`
status string	Установить для реального сервера активный статус, чтобы он мог принимать трафик, либо статус ожидания или отключения, при котором трафик не отправляется. Варианты: `"active"` `"standby"` `"disable"`
translate_host псевдонимы: translate-host string	Включить или отключить преобразование имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера. Варианты: `"disable"` `"enable"`
tunnel_encryption псевдонимы: tunnel-encryption string	Шифрование туннеля. Варианты: `"disable"` `"enable"`
type string	Тип сервера перенаправления TCP. Варианты: `"tcp-forwarding"` `"ssh"`
verify_cert псевдонимы: verify-cert string	Включить или отключить проверку сертификата реального сервера. Варианты: `"disable"` `"enable"`
weight integer	Вес реального сервера.
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 и другие значения, включая 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.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.

Примеры

- name: Example playbook (generated based on argument schema)
  hosts: fortimanagers
  connection: httpapi
  gather_facts: false
  tasks:
    - name: Select the real servers that this Access Proxy will distribute traffic to.
      fortinet.fortimanager.fmgr_firewall_accessproxy_apigateway_realservers:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        access_proxy: <your own value>
        api_gateway: <your own value>
        state: present # <value in [present, absent]>
        firewall_accessproxy_apigateway_realservers:
          id: 0 # Required variable, integer
          # address: <string>
          # health_check: <value in [disable, enable]>
          # health_check_proto: <value in [ping, http, tcp-connect]>
          # http_host: <string>
          # 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]>
          # verify_cert: <value in [disable, enable]>

Возвращаемые значения

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

Ключ	Описание
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. Возвращается: при сложном сценарии

Авторы

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–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortimanager/fmgr_firewall_accessproxy_apigateway_realservers_module.html