community.general.utm_proxy_frontend модуль — Создание, обновление или удаление записи обратного прокси-фронта в Sophos UTM

Примечание

Этот модуль является частью коллекции community.general (версия 9.5.0).

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

Для установки используйте: ansible-galaxy collection install community.general.

Чтобы использовать его в плейбуке, укажите: community.general.utm_proxy_frontend.

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

Обзор

Создание, обновление или удаление записи обратного прокси-фронта в Sophos UTM.
Данному модулю необходимо активировать REST-возможности UTM.

Параметры

Параметр	Комментарии
add_content_type_header boolean	Добавлять ли заголовок типа контента или нет Варианты: `false` ← (default) `true`
address string	Имя ссылки на объект network/interface_address. По умолчанию: `"REF_DefaultInternalAddress"`
allowed_networks list / elements=string	Список имён ссылок на разрешённые сети. По умолчанию: `["REF_NetworkAny"]`
certificate string	Имя ссылки на объект ca/host_key_cert. По умолчанию: `""`
comment string	Необязательный комментарий для добавления к объекту По умолчанию: `""`
disable_compression boolean	Включать ли сжатие Варианты: `false` ← (default) `true`
domain list / elements=string	Список доменных имён для объекта frontend
exceptions list / elements=string	Список имён ссылок на исключения (reverse_proxy/exception) По умолчанию: `[]`
headers dictionary	Словарь дополнительных заголовков, которые будут отправлены в запросах POST и PUT. Необходим для некоторых модулей. По умолчанию: `{}`
htmlrewrite boolean	Включать ли переписывание html или нет Варианты: `false` ← (default) `true`
htmlrewrite_cookies boolean	Включать ли переписывание cookie html или нет Варианты: `false` ← (default) `true`
implicitredirect boolean	Включать ли неявное перенаправление или нет Варианты: `false` ← (default) `true`
lbmethod string	Какой метод балансировщика нагрузки следует использовать Варианты: `""` `"bybusyness"` ← (default) `"bytraffic"` `"byrequests"`
locations list / elements=string	Список имён ссылок на местоположения (reverse_proxy/location) По умолчанию: `[]`
name string / required	Имя объекта. Будет использоваться для идентификации записи
port integer	HTTP-порт frontend По умолчанию: `80`
preservehost boolean	Сохранять ли заголовок host Варианты: `false` ← (default) `true`
profile string	Строка ссылки на reverse_proxy/profile По умолчанию: `""`
state string	Требуемое состояние объекта. `present` создаст или обновит объект. `absent` удалит объект, если он присутствовал. Варианты: `"absent"` `"present"` ← (default)

status boolean	Включить или отключить вход в интерфейс frontend Варианты: `false` `true` ← (по умолчанию)
type string	Протокол, который нужно использовать Варианты: `"http"` ← (по умолчанию) `"https"`
utm_host string / обязательно	REST-интерфейс Sophos UTM.
utm_port integer	Порт REST-интерфейса. По умолчанию: `4444`
utm_protocol string	Протокол REST-интерфейса. Варианты: `"http"` `"https"` ← (по умолчанию)
utm_token string / обязательно	Токен, используемый для идентификации в REST-API. См. https://www.sophos.com/en-us/medialibrary/PDFs/documentation/UTMonAWS/Sophos-UTM-RESTful-API.pdf?la=en, раздел 2.4.2.
validate_certs boolean	Верифицировать сертификат SSL REST-интерфейса. Варианты: `false` `true` ← (по умолчанию)
xheaders boolean	Передавать заголовок хоста Варианты: `false` ← (по умолчанию) `true`

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: нет	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без модификации целевого объекта.
diff_mode	Поддержка: нет	В режиме сравнения вернёт подробную информацию о внесённых изменениях (или, возможно, о необходимых изменениях в `check_mode`).

Примеры

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

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

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

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

Ключ	Описание
result complex	Созданный объект UTM Возвращено: success
_locked boolean	Заблокирован ли объект в данный момент Возвращено: success
_ref string	Имя ссылки на объект Возвращено: success
_type string	Тип объекта Возвращено: success
add_content_type_header boolean	Добавлять ли заголовок типа контента Возвращено: success
address string	Имя ссылки на адрес Возвращено: success
allowed_networks list / elements=string	Список имён ссылок на связанные сети Возвращено: success
certificate string	Имя ссылки на сертификат (ca/host_key_cert) Возвращено: success
comment string	Строка комментария Возвращено: success
disable_compression boolean	Состояние поддержки сжатия Возвращено: success
domain list / elements=string	Список имён хостов Возвращено: success
exceptions list / elements=string	Список связанных исключений прокси Возвращено: success
htmlrewrite boolean	Состояние переписывания HTML Возвращено: success
htmlrewrite_cookies boolean	Будет ли установлен куки переписывания HTML Возвращено: success
implicitredirect boolean	Использовать ли неявное перенаправление Возвращено: success
lbmethod string	Метод балансировщика нагрузки для использования Возвращено: success
locations list / elements=string	Имена ссылок на reverse_proxy/locations, связанные с объектом Возвращено: success
name string	Имя объекта Возвращено: success
port integer	Порт соединения frontend Возвращено: success
preservehost boolean	Сохранять заголовок хоста Возвращено: success
profile string	Связанный reverse_proxy/profile Возвращено: success
status boolean	Активен ли объект frontend или нет Возвращено: success

тип строка	Тип соединения Возвращено: success
xheaders логическое	Состояние xheaders Возвращено: success

Авторы

Johannes Brunswicker (@MatrixCrawler)

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

© 2012–2018 Michael DeHaan
© 2018–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/general/utm_proxy_frontend_module.html