fortios_web_proxy_profile – Настройка профилей веб-прокси в Fortinet’s FortiOS и FortiGate

Новая версия 2.8.

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

Обзор

Этот модуль позволяет настраивать устройства FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию и категорию профилей веб-прокси. Примеры включают все параметры и значения, которые необходимо скорректировать в источниках данных перед использованием. Тестировалось на FOS v6.0.5

Требования

Ниже перечислены требования к хосту, на котором выполняется этот модуль.

fortiosapi>=0.9.8

Параметры

Параметр			Варианты/Значения по умолчанию	Комментарии
host строка				IP-адрес FortiOS или FortiGate.
https логическое значение			Варианты: no yes ←	Указывает, должны ли запросы к FortiGate использовать протокол HTTPS.
password строка			По умолчанию: ""	Пароль FortiOS или FortiGate.
ssl_verify логическое значение добавлен в 2.9			Варианты: no yes ←	Обеспечивает проверку сертификата FortiGate надлежащим центром сертификации.
state строка добавлен в 2.9			Варианты: present absent	Указывает, нужно ли создать или удалить объект. Этот атрибут уже присутствовал в предыдущей версии на более глубоком уровне. Он был перемещён на этот внешний уровень.
username строка				Имя пользователя FortiOS или FortiGate.
vdom строка			По умолчанию: "root"	Виртуальный домен из ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который может быть настроен и использован как отдельный блок.
web_proxy_profile словарь			По умолчанию: null	Настройка профилей веб-прокси.
	header_client_ip строка		Варианты: pass add remove	Действие, которое необходимо выполнить с заголовком HTTP клиентского IP-адреса в пересылаемых запросах: передать (pass), добавить или удалить заголовок HTTP.
	header_front_end_https строка		Варианты: pass add remove	Действие, которое необходимо выполнить с заголовком HTTP front-end-HTTPS в пересылаемых запросах: передать (pass), добавить или удалить заголовок HTTP.
	header_via_request строка		Варианты: pass add remove	Действие, которое необходимо выполнить с заголовком HTTP via в пересылаемых запросах: передать (pass), добавить или удалить заголовок HTTP.
	header_via_response строка		Варианты: pass add remove	Действие, которое необходимо выполнить с заголовком HTTP via в пересылаемых ответах: передать (pass), добавить или удалить заголовок HTTP.
	header_x_authenticated_groups строка		Варианты: pass add remove	Действие, которое необходимо выполнить с заголовком HTTP x-authenticated-groups в пересылаемых запросах: передать (pass), добавить или удалить заголовок HTTP.
	header_x_authenticated_user строка		Варианты: pass add remove	Действие, которое необходимо выполнить с заголовком HTTP x-authenticated-user в пересылаемых запросах: передать (pass), добавить или удалить заголовок HTTP.
	header_x_forwarded_for строка		Варианты: pass add remove	Действие, которое необходимо выполнить с заголовком HTTP x-forwarded-for в пересылаемых запросах: передать (pass), добавить или удалить заголовок HTTP.
	headers список			Настройка заголовков HTTP пересылаемых запросов.
		action строка	Варианты: add-to-request add-to-response remove-from-request remove-from-response	Действие при передаче заголовка HTTP.
		content строка		Содержание заголовка HTTP.
		id целое число / обязательно		Идентификатор пересылаемого заголовка HTTP.
		name строка		Имя пересылаемого заголовка HTTP.
	log_header_change строка		Варианты: enable disable	Включить/выключить ведение журнала изменений заголовков HTTP.
	name строка / обязательно			Имя профиля.
	state строка		Варианты: present absent	Устарело Начиная с Ansible 2.9, рекомендуется использовать параметр 'state' верхнего уровня. Указывает, нужно ли создать или удалить объект.
	strip_encoding строка		Варианты: enable disable	Включить/выключить удаление неподдерживаемого кодирования из заголовка запроса.

Примечания

Примечание

Требуется библиотека fortiosapi, разработанная Fortinet
Выполняется как local_action в вашем плейбуке

Примеры

- hosts: localhost
  vars:
   host: "192.168.122.40"
   username: "admin"
   password: ""
   vdom: "root"
   ssl_verify: "False"
  tasks:
  - name: Configure web proxy profiles.
    fortios_web_proxy_profile:
      host:  "{{ host }}"
      username: "{{ username }}"
      password: "{{ password }}"
      vdom:  "{{ vdom }}"
      https: "False"
      state: "present"
      web_proxy_profile:
        header_client_ip: "pass"
        header_front_end_https: "pass"
        header_via_request: "pass"
        header_via_response: "pass"
        header_x_authenticated_groups: "pass"
        header_x_authenticated_user: "pass"
        header_x_forwarded_for: "pass"
        headers:
         -
            action: "add-to-request"
            content: "<your_own_value>"
            id:  "13"
            name: "default_name_14"
        log_header_change: "enable"
        name: "default_name_16"
        strip_encoding: "enable"

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

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

Ключ	Возвращаемое значение	Описание
build строка	всегда	Номер сборки образа fortigate Пример: 1547
http_method строка	всегда	Последний метод, используемый для предоставления содержимого в FortiGate Пример: PUT
http_status строка	всегда	Последний результат, полученный от FortiGate при последнем примененном действии Пример: 200
mkey строка	успех	Главный ключ (id), используемый в последнем вызове FortiGate Пример: id
name строка	всегда	Имя таблицы, используемой для выполнения запроса Пример: urlfilter
path строка	всегда	Путь к таблице, используемой для выполнения запроса Пример: webfilter
revision строка	всегда	Внутренний номер ревизии Пример: 17.0.2.10658
serial строка	всегда	Серийный номер устройства Пример: FGVMEVYYQT3AB5352
status строка	всегда	Указание результата операции Пример: успех
vdom строка	всегда	Используемый виртуальный домен Пример: root
version строка	всегда	Версия FortiGate Пример: v5.6.3

Статус

Данный модуль не гарантирует обратную совместимость интерфейса. [превью]
Этот модуль поддерживается сообществом Ansible. [community]

Авторы

Miguel Angel Munoz (@mamunozgonzalez)
Nicolas Thomas (@thomnico)

Подсказка

Если вы заметите какие-либо проблемы в этой документации, вы можете отредактировать этот документ, чтобы улучшить его.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.9/modules/fortios_web_proxy_profile_module.html