Модуль community.general.utm_proxy_auth_profile — создание, обновление или удаление записи reverse_proxy auth_profile в Sophos UTM
Примечание
Этот модуль входит в коллекцию community.general (версия 12.6.1).
Возможно, эта коллекция уже установлена, если вы используете пакет ansible. Она не входит в ansible-core. Чтобы проверить, установлена ли она, выполните ansible-galaxy collection list.
Для установки используйте: ansible-galaxy collection install community.general.
Чтобы использовать коллекцию в плейбуке, укажите: community.general.utm_proxy_auth_profile.
Краткое описание
- Создание, обновление или удаление записи reverse_proxy auth_profile в SOPHOS UTM.
- Для работы этого модуля необходимо активировать REST-интерфейс UTM.
Параметры
Параметр | Комментарии |
|---|---|
aaa list / elements=string / required | Список ссылок на объекты utm_aaa (разрешённые пользователи или группы). |
backend_mode string | Указывает, требуется ли аутентификация на сервере backend ([Basic|None]). Варианты:
|
backend_strip_basic_auth boolean | Следует ли удалять данные для входа при проксировании запроса на хост backend. Варианты:
|
backend_user_prefix string | Строка-префикс, добавляемая к имени пользователя для аутентификации на backend. По умолчанию: |
backend_user_suffix string | Строка-суффикс, добавляемая к имени пользователя для аутентификации на backend. По умолчанию: |
basic_prompt string / required | Сообщение в запросе базовой аутентификации. |
comment string | Необязательный комментарий. По умолчанию: |
frontend_cookie string | Имя cookie frontend. |
frontend_cookie_secret string | Секрет cookie frontend. |
frontend_form string | Имя формы аутентификации frontend. |
frontend_form_template string | Шаблон формы аутентификации frontend. По умолчанию: |
frontend_login string | Имя входа frontend. |
frontend_logout string | Имя выхода frontend. |
frontend_mode string | Режим аутентификации frontend (Form|Basic). Варианты:
|
frontend_realm string | Область аутентификации frontend. |
frontend_session_allow_persistency boolean | Разрешить сохранение сеанса. Варианты:
|
frontend_session_lifetime integer / required | Время жизни сеанса. |
frontend_session_lifetime_limited boolean | Указывает, включено ли ограничение времени жизни сеанса. Варианты:
|
frontend_session_lifetime_scope string | Единица измерения frontend_session_lifetime (days|hours|minutes). Варианты:
|
frontend_session_timeout integer / required | Время ожидания сеанса. |
frontend_session_timeout_enabled boolean | Указывает, включено ли ограничение времени ожидания сеанса. Варианты:
|
frontend_session_timeout_scope string | Единица измерения frontend_session_timeout (days|hours|minutes). Варианты:
|
headers dictionary | Словарь дополнительных заголовков для отправки в запросах POST и PUT. Необходим для некоторых модулей. По умолчанию: |
logout_delegation_urls list / elements=string | Список URL-адресов выхода, на которые делегируются запросы выхода. По умолчанию: |
logout_mode string | Режим выхода (None|Delegation). Варианты:
|
name string / required | Имя объекта, идентифицирующее запись. |
redirect_to_requested_url boolean | Следует ли перенаправлять на запрошенный URL-адрес. Варианты:
|
state string | Требуемое состояние объекта.
Варианты:
|
utm_host string / required | Конечная точка REST Sophos UTM. |
utm_port integer | Порт REST-интерфейса. По умолчанию: |
utm_protocol string | Протокол конечной точки REST. Варианты:
|
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-интерфейса. Варианты:
|
Атрибуты
Атрибут | Поддержка | Описание |
|---|---|---|
check_mode | Поддержка: нет | Может выполняться в режиме |
diff_mode | Поддержка: нет | В режиме diff возвращает сведения об изменениях (или возможных изменениях в |
Примеры
- 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 | Созданный объект utm. Возвращается: при успешном выполнении |
|
_locked boolean |
Заблокирован ли объект в данный момент. Возвращается: при успешном выполнении |
|
_ref string |
Ссылочное имя объекта. Возвращается: при успешном выполнении |
|
_type string |
Тип объекта. Возвращается: при успешном выполнении |
|
aaa list / elements=string |
Список ссылок на объекты utm_aaa (разрешённые пользователи или группы). Возвращается: при успешном выполнении |
|
backend_mode string |
Указывает, требуется ли аутентификация на сервере внутреннего интерфейса ([Basic|None]). Возвращается: при успешном выполнении |
|
backend_strip_basic_auth boolean |
Следует ли удалять данные для входа при передаче запроса прокси-сервером хосту внутреннего интерфейса. Возвращается: при успешном выполнении |
|
backend_user_prefix string |
Строка-префикс, добавляемая перед именем пользователя для аутентификации на сервере внутреннего интерфейса. Возвращается: при успешном выполнении |
|
backend_user_suffix string |
Строка-суффикс, добавляемая после имени пользователя для аутентификации на сервере внутреннего интерфейса. Возвращается: при успешном выполнении |
|
basic_prompt string |
Сообщение в запросе базовой аутентификации. Возвращается: при успешном выполнении |
|
comment string |
Необязательный комментарий. Возвращается: при успешном выполнении |
|
frontend_cookie string |
Имя cookie внешнего интерфейса. Возвращается: при успешном выполнении |
|
frontend_form string |
Имя формы аутентификации внешнего интерфейса. Возвращается: при успешном выполнении |
|
frontend_form_template string |
Шаблон формы аутентификации внешнего интерфейса. Возвращается: при успешном выполнении |
|
frontend_login string |
Имя входа внешнего интерфейса. Возвращается: при успешном выполнении |
|
frontend_logout string |
Имя выхода из системы внешнего интерфейса. Возвращается: при успешном выполнении |
|
frontend_mode string |
Режим аутентификации внешнего интерфейса (Form|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 (days|hours|minutes). Возвращается: при успешном выполнении |
|
frontend_session_timeout integer |
Тайм-аут сеанса. Возвращается: при успешном выполнении |
|
frontend_session_timeout_enabled boolean |
Указывает, активен ли тайм-аут сеанса. Возвращается: при успешном выполнении |
|
frontend_session_timeout_scope string |
Единица измерения для frontend_session_timeout (days|hours|minutes). Возвращается: при успешном выполнении |
|
logout_delegation_urls list / elements=string |
Список URL-адресов выхода из системы, которым делегируется обработка выхода. Возвращается: при успешном выполнении |
|
logout_mode string |
Режим выхода из системы (None|Delegation). Возвращается: при успешном выполнении |
|
name string |
Имя объекта. Возвращается: при успешном выполнении |
|
redirect_to_requested_url boolean |
Следует ли перенаправлять пользователя на запрошенный URL-адрес. Возвращается: при успешном выполнении |
Ссылки на коллекцию
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/utm_proxy_auth_profile_module.html