community.general.utm_proxy_location – создание, обновление или удаление записи расположения обратного прокси-сервера в Sophos UTM
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать его в плейбуке, укажите: community.general.utm_proxy_location.
Описание
- Создание, обновление или удаление записи расположения обратного прокси-сервера в SOPHOS UTM.
- Для этого модуля требуется включить REST-возможности UTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| access_control строка |
| включить или выключить контроль доступа для расположения |
| allowed_networks список / элементы=строка | Значение по умолчанию: "REF_NetworkAny" | Список разрешённых сетей |
| auth_profile строка | Имя ссылки профиля авторизации | |
| backend список / элементы=строка | Значение по умолчанию: [] | Список бэкендов, подключённых к этому расположению |
| be_path строка | Путь к бэкенду | |
| comment строка | Дополнительная строка комментария (необязательно) | |
| denied_networks список / элементы=строка | Значение по умолчанию: [] | Список запрещенных ссылок на сети |
| headers словарь | Словарь дополнительных заголовков для отправки в запросах POST и PUT. Необходим для некоторых модулей | |
| hot_standby логическое |
| Включить режим горячего резервирования |
| name строка / обязательно | Имя объекта. Используется для идентификации записи | |
| path строка | Значение по умолчанию: "/" | Путь к расположению |
| state строка |
| Желаемое состояние объекта. present создаст или обновит объектabsent удалит объект, если он присутствовал |
| status логическое |
| Активно ли расположение |
| stickysession_id строка | Значение по умолчанию: "ROUTEID" | Идентификатор stickysession |
| stickysession_status логическое |
| Включить stickysession |
| utm_host строка / обязательно | REST-адрес Sophos UTM | |
| utm_port целое число | Значение по умолчанию: 4444 | Порт REST-интерфейса |
| utm_protocol строка |
| Протокол 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-интерфейса |
| websocket_passthrough логическое |
| Включить проброс веб-сокетов |
Примеры
- name: Create UTM proxy_location
utm_proxy_backend:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestLocationEntry
backend: REF_OBJECT_STRING
state: present
- name: Remove UTM proxy_location
utm_proxy_backend:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestLocationEntry
state: absent
Возвращаемые значения
Общие возвращаемые значения описаны в здесь, следующие поля уникальны для данного модуля:
| Ключ | Возвращаемое | Описание | |
|---|---|---|---|
| result сложный | успех | Созданный объект utm | |
| _locked логическое | успех | Заблокирован ли объект в данный момент | |
| _ref строка | успех | Имя ссылки объекта | |
| _type строка | успех | Тип объекта | |
| access_control строка | успех | Используется ли состояние контроля доступа | |
| allowed_networks список / элементы=строка | успех | Список разрешённых ссылок на сети | |
| auth_profile строка | успех | Имя ссылки на профиль авторизации | |
| backend строка | успех | Имя ссылки на бэкенд | |
| be_path строка | успех | Путь к бэкенду | |
| comment строка | успех | Строка комментария | |
| denied_networks список / элементы=строка | успех | Список имён запрещённых сетей | |
| hot_standby логическое | успех | Использование горячего резервирования | |
| name строка | успех | Имя объекта | |
| path строка | успех | Имя пути | |
| status логическое | успех | Активен ли объект | |
| stickysession_id строка | успех | Идентификатор stickysession | |
| stickysession_status логическое | успех | Использование stickysession | |
| websocket_passthrough логическое | успех | Использование проброса веб-сокетов | |
Авторы
- Johannes Brunswicker (@MatrixCrawler)
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/community/general/utm_proxy_location_module.html
