Модуль fortinet.fortios.fortios_web_proxy_profile — Настройка профилей веб-прокси в FortiOS и FortiGate Fortinet.
Примечание
Этот модуль входит в коллекцию fortinet.fortios (версия 2.3.7).
Эта коллекция, возможно, уже установлена, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования. Подробнее см. Требования.
Чтобы использовать его в playbook, укажите: fortinet.fortios.fortios_web_proxy_profile.
Впервые появился в fortinet.fortios 2.0.0
Описание
- Этот модуль позволяет настроить устройство FortiGate или FortiOS (FOS), позволяя пользователю устанавливать и изменять функцию и категорию профилей web_proxy. Примеры включают все параметры и значения, которые необходимо настроить в источниках данных перед использованием. Тестировалось с FOS v6.0.0
Требования
Ниже перечислены требования к хосту, на котором выполняется этот модуль.
- ansible>=2.15
Параметры
Параметр | Комментарии |
|---|---|
access_token строка | Аутентификация на основе токена. Сгенерировано в графическом интерфейсе Fortigate. |
enable_log булево | Включить/выключить ведение журнала для задачи. Выбооры:
|
member_path строка | Путь к атрибуту члена для обработки. Разделяется символом косой черты, если атрибутов более одного. Параметр, помеченный member_path, допустим для выполнения операции с членами. |
member_state строка | Добавить или удалить члена по указанному пути атрибута. Когда member_state указан, опция состояния игнорируется. Выбооры:
|
state строка / обязательно | Указывает, создавать или удалять объект. Выбооры:
|
vdom строка | Виртуальная область, среди тех, которые определены ранее. VDOM — виртуальная инстанция FortiGate, которая может быть настроена и использована как отдельный блок. По умолчанию: |
web_proxy_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_client_cert строка |
Действие, которое нужно выполнить с заголовком HTTP x-forwarded-client-cert в пересылаемых запросах: пересылать (пропускать), добавлять или удалять заголовок HTTP. Выбооры:
|
|
header_x_forwarded_for строка |
Действие, которое нужно выполнить с заголовком HTTP x-forwarded-for в пересылаемых запросах: пересылать (пропускать), добавлять или удалять заголовок HTTP. Выбооры:
|
|
headers список / элементы=словарь |
Настройка заголовков пересылаемых запросов HTTP. |
|
action строка |
Настройка добавления, удаления или ведения журнала записей заголовков HTTP в запросах и ответах HTTP. Выбооры:
|
|
add_option string |
Настройка параметров для добавления содержимого в существующий HTTP-заголовок или добавление нового HTTP-заголовка. Варианты:
|
|
base64_encoding string |
Включение/выключение использования кодирования base64 содержимого HTTP. Варианты:
|
|
content string |
Содержимое HTTP-заголовка. |
|
dstaddr list / elements=dictionary |
Имена адресов и групп адресов назначения. |
|
name string / обязательно |
Имя адреса. Источник firewall.address.name firewall.addrgrp.name. |
|
dstaddr6 list / elements=dictionary |
Имена адресов и групп адресов назначения (IPv6). |
|
name string / обязательно |
Имя адреса. Источник firewall.address6.name firewall.addrgrp6.name. |
|
id integer / обязательно |
Идентификатор пересылаемого HTTP-заголовка. см. <a href=’#notes’>Примечания</a>. |
|
name string |
Имя пересылаемого HTTP-заголовка. |
|
protocol list / elements=string |
Настройка протокола(ов) для применения действия add-option (HTTP, HTTPS или оба). Варианты:
|
|
log_header_change string |
Включение/выключение регистрации изменений HTTP-заголовков. Варианты:
|
|
name string / обязательно |
Имя профиля. |
|
strip_encoding string |
Включение/выключение удаления неподдерживаемого кодирования из заголовка запроса. Варианты:
|
Примечания
Примечание
- Модуль fortiosapi устарел, httpapi — предпочтительный способ запуска playbooks
- Модуль поддерживает режим проверки (check_mode).
Примеры
- name: Configure web proxy profiles.
fortinet.fortios.fortios_web_proxy_profile:
vdom: "{{ vdom }}"
state: "present"
access_token: "<your_own_value>"
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_client_cert: "pass"
header_x_forwarded_for: "pass"
headers:
-
action: "add-to-request"
add_option: "append"
base64_encoding: "disable"
content: "<your_own_value>"
dstaddr:
-
name: "default_name_17 (source firewall.address.name firewall.addrgrp.name)"
dstaddr6:
-
name: "default_name_19 (source firewall.address6.name firewall.addrgrp6.name)"
id: "20"
name: "default_name_21"
protocol: "https"
log_header_change: "enable"
name: "default_name_24"
strip_encoding: "enable"
Значения возврата
Общие значения возврата документированы здесь, следующие поля уникальны для данного модуля:
Ключ | Описание |
|---|---|
build строка | Номер сборки образа fortigate Возвращается: всегда Пример: |
http_method строка | Последний метод, используемый для подготовки содержимого в FortiGate Возвращается: всегда Пример: |
http_status строка | Последний результат, полученный от FortiGate после последней операции Возвращается: всегда Пример: |
mkey строка | Главный ключ (id), используемый в последнем вызове FortiGate Возвращается: успех Пример: |
name строка | Имя таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
path строка | Путь таблицы, используемой для выполнения запроса Возвращается: всегда Пример: |
revision строка | Внутренний номер ревизии Возвращается: всегда Пример: |
serial строка | Серийный номер устройства Возвращается: всегда Пример: |
status строка | Указание результата операции Возвращается: всегда Пример: |
vdom строка | Используемый виртуальный домен Возвращается: всегда Пример: |
version строка | Версия FortiGate Возвращается: всегда Пример: |
Ссылки на сборку
© 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/fortios/fortios_web_proxy_profile_module.html
