fortinet.fortimanager.fmgr_webproxy_forwardserver – Настройка адресов сервера обратного проксирования.

Примечание

Этот плагин входит в коллекцию fortinet.fortimanager (версия 2.0.1).

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

Для использования в playbook, укажите: fortinet.fortimanager.fmgr_webproxy_forwardserver.

Новое в версии 2.10: модуля fortinet.fortimanager

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

Обзор

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

Параметры

Параметр		Варианты/Значения по умолчанию	Комментарии
adom строка / обязательно			параметр (adom) в запрошенном URL
bypass_validation булево		Варианты: нет ← да	устанавливается в True только тогда, когда структура схемы модуля отличается от структуры API FortiManager. Модуль продолжает выполняться без проверки параметров
rc_failed список / элементы=строка			список кодов rc, с которыми условия для ошибки будут переопределены
rc_succeeded список / элементы=строка			список кодов rc, с которыми условия для успеха будут переопределены
state строка / обязательно		Варианты: present absent	директива для создания, обновления или удаления объекта
webproxy_forwardserver словарь			устанавливаемые параметры верхнего уровня
	addr-type строка	Варианты: fqdn ip	Тип адреса сервера обратного проксирования: IP или FQDN.
	comment строка		Комментарий.
	fqdn строка		Полное доменное имя (FQDN) сервера обратного проксирования.
	healthcheck строка	Варианты: disable enable	Включить/выключить проверку работоспособности сервера обратного проксирования. Попытки подключения через удаленный сервер обратного проксирования к целевому ресурсу...
	ip строка		IP-адрес сервера обратного проксирования.
	monitor строка		URL для мониторинга проверки работоспособности сервера обратного проксирования (по умолчанию = http://www.google.com).
	name строка		Имя сервера.
	port целое число		Номер порта, на котором ожидается получение HTTP-сессий сервером обратного проксирования (от 1 до 65535, по умолчанию = 3128).
	server-down-option строка	Варианты: block pass	Действие, которое следует выполнить, когда сервер обратного проксирования считается недоступным: заблокировать сессии до его возвращения в работу или передать сессии дальше...
workspace_locking_adom строка			ADOM для блокировки FortiManager, работающего в режиме рабочей области. Значение может быть глобальным и другими, включая root.
workspace_locking_timeout целое число		По умолчанию: 300	максимальное время ожидания в секундах для освобождения блокировки рабочей области другим пользователем

Примечания

Примечание

Поддержка работы в режиме блокировки рабочей области в этом модуле FortiManager, параметры верхнего уровня workspace_locking_adom и workspace_locking_timeout помогают в этом.
Для создания или обновления объекта используйте директиву state present.
Для удаления объекта используйте директиву state absent.
Обычно выполнение одного модуля может завершиться ошибкой при возвращении ненулевого rc. Вы также можете переопределить условия ошибки или успеха с помощью параметров rc_failed и rc_succeeded.

Примеры

- hosts: fortimanager-inventory
  collections:
    - fortinet.fortimanager
  connection: httpapi
  vars:
     ansible_httpapi_use_ssl: True
     ansible_httpapi_validate_certs: False
     ansible_httpapi_port: 443
  tasks:
   - name: Configure forward-server addresses.
     fmgr_webproxy_forwardserver:
        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>
        state: <value in [present, absent]>
        webproxy_forwardserver:
           addr-type: <value in [fqdn, ip]>
           comment: <value of string>
           fqdn: <value of string>
           healthcheck: <value in [disable, enable]>
           ip: <value of string>
           monitor: <value of string>
           name: <value of string>
           port: <value of integer>
           server-down-option: <value in [block, pass]>

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

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

Ключ	Возвращаемое значение	Описание
request_url строка	всегда	Полный запрашиваемый URL Пример: /sys/login/user
response_code целое число	всегда	Статус запроса API
response_message строка	всегда	Описание ответа API Пример: OK.

Авторы

Link Zheng (@chillancezen)
Jie Xue (@JieX19)
Frank Shen (@fshen01)
Hongbin Lu (@fgtdev-hblu)

© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/fortinet/fortimanager/fmgr_webproxy_forwardserver_module.html