Spec-Zone.ru › Ansible

Модуль fortinet.fortios.fortios_web_proxy_forward_server — настройка адресов серверов пересылки в 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_forward_server.

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

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

Обзор

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

dictionary

Настройка адресов серверов пересылки.

addr_type

string

Тип адреса сервера прокси пересылки: IP или FQDN.

Варианты:

  • "ip"
  • "ipv6"
  • "fqdn"

comment

string

Комментарий.

fqdn

string

Полное доменное имя (FQDN) сервера пересылки.

healthcheck

string

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

Варианты:

  • "disable"
  • "enable"

interface

string

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

interface_select_method

string

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

Варианты:

  • "sdwan"
  • "specify"

ip

string

IP-адрес сервера прокси пересылки.

ipv6

string

IPv6-адрес сервера прокси пересылки.

masquerade

string

Включить или отключить использование IP-адреса исходящего интерфейса в качестве IP-адреса клиента.

Варианты:

  • "enable"
  • "disable"

monitor

string

URL для проверки работоспособности сервера пересылки.

name

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

Имя сервера.

password

string

Пароль для HTTP-аутентификации.

port

integer

Номер порта, на котором сервер пересылки ожидает HTTP-сеансы (1–65535).

server_down_option

string

Действие при обнаружении неработающего сервера пересылки: блокировать сеансы до восстановления работы сервера или пропускать сеансы к месту назначения.

Варианты:

  • "block"
  • "pass"

username

string

Имя пользователя для HTTP-аутентификации.

vrf_select

integer

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

Примечания

Примечание

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

Примеры

- name: Configure forward-server addresses.
  fortinet.fortios.fortios_web_proxy_forward_server:
      vdom: "{{ vdom }}"
      state: "present"
      access_token: "<your_own_value>"
      web_proxy_forward_server:
          addr_type: "ip"
          comment: "Comment."
          fqdn: "<your_own_value>"
          healthcheck: "disable"
          interface: "<your_own_value> (source system.interface.name)"
          interface_select_method: "sdwan"
          ip: "<your_own_value>"
          ipv6: "<your_own_value>"
          masquerade: "enable"
          monitor: "<your_own_value>"
          name: "default_name_13"
          password: "<your_own_value>"
          port: "3128"
          server_down_option: "block"
          username: "<your_own_value>"
          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_forward_server_module.html

Spec-Zone.ru

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