community.general.utm_proxy_auth_profile – создание, обновление или удаление записи reverse_proxy auth_profile в Sophos UTM
Примечание
Этот плагин входит в коллекцию community.general (версия 2.0.1).
Для его установки используйте: 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_timeout целое число / обязательно | Время ожидания сессии | |
| frontend_session_timeout_enabled логическое |
| Указывает, активен ли таймаут сессии |
| frontend_session_timeout_scope строка |
| Диапазон времени ожидания сессии (дни|часы|минуты) |
| headers словарь | Словарь дополнительных заголовков, которые будут отправлены в POST- и PUT-запросах. Необходим для некоторых модулей | |
| logout_delegation_urls список / элементы=строка | Значение по умолчанию: [] | Список URL-адресов выхода, на которые делегируется выход |
| logout_mode строка |
| Режим выхода (None|Делегирование) |
| name строка / обязательно | Имя объекта. Будет использоваться для идентификации записи | |
| redirect_to_requested_url логическое |
| Нужно ли перенаправлять на запрашиваемый URL? |
| state строка |
| Желаемое состояние объекта. present создаст или обновит объектabsent удалит объект, если он был присутствовал |
| 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_form string | success | Имя формы аутентификации фронта | |
| frontend_form_template string | success | Шаблон формы аутентификации фронта | |
| frontend_login string | success | Имя входа фронта | |
| frontend_logout string | success | Имя выхода фронта | |
| frontend_mode string | success | Режим аутентификации фронта (Form|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 (days|hours|minutes) | |
| frontend_session_timeout integer | success | Тайм-аут сессии | |
| frontend_session_timeout_enabled boolean | success | Указывает, активен ли тайм-аут сессии | |
| frontend_session_timeout_scope string | success | область для frontend_session_timeout (days|hours|minutes) | |
| 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–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_auth_profile_module.html
