utm_proxy_auth_profile – создание, обновление или удаление записи reverse_proxy auth_profile в Sophos UTM
Новое в версии 2.8.
Краткое описание
- Создание, обновление или удаление записи reverse_proxy auth_profile в SOPHOS UTM.
- Для этого модуля необходимо активировать REST-возможности UTM.
Параметры
| Параметр | Варианты/Значения по умолчанию | Комментарии |
|---|---|---|
| aaa - / обязательно | Список ссылок на объекты utm_aaa (разрешённые пользователи или группы) | |
| backend_mode - |
| Указывает, требуется ли аутентификация на сервере бэкенда ([Basic|None]) |
| backend_strip_basic_auth boolean |
| Следует ли удалять данные для входа при переадресации запроса на хост бэкенда |
| 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 boolean |
| Разрешить постоянство сеанса |
| frontend_session_lifetime - / обязательно | Срок действия сеанса | |
| frontend_session_lifetime_limited boolean |
| Указывает, активна ли ограничение срока действия сеанса |
| frontend_session_lifetime_scope - |
| Область для frontend_session_lifetime (дни|часы|минуты) |
| frontend_session_timeout - / обязательно | Таймаут сеанса | |
| frontend_session_timeout_enabled boolean |
| Указывает, активен ли таймаут сеанса |
| frontend_session_timeout_scope - |
| Область для frontend_session_timeout (дни|часы|минуты) |
| headers словарь | Словарь дополнительных заголовков, которые нужно отправлять для POST и PUT запросов. Необходим для некоторых модулей | |
| logout_delegation_urls - | По умолчанию: [] | Список URL для делегирования выхода |
| logout_mode - |
| Режим выхода (None|Delegation) |
| name - / обязательно | Имя объекта. Будет использовано для идентификации записи | |
| redirect_to_requested_url boolean |
| Нужно ли перенаправить на запрошенный 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 boolean |
| Подтверждать сертификат SSL REST-интерфейса или нет. |
Примеры
- name: Create UTM proxy_auth_profile
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
utm_proxy_auth_profile:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAuthProfileEntry
state: absent
- name: Read UTM proxy_auth_profile
utm_proxy_auth_profile:
utm_host: sophos.host.name
utm_token: abcdefghijklmno1234
name: TestAuthProfileEntry
state: info
Возвращаемые значения
Общие возвращаемые значения описаны здесь, следующие поля уникальны для этого модуля:
| Ключ | Возвращаемое значение | Описание | |
|---|---|---|---|
| result complex | success | Объект utm, который был создан | |
| _locked boolean | Заблокирован ли объект в данный момент | ||
| _ref string | Имя ссылки объекта | ||
| _type string | Тип объекта | ||
| aaa list | Список ссылок на объекты utm_aaa (разрешенные пользователи или группы) | ||
| backend_mode string | Указывает, требуется ли серверу бэкенда аутентификация ([Basic|None]) | ||
| backend_strip_basic_auth boolean | Нужно ли удалять данные входа при проксировании запроса на хост бэкенда | ||
| backend_user_prefix string | Строка-префикс для добавления к имени пользователя для аутентификации бэкенда | ||
| backend_user_suffix string | Строка-суффикс для добавления к имени пользователя для аутентификации бэкенда | ||
| basic_prompt string | Сообщение в запросе аутентификации basic | ||
| comment string | Дополнительная строка комментария | ||
| frontend_cookie string | Имя фронтенд-куки | ||
| frontend_cookie_secret string | Секрет фронтенд-куки | ||
| frontend_form string | Имя формы аутентификации фронтенда | ||
| frontend_form_template string | Шаблон формы аутентификации фронтенда | ||
| frontend_login string | Имя фронтенд-логина | ||
| frontend_logout string | Имя фронтенд-выхода | ||
| frontend_mode string | Режим аутентификации фронтенда (Форма|Basic) | ||
| frontend_realm string | Сфера фронтенд-аутентификации | ||
| frontend_session_allow_persistency boolean | Разрешить сохранение сессии | ||
| frontend_session_lifetime integer | Срок действия сессии | ||
| frontend_session_lifetime_limited boolean | Указывает, активна ли ограничение срока действия сессии | ||
| frontend_session_lifetime_scope string | область для frontend_session_lifetime (дни|часы|минуты) | ||
| frontend_session_timeout integer | Время ожидания сессии | ||
| frontend_session_timeout_enabled boolean | Указывает, активен ли таймаут сессии | ||
| frontend_session_timeout_scope string | область для frontend_session_timeout (дни|часы|минуты) | ||
| logout_delegation_urls list | Список URL-адресов выхода, к которым делегируется выход | ||
| logout_mode string | Режим выхода (Нет|Делегирование) | ||
| name string | Имя объекта | ||
| redirect_to_requested_url boolean | Перенаправлять ли на запрошенный URL | ||
Статус
- Этот модуль не гарантирует обратную совместимость интерфейса. [превью]
- Этот модуль поддерживается сообществом Ansible. [community]
Авторы
- 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.8/modules/utm_proxy_auth_profile_module.html
