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

Примечание

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

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

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

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

Впервые в fortinet.fortimanager 2.2.0

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

Описание

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

Параметры

Параметр	Комментарии
access-proxy6 строка	Устарело, используйте «access_proxy6»
access_proxy6 строка	Параметр (access-proxy6) в запрошенном URL.
access_token строка	Токен для доступа к FortiManager без использования имени пользователя и пароля.
adom строка / обязательно	Параметр (adom) в запрошенном URL.
api-gateway6 строка	Устарело, используйте «api_gateway6»
api_gateway6 строка	Параметр (api-gateway6) в запрошенном URL.
bypass_validation логический	Устанавливается в True только тогда, когда схема модуля отличается от структуры API FortiManager, модуль продолжает выполнение без проверки параметров. Варианты: `false` ← (по умолчанию) `true`
enable_log логический	Включить/выключить ведение журнала для задачи. Варианты: `false` ← (по умолчанию) `true`
firewall_accessproxy6_apigateway6_realservers словарь	Настройка верхнего уровня.
addr_type строка	Устарело, переименуйте на addr_type. Тип адреса. Варианты: `"fqdn"` `"ip"`
address строка	Адрес или группа адресов реального сервера.
domain строка	Имя домена реального сервера с подстановкой символов.
external_auth строка	Устарело, переименуйте на external_auth. Включить/выключить использование внешнего браузера в качестве user-agent для авторизации пользователей SAML… Варианты: `"disable"` `"enable"`
health_check строка	Устарело, переименуйте на health_check. Включить проверку доступности реального сервера перед переадресацией трафика. Варианты: `"disable"` `"enable"`
health_check_proto строка	Устарело, переименуйте на health_check_proto. Протокол проверки работоспособности монитора при опросе для определения… Варианты: `"ping"` `"http"` `"tcp-connect"`
holddown_interval строка	Устарело, переименуйте на holddown_interval. Включить/выключить таймер отложенного запуска. Варианты: `"disable"` `"enable"`
http_host строка	Устарело, переименуйте на http_host. Имя домена HTTP-сервера в HTTP-заголовке.
id целое число / обязательно	ID реального сервера.
ip строка	IPv6-адрес реального сервера.
mappedport любой	(список или строка) Порт для связи с реальным сервером.

END_OF_DOCUMENT_MARKER

порт целое число	Порт для связи с реальным сервером.
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.
предложенный_метод строка	Переопределенный метод для базового запроса 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_apigateway6_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_gateway6: <your own value>
        state: present # <value in [present, absent]>
        firewall_accessproxy6_apigateway6_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_apigateway6_realservers_module.html