Spec-Zone.ru › Ansible

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

Примечание

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

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

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

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

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

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

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

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

Требования

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

  • ansible>=2.16

Параметры

Параметр

Комментарии

access_token

строка

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

enable_log

логическое значение

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

Возможные значения:

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

firewall_proxy_address

словарь

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

application

список / элементы=словарь

Приложение SaaS.

name

строка / обязательный

Название приложения SaaS.

case_sensitivity

строка

Включить учет регистра в шаблоне.

Возможные значения:

  • "disable"
  • "enable"

category

список / элементы=словарь

Идентификатор категории FortiGuard.

id

целое число / обязательный

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

color

целое число

Целое число, задающее цвет значка в графическом интерфейсе (1–32).

comment

строка

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

header

строка

Имя HTTP-заголовка в виде регулярного выражения.

header_group

список / элементы=словарь

Группа HTTP-заголовков.

case_sensitivity

строка

Учет регистра в шаблоне.

Возможные значения:

  • "disable"
  • "enable"

header

строка

Регулярное выражение для HTTP-заголовка.

header_name

строка

HTTP-заголовок.

id

целое число / обязательный

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

header_name

строка

Имя HTTP-заголовка.

host

строка

Объект адреса для узла. Источник: firewall.address.name, firewall.addrgrp.name, firewall.proxy-address.name, firewall.vipgrp.name, firewall.vip.name.

host_regex

строка

Имя узла в виде регулярного выражения.

method

список / элементы=строка

Используемые методы HTTP-запросов.

Возможные значения:

  • "get"
  • "post"
  • "put"
  • "head"
  • "connect"
  • "trace"
  • "options"
  • "delete"
  • "update"
  • "patch"
  • "other"

name

строка / обязательный

Имя адреса.

path

строка

Путь URL в виде регулярного выражения.

query

строка

Сопоставить часть URL с параметрами запроса как регулярное выражение.

referrer

строка

Включить или отключить использование поля referrer в HTTP-заголовке для сопоставления адреса.

Возможные значения:

  • "enable"
  • "disable"

tagging

список / элементы=словарь

Присвоение тегов объекту конфигурации.

category

строка

Категория тега. Источник: system.object-tagging.category.

name

строка / обязательный

Имя записи тега.

tags

список / элементы=словарь

Теги.

name

строка / обязательный

Имя тега. Источник: system.object-tagging.tags.name.

type

строка

Тип адреса прокси.

Возможные значения:

  • "host-regex"
  • "url"
  • "category"
  • "method"
  • "ua"
  • "header"
  • "src-advanced"
  • "dst-advanced"
  • "saas"

ua

список / элементы=строка

Названия браузеров, используемые в качестве user agent.

Возможные значения:

  • "chrome"
  • "ms"
  • "firefox"
  • "safari"
  • "ie"
  • "edge"
  • "other"

ua_max_ver

строка

Максимальная версия user agent, заданная в точечной нотации. Например, укажите 120 и задайте для поля ua значение «chrome», чтобы требовать максимальную версию Google Chrome не выше 120.

ua_min_ver

строка

Минимальная версия user agent, заданная в точечной нотации. Например, укажите 90.0.1 и задайте для поля ua значение «chrome», чтобы требовать минимальную версию Google Chrome не ниже 90.0.1.

uuid

строка

Универсальный уникальный идентификатор (UUID; назначается автоматически, но может быть сброшен вручную).

visibility

строка

Включить или отключить отображение объекта в графическом интерфейсе.

Возможные значения:

  • "enable"
  • "disable"

member_path

строка

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

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

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

member_state

строка

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

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

Возможные значения:

  • "present"
  • "absent"

state

строка / обязательный

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

Возможные значения:

  • "present"
  • "absent"

vdom

строка

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

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

Примечания

Примечание

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

Примеры

- name: Configure web proxy address.
  fortinet.fortios.fortios_firewall_proxy_address:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      firewall_proxy_address:
          application:
              -
                  name: "default_name_4"
          case_sensitivity: "disable"
          category:
              -
                  id: "7"
          color: "0"
          comment: "Optional comments."
          header: "<your_own_value>"
          header_group:
              -
                  case_sensitivity: "disable"
                  header: "<your_own_value>"
                  header_name: "<your_own_value>"
                  id: "15"
          header_name: "<your_own_value>"
          host: "myhostname (source firewall.address.name firewall.addrgrp.name firewall.proxy-address.name firewall.vipgrp.name firewall.vip.name)"
          host_regex: "myhostname"
          method: "get"
          name: "default_name_20"
          path: "<your_own_value>"
          query: "<your_own_value>"
          referrer: "enable"
          tagging:
              -
                  category: "<your_own_value> (source system.object-tagging.category)"
                  name: "default_name_26"
                  tags:
                      -
                          name: "default_name_28 (source system.object-tagging.tags.name)"
          type: "host-regex"
          ua: "chrome"
          ua_max_ver: "<your_own_value>"
          ua_min_ver: "<your_own_value>"
          uuid: "<your_own_value>"
          visibility: "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_firewall_proxy_address_module.html

Spec-Zone.ru

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