Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_web_proxy_explicit — настройка параметров явного веб-прокси в 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_explicit.

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

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

Обзор

  • Этот модуль позволяет настраивать устройство FortiGate или FortiOS (FOS), устанавливая и изменяя параметры функции web_proxy и категорию explicit. В примерах приведены все параметры и значения, которые необходимо адаптировать к источникам данных перед использованием. Проверено на 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"

vdom

string

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

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

web_proxy_explicit

dictionary

Настройка параметров явного веб-прокси.

client_cert

string

Включить/отключить запрос сертификата клиента.

Варианты:

  • "disable"
  • "enable"

empty_cert_action

string

Действие при пустом сертификате клиента.

Варианты:

  • "accept"
  • "block"
  • "accept-unmanageable"

ftp_incoming_port

string

Принимать входящие запросы FTP-over-HTTP на одном или нескольких портах (0–65535).

ftp_over_http

string

Включить проксирование сеансов FTP-over-HTTP, отправленных из веб-браузера.

Варианты:

  • "enable"
  • "disable"

http_connection_mode

string

Режим HTTP-соединения.

Варианты:

  • "static"
  • "multiplex"
  • "serverpool"

http_incoming_port

string

Принимать входящие HTTP-запросы на одном или нескольких портах (0–65535).

https_incoming_port

string

Принимать входящие HTTPS-запросы на одном или нескольких портах (0–65535).

https_replacement_message

string

Включить/отключить отправку клиенту сообщения-замены для HTTPS-запросов.

Варианты:

  • "enable"
  • "disable"

incoming_ip

string

Ограничить явный HTTP-прокси, разрешив принимать сеансы только с этого IP-адреса. Этот IP-адрес должен быть назначен интерфейсу.

incoming_ip6

string

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

interface

string

Указать исходящий интерфейс для связи с сервером. Источник: system.interface.name.

interface_select_method

string

Указать способ выбора исходящего интерфейса для связи с сервером.

Варианты:

  • "sdwan"
  • "specify"

ipv6_status

string

Включить/отключить возможность указывать адрес назначения IPv6 веб-прокси в политиках и все связанные с IPv6 записи в этой команде.

Варианты:

  • "enable"
  • "disable"

message_upon_server_error

string

Включить/отключить отображение сообщения-замены при обнаружении ошибки сервера.

Варианты:

  • "enable"
  • "disable"

outgoing_ip

list / elements=string

Исходящие HTTP-запросы будут использовать этот IP-адрес в качестве адреса источника. Этот IP-адрес должен быть назначен интерфейсу.

outgoing_ip6

list / elements=string

Исходящие HTTP-запросы будут отправляться с этого IPv6-адреса. Можно указать несколько интерфейсов. На интерфейсах должны быть настроены эти IPv6-адреса.

pac_file_data

string

Содержимое PAC-файла в кавычках (не более 256 КБ).

pac_file_name

string

Имя PAC-файла.

pac_file_server_port

string

Номер порта, который веб-браузеры клиентов используют для подключения к явному веб-прокси и получения PAC-файла (0–65535).

pac_file_server_status

string

Включить/отключить Proxy Auto-Configuration (PAC) для пользователей этого профиля явного прокси.

Варианты:

  • "enable"
  • "disable"

pac_file_through_https

string

Включить/отключить получение Proxy Auto-Configuration (PAC) через HTTPS.

Варианты:

  • "enable"
  • "disable"

pac_file_url

string

URL для доступа к PAC-файлу.

pac_policy

list / elements=dictionary

Политики PAC.

comments

string

Необязательные комментарии.

dstaddr

list / elements=dictionary

Объекты адресов назначения.

name

string / required

Имя адреса. Источник: firewall.address.name firewall.addrgrp.name.

pac_file_data

string

Содержимое PAC-файла в кавычках (не более 256 КБ).

pac_file_name

string

Имя PAC-файла.

policyid

integer / required

Идентификатор политики. См. <a href=’#notes’>примечания</a>.

srcaddr

list / elements=dictionary

Объекты адресов источника.

name

string / required

Имя адреса. Источник: firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name.

srcaddr6

list / elements=dictionary

Объекты адресов IPv6 источника.

name

string / required

Имя адреса. Источник: firewall.address6.name firewall.addrgrp6.name.

status

string

Включить/отключить политику.

Варианты:

  • "enable"
  • "disable"

pref_dns_result

string

Предпочитать разрешение адресов с помощью настроенного DNS-сервера IPv4 или IPv6.

Варианты:

  • "ipv4"
  • "ipv6"
  • "ipv4-strict"
  • "ipv6-strict"

realm

string

Область аутентификации, используемая для идентификации явного веб-прокси (не более 63 символов).

sec_default_action

string

Разрешать или запрещать сеансы явного веб-прокси, если политика межсетевого экрана для веб-прокси отсутствует.

Варианты:

  • "accept"
  • "deny"

secure_web_proxy

string

Включить/отключить защищенный веб-прокси или сделать его обязательным для сеансов HTTP и HTTPS.

Варианты:

  • "disable"
  • "enable"
  • "secure"

secure_web_proxy_cert

list / elements=dictionary

Имена сертификатов для защищенного веб-прокси.

name

string / required

Список сертификатов. Источник: vpn.certificate.local.name.

socks

string

Включить/отключить прокси SOCKS.

Варианты:

  • "enable"
  • "disable"

socks_incoming_port

string

Принимать входящие запросы прокси SOCKS на одном или нескольких портах (0–65535).

ssl_algorithm

string

Относительная стойкость алгоритмов шифрования, разрешенных при глубокой проверке HTTPS: высокая, средняя или низкая.

Варианты:

  • "high"
  • "medium"
  • "low"

ssl_dh_bits

string

Размер в битах простого числа Диффи — Хеллмана (DH), используемого при согласовании DHE-RSA.

Варианты:

  • "768"
  • "1024"
  • "1536"
  • "2048"

status

string

Включить/отключить явный веб-прокси для сеансов HTTP и HTTPS.

Варианты:

  • "enable"
  • "disable"

strict_guest

string

Включить/отключить строгую проверку гостевых пользователей явным веб-прокси.

Варианты:

  • "enable"
  • "disable"

trace_auth_no_rsp

string

Включить/отключить ведение журнала запросов аутентификации, время ожидания которых истекло.

Варианты:

  • "enable"
  • "disable"

unknown_http_version

string

Способ обработки HTTP-сеансов, не соответствующих требованиям HTTP 0.9, 1.0 или 1.1.

Варианты:

  • "reject"
  • "best-effort"
  • "tunnel"

user_agent_detect

string

Включить/отключить определение типа устройства по HTTP user-agent, если сертификат клиента не предоставлен.

Варианты:

  • "disable"
  • "enable"

vrf_select

integer

Идентификатор VRF, используемый для подключения к серверу.

Примечания

Примечание

  • Устаревшая fortiosapi объявлена нерекомендуемой; предпочтительный способ запуска плейбуков — httpapi
  • Модуль поддерживает check_mode.

Примеры

- name: Configure explicit Web proxy settings.
  fortinet.fortios.fortios_web_proxy_explicit:
      vdom: "{{ vdom }}"
      web_proxy_explicit:
          client_cert: "disable"
          empty_cert_action: "accept"
          ftp_incoming_port: "<your_own_value>"
          ftp_over_http: "enable"
          http_connection_mode: "static"
          http_incoming_port: "<your_own_value>"
          https_incoming_port: "<your_own_value>"
          https_replacement_message: "enable"
          incoming_ip: "<your_own_value>"
          incoming_ip6: "<your_own_value>"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "sdwan"
          ipv6_status: "enable"
          message_upon_server_error: "enable"
          outgoing_ip: "<your_own_value>"
          outgoing_ip6: "<your_own_value>"
          pac_file_data: "<your_own_value>"
          pac_file_name: "<your_own_value>"
          pac_file_server_port: "<your_own_value>"
          pac_file_server_status: "enable"
          pac_file_through_https: "enable"
          pac_file_url: "<your_own_value>"
          pac_policy:
              -
                  comments: "<your_own_value>"
                  dstaddr:
                      -
                          name: "default_name_28 (source firewall.address.name firewall.addrgrp.name)"
                  pac_file_data: "<your_own_value>"
                  pac_file_name: "<your_own_value>"
                  policyid: "<you_own_value>"
                  srcaddr:
                      -
                          name: "default_name_33 (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.proxy-addrgrp.name)"
                  srcaddr6:
                      -
                          name: "default_name_35 (source firewall.address6.name firewall.addrgrp6.name)"
                  status: "enable"
          pref_dns_result: "ipv4"
          realm: "<your_own_value>"
          sec_default_action: "accept"
          secure_web_proxy: "disable"
          secure_web_proxy_cert:
              -
                  name: "default_name_42 (source vpn.certificate.local.name)"
          socks: "enable"
          socks_incoming_port: "<your_own_value>"
          ssl_algorithm: "high"
          ssl_dh_bits: "768"
          status: "enable"
          strict_guest: "enable"
          trace_auth_no_rsp: "enable"
          unknown_http_version: "reject"
          user_agent_detect: "disable"
          vrf_select: "-1"

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

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

Ключ

Описание

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_explicit_module.html

Spec-Zone.ru

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