Spec-Zone.ru › Ansible 2.8

utm_proxy_frontend – создание, обновление или удаление записи reverse_proxy frontend в Sophos UTM

Новая версия 2.8.

  • Описание
  • Параметры
  • Примеры
  • Возвращаемые значения
  • Статус

Описание

  • Создание, обновление или удаление записи reverse_proxy frontend в Sophos UTM.
  • Для работы с этим модулем необходимо активировать REST-возможности UTM.

Параметры

Параметр Варианты/Значения по умолчанию Комментарии
add_content_type_header
логический
    Варианты:
  • нет ←
  • да
Добавлять заголовок типа содержимого или нет
address
-
Значение по умолчанию:
"REF_DefaultInternalAddress"
Идентификатор объекта сети/адреса интерфейса.
allowed_networks
-
Значение по умолчанию:
["REF_NetworkAny"]
Список идентификаторов разрешенных сетей.
certificate
-
Значение по умолчанию:
""
Идентификатор объекта ca/host_key_cert.
comment
-
Значение по умолчанию:
""
Необязательный комментарий к объекту
disable_compression
логический
    Варианты:
  • нет ←
  • да
Включить или выключить сжатие
domain
-
Список доменных имен для объекта frontend
exceptions
-
Значение по умолчанию:
[]
Список идентификаторов исключений (reverse_proxy/exception)
headers
словарь
Словарь дополнительных заголовков для POST и PUT запросов.
Необходим для некоторых модулей
htmlrewrite
логический
    Варианты:
  • нет ←
  • да
Включить или выключить переписывание HTML
htmlrewrite_cookies
логический
    Варианты:
  • нет ←
  • да
Включить или выключить переписывание куки HTML
implicitredirect
логический
    Варианты:
  • нет ←
  • да
Включить или выключить неявное перенаправление
lbmethod
-
    Варианты:
  • по загруженности ←
  • по трафику
  • по запросам
Метод балансировки нагрузки
locations
-
Значение по умолчанию:
[]
Список идентификаторов локаций (reverse_proxy/location)
name
- / обязательно
Имя объекта. Используется для идентификации записи
port
-
Значение по умолчанию:
80
Порт frontend HTTP
preservehost
логический
    Варианты:
  • нет ←
  • да
Сохранять заголовок хоста или нет
profile
-
Значение по умолчанию:
""
Идентификатор профиля reverse_proxy
state
строка
    Варианты:
  • отсутствует
  • присутствует ←
Желаемое состояние объекта.
present создаст или обновит объект
absent удалит объект, если он присутствовал
status
логический
    Варианты:
  • нет
  • да ←
Активировать запись frontend или нет
type
-
    Варианты:
  • http ←
  • https
Какой протокол использовать
utm_host
строка / обязательно
REST-точек доступа Sophos UTM.
utm_port
целое число
Значение по умолчанию:
4444
Порт REST-интерфейса.
utm_protocol
строка
    Варианты:
  • http
  • https ←
Протокол REST-точек доступа.
utm_token
строка / обязательно
Токен, используемый для идентификации в REST-API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, глава 2.4.2.
validate_certs
логический
    Варианты:
  • нет
  • да ←
Проверять SSL-сертификат REST-интерфейса или нет.
xheaders
логический
    Варианты:
  • нет ←
  • да
Передавать заголовок хоста или нет

Примеры

- name: Create utm proxy_frontend
  utm_proxy_frontend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestFrontendEntry
    host: REF_OBJECT_STRING
    state: present

- name: Remove utm proxy_frontend
  utm_proxy_frontend:
    utm_host: sophos.host.name
    utm_token: abcdefghijklmno1234
    name: TestFrontendEntry
    state: absent

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

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

Ключ Возвращаемое значение Описание
result
complex
success
Объект utm, который был создан

_locked
boolean
Блокирован ли объект в настоящее время

_ref
string
Имя ссылки объекта

_type
string
Тип объекта

add_content_type_header
boolean
Добавлять заголовок типа содержимого

address
string
Имя ссылки адреса

allowed_networks
list
Список имён ссылок на связанные сети

certificate
string
Имя ссылки на сертификат (ca/host_key_cert)

comment
string
Строка комментария

disable_compression
boolean
Состояние поддержки сжатия

domain
list
Список имён хостов

exceptions
list
Список связанных исключений прокси

htmlrewrite
boolean
Состояние переписывания HTML

htmlrewrite_cookies
boolean
Устанавливать ли куки для переписывания HTML

implicitredirect
boolean
Использовать неявное перенаправление

lbmethod
string
Метод балансировки нагрузки для использования

locations
list
Имена ссылок на reverse_proxy/locations, связанные с объектом

name
string
Имя объекта

port
integer
Порт подключения фронтального интерфейса

preservehost
boolean
Сохранять заголовок хоста

profile
string
Связанный reverse_proxy/profile

status
boolean
Фронтальный объект активен или нет

type
string
Тип соединения

xheaders
boolean
Состояние xheaders



Статус

  • Данный модуль не гарантирует обратной совместимости интерфейса. [превью]
  • Этот модуль поддерживается сообществом Ansible. [community]

Авторы

  • Johannes Brunswicker (@MatrixCrawler)

Подсказка

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

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/utm_proxy_frontend_module.html

Spec-Zone.ru

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