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

Примечание

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

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

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

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

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

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

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

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

Параметры

Параметр	Комментарии
access-proxy6 string	Устаревший параметр; используйте «access_proxy6»
access_proxy6 string	Параметр (access-proxy6) в запрошенном 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_accessproxy6_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-клиента для Access Proxy.
ssh_host_key псевдонимы: ssh-host-key any	(список) Один или несколько ключей хоста сервера.
ssh_host_key_validation псевдонимы: ssh-host-key-validation string	Включить или отключить проверку ключа хоста SSH-реального сервера. Возможные значения: `"disable"` `"enable"`
status string	Установите для реального сервера состояние active, чтобы он мог принимать трафик, либо standby или disabled, чтобы трафик на него не направлялся. Возможные значения: `"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 / элементы типа integer	Список кодов rc, переопределяющий условия, при которых операция считается неуспешной.
rc_succeeded list / элементы типа 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_accessproxy6_apigateway_realservers:
        # workspace_locking_adom: <global or your adom name>
        adom: <your own value>
        access_proxy6: <your own value>
        api_gateway: <your own value>
        state: present # <value in [present, absent]>
        firewall_accessproxy6_apigateway_realservers:
          id: 0 # Required variable, integer
          # addr_type: <value in [fqdn, ip]>
          # address: <string>
          # domain: <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>
          # mappedport: <list or string>
          # port: <integer>
          # ssh_client_cert: <string>
          # ssh_host_key: <list or string>
          # ssh_host_key_validation: <value in [disable, enable]>
          # status: <value in [active, standby, disable]>
          # type: <value in [tcp-forwarding, ssh]>
          # weight: <integer>
          # 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_accessproxy6_apigateway_realservers_module.html