Модуль fortinet.fortimanager.fmgr_firewall_accessproxy_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_accessproxy_apigateway6_realservers.

Новое в fortinet.fortimanager 2.1.0

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

Обзор

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

Параметры

Параметр	Комментарии
access-proxy строка	Устарело, используйте «access_proxy»
access_proxy строка	Параметр (access-proxy) в запрошенном 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_accessproxy_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 целое число / обязательно	Идентификатор реального сервера.
ip строка	IPv6-адрес реального сервера.
mappedport любой	(список или строка) Порт для связи с реальным сервером.

порт целое число	Порт для связи с реальным сервером.
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 строка	Аутентифицировать Ansible-клиент с токеном доступа к API forticloud.
предложенный_метод строка	Переопределенный метод для базового запроса Json RPC. Варианты: `"update"` `"set"` `"add"`
rc_failed список / элементы=целое число	Список rc-кодов, при которых условия будут переопределены для отказа.
rc_succeeded список / элементы=целое число	Список rc-кодов, при которых условия будут переопределены для успеха.
состояние строка / обязательно	Директива для создания, обновления или удаления объекта. Варианты: `"present"` `"absent"`
блокировка_рабочей_области_adom строка	Область, которую нужно заблокировать для FortiManager, работающего в режиме рабочей области, значение может быть глобальным и другими, включая корневой.
тайм-аут_блокировки_рабочей_области целое число	Максимальное время в секундах ожидания других пользователей для разблокировки рабочей области. Значение по умолчанию: `300`

Примечания

Примечание

Начиная с версии 2.4.0, все входные аргументы имеют имена с использованием нижнего подчеркивания (snake_case). Пожалуйста, измените аргументы, такие как «имя_переменной», на «имя_переменной». Старые имена аргументов все еще доступны, но вы получите предупреждения об устаревании. Вы можете игнорировать это предупреждение, установив deprecation_warnings=False в ansible.cfg.
Поддержка работы в режиме блокировки рабочей области реализована в этом модуле FortiManager, параметры workspace_locking_adom и workspace_locking_timeout помогают в этой работе.
Для создания или обновления объекта используйте директиву present.
Для удаления объекта используйте директиву 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_accessproxy_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_proxy: <your own value>
        api_gateway6: <your own value>
        state: present # <value in [present, absent]>
        firewall_accessproxy_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_accessproxy_apigateway6_realservers_module.html