Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_web_proxy_profile – настройка профилей веб-прокси в Fortinet FortiOS и FortiGate.

Примечание

Этот модуль входит в коллекцию fortinet.fortios (версия 2.5.1).

Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.

Чтобы установить её, используйте: ansible-galaxy collection install fortinet.fortios. Для использования этого модуля необходимы дополнительные требования; подробности см. в разделе Требования.

Чтобы использовать модуль в плейбуке, укажите: fortinet.fortios.fortios_web_proxy_profile.

Добавлено в fortinet.fortios 2.0.0

  • Краткое описание
  • Требования
  • Параметры
  • Примечания
  • Примеры
  • Возвращаемые значения

Краткое описание

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

Требования

На узле, где выполняется этот модуль, необходимы следующие компоненты.

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

string

Аутентификация на основе токена. Токен создаётся в графическом интерфейсе FortiGate.

enable_log

boolean

Включить или отключить ведение журнала для задачи.

Допустимые значения:

  • false ← (по умолчанию)
  • true

member_path

string

Путь к атрибуту элемента, с которым выполняется операция.

Если атрибутов несколько, они разделяются косой чертой.

Параметр member_path можно использовать для операций с элементами.

member_state

string

Добавить или удалить элемент по указанному пути атрибута.

Если задан параметр member_state, параметр state игнорируется.

Допустимые значения:

  • "present"
  • "absent"

state

string / обязательный

Указывает, следует ли создать или удалить объект.

Допустимые значения:

  • "present"
  • "absent"

vdom

string

Виртуальный домен из числа ранее определённых. VDOM — это виртуальный экземпляр FortiGate, который можно настраивать и использовать как отдельное устройство.

По умолчанию: "root"

web_proxy_profile

dictionary

Настройка профилей веб-прокси.

header_client_cert

string

Действие с заголовками HTTP Client-Cert/Client-Cert-Chain в перенаправляемых ответах: передать без изменений, добавить или удалить заголовок HTTP.

Допустимые значения:

  • "pass"
  • "add"
  • "remove"

header_client_ip

string

Действие с заголовком HTTP client-IP в перенаправляемых запросах: передать без изменений, добавить или удалить заголовок HTTP.

Допустимые значения:

  • "pass"
  • "add"
  • "remove"

header_front_end_https

string

Действие с заголовком HTTP front-end-HTTPS в перенаправляемых запросах: передать без изменений, добавить или удалить заголовок HTTP.

Допустимые значения:

  • "pass"
  • "add"
  • "remove"

header_via_request

string

Действие с заголовком HTTP via в перенаправляемых запросах: передать без изменений, добавить или удалить заголовок HTTP.

Допустимые значения:

  • "pass"
  • "add"
  • "remove"

header_via_response

string

Действие с заголовком HTTP via в перенаправляемых ответах: передать без изменений, добавить или удалить заголовок HTTP.

Допустимые значения:

  • "pass"
  • "add"
  • "remove"

header_x_authenticated_groups

string

Действие с заголовком HTTP x-authenticated-groups в перенаправляемых запросах: передать без изменений, добавить или удалить заголовок HTTP.

Допустимые значения:

  • "pass"
  • "add"
  • "remove"

header_x_authenticated_user

string

Действие с заголовком HTTP x-authenticated-user в перенаправляемых запросах: передать без изменений, добавить или удалить заголовок HTTP.

Допустимые значения:

  • "pass"
  • "add"
  • "remove"

header_x_forwarded_client_cert

string

Действие с заголовком HTTP x-forwarded-client-cert в перенаправляемых запросах: передать без изменений, добавить или удалить заголовок HTTP.

Допустимые значения:

  • "pass"
  • "add"
  • "remove"

header_x_forwarded_for

string

Действие с заголовком HTTP x-forwarded-for в перенаправляемых запросах: передать без изменений, добавить или удалить заголовок HTTP.

Допустимые значения:

  • "pass"
  • "add"
  • "remove"

headers

list / elements=dictionary

Настройка заголовков перенаправляемых HTTP-запросов.

action

string

Настройка добавления, удаления или регистрации записи заголовка HTTP в HTTP-запросах и ответах.

Допустимые значения:

  • "add-to-request"
  • "add-to-response"
  • "remove-from-request"
  • "remove-from-response"
  • "monitor-request"
  • "monitor-response"

add_option

string

Настройка параметров добавления содержимого к существующему заголовку HTTP или создания нового заголовка HTTP.

Допустимые значения:

  • "append"
  • "new-on-not-found"
  • "new"
  • "replace"
  • "replace-when-match"

base64_encoding

string

Включить или отключить кодирование содержимого HTTP в формате base64.

Допустимые значения:

  • "disable"
  • "enable"

content

string

Содержимое заголовка HTTP (максимальная длина: 3999 символов).

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 или оба).

Допустимые значения:

  • "https"
  • "http"

log_header_change

string

Включить или отключить регистрацию изменений заголовков HTTP.

Допустимые значения:

  • "enable"
  • "disable"

name

string / обязательный

Имя профиля.

strip_encoding

string

Включить или отключить удаление неподдерживаемого кодирования из заголовка запроса.

Допустимые значения:

  • "enable"
  • "disable"

Примечания

Примечание

  • Устаревшая библиотека fortiosapi объявлена устаревшей; для запуска плейбуков рекомендуется использовать httpapi
  • Модуль поддерживает 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_cert: "pass"
          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_18 (source firewall.address.name firewall.addrgrp.name)"
                  dstaddr6:
                      -
                          name: "default_name_20 (source firewall.address6.name firewall.addrgrp6.name)"
                  id: "21"
                  name: "default_name_22"
                  protocol: "https"
          log_header_change: "enable"
          name: "default_name_25"
          strip_encoding: "enable"

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

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

Ключ

Описание

build

string

Номер сборки образа FortiGate

Возвращается: всегда

Пример: "1547"

http_method

string

Последний метод, использованный для передачи данных на FortiGate

Возвращается: всегда

Пример: "PUT"

http_status

string

Последний результат, возвращённый FortiGate при выполнении последней операции

Возвращается: всегда

Пример: "200"

mkey

string

Главный ключ (идентификатор), использованный при последнем вызове FortiGate

Возвращается: при успешном выполнении

Пример: "id"

name

string

Имя таблицы, использованной для выполнения запроса

Возвращается: всегда

Пример: "urlfilter"

path

string

Путь к таблице, использованной для выполнения запроса

Возвращается: всегда

Пример: "webfilter"

revision

string

Внутренний номер редакции

Возвращается: всегда

Пример: "17.0.2.10658"

serial

string

Серийный номер устройства

Возвращается: всегда

Пример: "FGVMEVYYQT3AB5352"

status

string

Результат выполнения операции

Возвращается: всегда

Пример: "success"

vdom

string

Используемый виртуальный домен

Возвращается: всегда

Пример: "root"

version

string

Версия FortiGate

Возвращается: всегда

Пример: "v5.6.3"

Авторы

  • Link Zheng (@chillancezen)
  • Jie Xue (@JieX19)
  • Hongbin Lu (@fgtdev-hblu)
  • Frank Shen (@frankshen01)
  • Miguel Angel Munoz (@mamunozgonzalez)
  • Nicolas Thomas (@thomnico)

Ссылки на коллекцию

  • Отслеживание проблем
  • Домашняя страница
  • Репозиторий (исходный код)

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/fortinet/fortios/fortios_web_proxy_profile_module.html

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API