fortinet.fortimanager.fmgr_webproxy_profile — Настройка профилей веб-прокси.
Примечание
Этот плагин входит в состав коллекции fortinet.fortimanager (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install fortinet.fortimanager
Для использования в playbook укажите: fortinet.fortimanager.fmgr_webproxy_profile
Добавлена в версии 2.10: модуля fortinet.fortimanager
Обзор
- Этот модуль позволяет настроить устройство FortiManager.
- Примеры включают все параметры и значения, которые необходимо скорректировать перед использованием, обращаясь к источникам данных.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии | ||
|---|---|---|---|---|
| adom строка / обязательно | параметр (adom) в запрошенном URL | |||
| bypass_validation булево |
| устанавливается в значение True только при расхождениях схемы модуля со структурой API FortiManager. Модуль продолжит выполнение без валидации параметров | ||
| rc_failed список / элементы=строка | список кодов rc, при которых условия завершения работы будут переопределены | |||
| rc_succeeded список / элементы=строка | список кодов rc, при которых условия успешного завершения работы будут переопределены | |||
| state строка / обязательно |
| направление для создания, обновления или удаления объекта | ||
| webproxy_profile словарь | установленные параметры верхнего уровня | |||
| header-client-ip строка |
| Действие с заголовком HTTP client-IP в пересылаемых запросах: пересылка (передать), добавление или удаление заголовка HTTP. | ||
| header-front-end-https строка |
| Действие с заголовком HTTP front-end-HTTPS в пересылаемых запросах: пересылка (передать), добавление или удаление заголовка HTTP. | ||
| header-via-request строка |
| Действие с заголовком HTTP via в пересылаемых запросах: пересылка (передать), добавление или удаление заголовка HTTP. | ||
| header-via-response строка |
| Действие с заголовком HTTP via в пересылаемых ответах: пересылка (передать), добавление или удаление заголовка HTTP. | ||
| header-x-authenticated-groups строка |
| Действие с заголовком HTTP x-authenticated-groups в пересылаемых запросах: пересылка (передать), добавление или удаление заголовка HTTP... | ||
| header-x-authenticated-user строка |
| Действие с заголовком HTTP x-authenticated-user в пересылаемых запросах: пересылка (передать), добавление или удаление заголовка HTTP. | ||
| header-x-forwarded-for строка |
| Действие с заголовком HTTP x-forwarded-for в пересылаемых запросах: пересылка (передать), добавление или удаление заголовка HTTP. | ||
| headers список / элементы=строка | без описания | |||
| action строка |
| Действие при пересылке заголовка HTTP. | ||
| content строка | Содержание заголовков HTTP. | |||
| id целое число | Идентификатор пересылаемого заголовка HTTP. | |||
| name строка | Имя пересылаемого заголовка HTTP. | |||
| log-header-change строка |
| Включить/отключить протоколирование изменений заголовков HTTP. | ||
| name строка | Имя профиля. | |||
| strip-encoding строка |
| Включить/отключить удаление неподдерживаемого кодирования из заголовка запроса. | ||
| workspace_locking_adom строка | Область, которая будет заблокирована для FortiManager, работающего в режиме рабочего пространства, значение может быть глобальным и другими, включая корень. | |||
| 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 web proxy profiles.
fmgr_webproxy_profile:
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_profile:
header-client-ip: <value in [pass, add, remove]>
header-front-end-https: <value in [pass, add, remove]>
header-via-request: <value in [pass, add, remove]>
header-via-response: <value in [pass, add, remove]>
header-x-authenticated-groups: <value in [pass, add, remove]>
header-x-authenticated-user: <value in [pass, add, remove]>
header-x-forwarded-for: <value in [pass, add, remove]>
headers:
-
action: <value in [add-to-request, add-to-response, remove-from-request, ...]>
content: <value of string>
id: <value of integer>
name: <value of string>
log-header-change: <value in [disable, enable]>
name: <value of string>
strip-encoding: <value in [disable, enable]>
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание |
|---|---|---|
| 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_profile_module.html
