community.general.utm_proxy_auth_profile – создание, обновление или удаление записи reverse_proxy auth_profile в Sophos UTM
Примечание
Этот плагин входит в коллекцию community.general (версия 1.3.2).
Для его установки используйте: ansible-galaxy collection install community.general.
Для использования в плейбуке укажите: community.general.utm_proxy_auth_profile.
Описание
- Создаёт, обновляет или удаляет запись reverse_proxy auth_profile в SOPHOS UTM.
- Для работы с этим модулем должна быть активирована REST-функциональность UTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aaa список / элементы=строка / обязательно | Список ссылок на объекты utm_aaa (разрешенные пользователи или группы) | |
| backend_mode строка |
| Указывает, требуется ли авторизация для сервера бэкэнда ([Basic|None]) |
| backend_strip_basic_auth булево |
| Нужно ли удалять данные для входа при переадресации запроса на хост бэкэнда |
| backend_user_prefix строка | Значение по умолчанию: "" | Строка-префикс, добавляемая к имени пользователя для авторизации на бэкенд-сервере |
| backend_user_suffix строка | Значение по умолчанию: "" | Строка-суффикс, добавляемая к имени пользователя для авторизации на бэкенд-сервере |
| basic_prompt строка / обязательно | Сообщение в диалоговом окне проверки подлинности Basic | |
| comment строка | Значение по умолчанию: "" | Дополнительная строка комментария (необязательно) |
| frontend_cookie строка | Имя куки-файла фронтенда | |
| frontend_cookie_secret строка | Секрет куки-файла фронтенда | |
| frontend_form строка | Имя формы авторизации фронтенда | |
| frontend_form_template строка | Значение по умолчанию: "" | Шаблон формы авторизации фронтенда |
| frontend_login строка | Имя элемента входа фронтенда | |
| frontend_logout строка | Имя элемента выхода фронтенда | |
| frontend_mode строка |
| Режим авторизации фронтенда (Форма|Basic) |
| frontend_realm строка | Область авторизации фронтенда | |
| frontend_session_allow_persistency булево |
| Разрешить сохранение сессии |
| frontend_session_lifetime целое число / обязательно | Срок жизни сессии | |
| frontend_session_lifetime_limited булево |
| Указывает, активна ли лимитация срока жизни сессии |
| frontend_session_lifetime_scope строка |
| Диапазон для frontend_session_lifetime (дни|часы|минуты) |
| frontend_session_timeout целое число / обязательно | Таймаут сессии | |
| frontend_session_timeout_enabled булево |
| Указывает, активен ли таймаут сессии |
| frontend_session_timeout_scope строка |
| Диапазон для frontend_session_timeout (дни|часы|минуты) |
| headers словарь | Словарь дополнительных заголовков, отправляемых в POST и PUT запросах. Необходим для некоторых модулей. | |
| logout_delegation_urls список / элементы=строка | Значение по умолчанию: [] | Список URL-адресов завершения сеанса, к которым делегируется выход. |
| logout_mode строка |
| Режим завершения сеанса (None|Делегирование) |
| name строка / обязательно | Имя объекта. Будет использоваться для идентификации записи. | |
| redirect_to_requested_url булево |
| Нужно ли перенаправлять на запрашиваемый URL |
| state строка |
| Желаемое состояние объекта. present создаст или обновит объект.absent удалит объект, если он был present. |
| 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-интерфейса. |
Примеры
- name: Create UTM proxy_auth_profile
community.general.utm_proxy_auth_profile:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAuthProfileEntry
aaa: [REF_OBJECT_STRING,REF_ANOTHEROBJECT_STRING]
basic_prompt: "Authentication required: Please login"
frontend_session_lifetime: 1
frontend_session_timeout: 1
state: present
- name: Remove UTM proxy_auth_profile
community.general.utm_proxy_auth_profile:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAuthProfileEntry
state: absent
- name: Read UTM proxy_auth_profile
community.general.utm_proxy_auth_profile:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAuthProfileEntry
state: info
Возвращаемые значения
Общие возвращаемые значения документированы здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| result complex | success | Созданный объект utm | |
| _locked boolean | success | Заблокирован ли объект в данный момент | |
| _ref string | success | Имя ссылки объекта | |
| _type string | success | Тип объекта | |
| aaa list / elements=string | success | Список ссылок на объекты utm_aaa (разрешённые пользователи или группы) | |
| backend_mode string | success | Указывает, требуется ли серверу бэкенда аутентификация ([Basic|None]) | |
| backend_strip_basic_auth boolean | success | Должны ли данные входа быть удалены при перенаправлении запроса на хост бэкенда | |
| backend_user_prefix string | success | Префиксная строка для добавления к имени пользователя для аутентификации бэкенда | |
| backend_user_suffix string | success | Суффиксная строка для добавления к имени пользователя для аутентификации бэкенда | |
| basic_prompt string | success | Сообщение в окне запроса аутентификации Basic | |
| comment string | success | Дополнительная строка комментария | |
| frontend_cookie string | success | Имя файла cookie фронтенда | |
| frontend_cookie_secret string | success | Секрет файла cookie фронтенда | |
| frontend_form string | success | Имя формы аутентификации фронтенда | |
| frontend_form_template string | success | Шаблон формы аутентификации фронтенда | |
| frontend_login string | success | Имя входа фронтенда | |
| frontend_logout string | success | Имя выхода фронтенда | |
| frontend_mode string | success | Режим аутентификации фронтенда (Форма|Basic) | |
| frontend_realm string | success | Сфера аутентификации фронтенда | |
| frontend_session_allow_persistency boolean | success | Разрешить сохранение сессии | |
| frontend_session_lifetime integer | success | Срок действия сессии | |
| frontend_session_lifetime_limited boolean | success | Указывает, активен ли лимит срока действия сессии | |
| frontend_session_lifetime_scope string | success | Сфера frontend_session_lifetime (дни|часы|минуты) | |
| frontend_session_timeout integer | success | Тайм-аут сессии | |
| frontend_session_timeout_enabled boolean | success | Указывает, активен ли тайм-аут сессии | |
| frontend_session_timeout_scope string | success | Сфера frontend_session_timeout (дни|часы|минуты) | |
| logout_delegation_urls list / elements=string | success | Список URL-адресов выхода, на которые делегируется выход | |
| logout_mode string | success | Режим выхода (None|Делегирование) | |
| name string | success | Название объекта | |
| redirect_to_requested_url boolean | success | Нужно ли перенаправление на запрошенный URL | |
Авторы
- Stephan Schwarz (@stearz)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.10/collections/community/general/utm_proxy_auth_profile_module.html
