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

Примечание

Этот модуль входит в коллекцию fortinet.fortimanager (версия 2.7.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 строка	Устарело, используйте «access_proxy6»
access_proxy6 строка	Параметр (access-proxy6) в запрошенном URL.
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
api-gateway строка	Устарело, используйте «api_gateway»
api_gateway строка	Параметр (api-gateway) в запрошенном URL.
bypass_validation логическое	Устанавливается в True только при расхождении схемы модуля со структурой API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логическое	Включить/отключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_accessproxy6_apigateway_realservers словарь	Настройка параметров верхнего уровня.
addr_type строка	Устарело, переименуйте на addr_type. Тип адреса. Варианты: `"fqdn"` `"ip"`
address строка	Адрес или группа адресов реального сервера.
domain строка	Доменное имя реального сервера с подстановкой.
external_auth строка	Устарело, переименуйте на external_auth. Включить/выключить использование внешнего браузера в качестве пользователя-агента для SAML-аутентификации пользователей… Варианты: `"disable"` `"enable"`
health_check строка	Устарело, переименуйте на health_check. Включить проверку отзывчивости реального сервера перед переадресацией трафика. Варианты: `"disable"` `"enable"`
health_check_proto строка	Устарело, переименуйте на health_check_proto. Протокол мониторинга проверки работоспособности для определения… Варианты: `"ping"` `"http"` `"tcp-connect"`
holddown_interval строка	Устарело, переименуйте на holddown_interval. Включить/выключить таймер holddown. Варианты: `"disable"` `"enable"`
http_host строка	Устарело, переименуйте на http_host. Имя домена HTTP-сервера в HTTP-заголовке.
id целое число / обязательно	ID реального сервера.
ip строка	IP-адрес реального сервера.
mappedport любой	(список или str) Порт для связи с реальным сервером.

порт целое число	Порт для связи с реальным сервером.
ssh-client-cert строка	Устарело, пожалуйста, переименуйте на ssh_client_cert. Установите профиль сертификата SSH-клиента прокси-сервера доступа.
ssh-host-key любой тип	(список) Устарело, пожалуйста, переименуйте на ssh_host_key. Один или несколько ключей хоста сервера.
ssh-host-key-validation строка	Устарело, пожалуйста, переименуйте на ssh_host_key_validation. Включить/выключить проверку ключа хоста SSH реального сервера. Варианты: `"disable"` `"enable"`
статус строка	Установите статус реального сервера в активное состояние, чтобы он мог принимать трафик, или в режим ожидания или отключен, чтобы трафик не отправлялся. Варианты: `"active"` `"standby"` `"disable"`
translate-host строка	Устарело, пожалуйста, переименуйте на translate_host. Включить/выключить перевод имени хоста/IP-адреса с виртуального сервера на реальный сервер. Варианты: `"disable"` `"enable"`
tunnel-encryption строка	Устарело, пожалуйста, переименуйте на tunnel_encryption. Шифрование туннеля. Варианты: `"disable"` `"enable"`
тип строка	Тип сервера для TCP-переадресации. Варианты: `"tcp-forwarding"` `"ssh"`
вес целое число	Вес реального сервера.
forticloud_access_token строка	Аутентификация клиента Ansible с помощью маркера доступа к API forticloud.
proposed_method строка	Переопределённый метод для основного запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия для сбоя.
rc_succeeded список / элементы=целое число	Список rc-кодов, с которыми будут переопределены условия для успеха.
состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"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: Select the real servers that this Access Proxy will distribute traffic to.
      fortinet.fortimanager.fmgr_firewall_accessproxy6_apigateway_realservers:
        # 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_proxy6: <your own value>
        api_gateway: <your own value>
        state: present # <value in [present, absent]>
        firewall_accessproxy6_apigateway_realservers:
          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>
          id: <integer>
          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]>

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

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

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