community.general.utm_proxy_location модуль – Создание, обновление или удаление записи расположения обратного прокси-сервера в Sophos UTM

Примечание

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

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

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

Для использования в playbook, укажите: community.general.utm_proxy_location.

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

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

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

Параметры

Параметр	Комментарии
access_control string	Включение контроля доступа для расположения Варианты: `"0"` ← (по умолчанию) `"1"`
allowed_networks list / elements=string	Список разрешенных сетей По умолчанию: `["REF_NetworkAny"]`
auth_profile string	Имя профиля аутентификации По умолчанию: `""`
backend list / elements=string	Список бэкендов, связанных с этим определением местоположения По умолчанию: `[]`
be_path string	Путь к бэкенду По умолчанию: `""`
comment string	Необязательный комментарий По умолчанию: `""`
denied_networks list / elements=string	Список запрещенных сетевых ссылок По умолчанию: `[]`
headers dictionary	Словарь дополнительных заголовков, которые будут отправлены в запросах POST и PUT. Необходим для некоторых модулей. По умолчанию: `{}`
hot_standby boolean	Активировать режим горячего резервирования Варианты: `false` ← (по умолчанию) `true`
name string / required	Имя объекта. Будет использоваться для идентификации записи
path string	Путь к местоположению По умолчанию: `"/"`
state string	Требуемое состояние объекта. `present` создаст или обновит объект. `absent` удалит объект, если он присутствовал. Варианты: `"absent"` `"present"` ← (по умолчанию)
status boolean	Включено ли местоположение или нет Варианты: `false` `true` ← (по умолчанию)
stickysession_id string	Идентификатор stickysession По умолчанию: `"ROUTEID"`
stickysession_status boolean	Включить stickysession Варианты: `false` ← (по умолчанию) `true`
utm_host string / required	REST-точка доступа Sophos UTM.
utm_port integer	Порт REST-интерфейса. По умолчанию: `4444`
utm_protocol string	Протокол REST-точки доступа. Варианты: `"http"` `"https"` ← (по умолчанию)
utm_token string / required	Токен, используемый для идентификации в 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` ← (по умолчанию)
websocket_passthrough boolean	Включить проброс websocket Варианты: `false` ← (по умолчанию) `true`

Атрибуты

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

Примеры

- 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 complex	Объект UTM, который был создан Возвращается: успех
_locked boolean	Заблокирован ли объект в данный момент Возвращается: успех
_ref string	Имя ссылки на объект Возвращается: успех
_type string	Тип объекта Возвращается: успех
access_control string	Использовать ли состояние контроля доступа Возвращается: успех
allowed_networks list / elements=string	Список имён ссылок на разрешённые сети Возвращается: успех
auth_profile string	Имя ссылки на профиль авторизации Возвращается: успех
backend string	Имя ссылки на бэкэнд Возвращается: успех
be_path string	Путь бэкэнда Возвращается: успех
comment string	Строка комментария Возвращается: успех
denied_networks list / elements=string	Список имён запрещённых сетей Возвращается: успех
hot_standby boolean	Использовать горячий резерв Возвращается: успех
name string	Имя объекта Возвращается: успех
path string	Имя пути Возвращается: успех
status boolean	Активен ли объект или нет Возвращается: успех
stickysession_id string	Идентификатор stickysession Возвращается: успех
stickysession_status boolean	Использовать ли stickysession или нет Возвращается: успех
websocket_passthrough boolean	Будет ли использоваться проброс websocket или нет Возвращается: успех

Авторы

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_location_module.html