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

Примечание

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

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

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

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

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

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

Краткое описание

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

Параметры

Параметр	Комментарии
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`
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"`
web-proxy string	Устарел, используйте “web_proxy”
web_proxy string	Параметр (web-proxy) в запрашиваемом URL.
workspace_locking_adom string	ADOM, блокируемый для FortiManager, работающего в режиме рабочей области; значение может быть global или другим, включая root.
workspace_locking_timeout integer	Максимальное время в секундах ожидания освобождения блокировки рабочей области другим пользователем. По умолчанию: `300`
ztna_webproxy_apigateway_realservers dictionary	Набор параметров верхнего уровня.
addr_type псевдонимы: addr-type string	Тип адреса. Варианты: `"fqdn"` `"ip"`
address list / elements=string	Адрес или группа адресов реального сервера.
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-адрес реального сервера.
port integer	Порт для связи с реальным сервером.
status string	Задаёт состояние реального сервера: active — сервер может принимать трафик; standby или disabled — трафик не отправляется. Варианты: `"active"` `"standby"` `"disable"`
translate_host псевдонимы: translate-host string	Включить или отключить преобразование имени хоста/IP-адреса виртуального сервера в имя хоста/IP-адрес реального сервера. Варианты: `"disable"` `"enable"`
verify_cert псевдонимы: verify-cert string	Включить или отключить проверку сертификата реального сервера. Варианты: `"disable"` `"enable"`
weight 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.
Чтобы создать или обновить объект, используйте директиву 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_ztna_webproxy_apigateway_realservers:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        web_proxy: <your own value>
        api_gateway: <your own value>
        state: present # <value in [present, absent]>
        ztna_webproxy_apigateway_realservers:
          id: 0 # Required variable, integer
          # addr_type: <value in [fqdn, ip]>
          # address: <list or 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>
          # ip: <string>
          # port: <integer>
          # status: <value in [active, standby, disable]>
          # translate_host: <value in [disable, enable]>
          # verify_cert: <value in [disable, enable]>
          # weight: <integer>

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

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

Ключ	Описание
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_ztna_webproxy_apigateway_realservers_module.html