community.general.utm_proxy_auth_profile модуль — Создать, обновить или удалить запись профиля reverse_proxy auth_profile в Sophos UTM

Примечание

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

Возможно, эта коллекция уже установлена, если вы используете пакет 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]) Варианты: `"Basic"` `"None"` ← (default)
backend_strip_basic_auth boolean	Необходимо ли удалять данные входа при проксировании запроса к хосту backend Варианты: `false` `true` ← (default)
backend_user_prefix string	Префиксная строка, добавляемая к имени пользователя для аутентификации backend По умолчанию: `""`
backend_user_suffix string	Суффиксная строка, добавляемая к имени пользователя для аутентификации backend По умолчанию: `""`
basic_prompt string / required	Сообщение в приглашении базовой аутентификации
comment string	Необязательная строка комментария По умолчанию: `""`
frontend_cookie string	Имя файла cookie интерфейса
frontend_cookie_secret string	Секрет файла cookie интерфейса
frontend_form string	Имя формы аутентификации интерфейса
frontend_form_template string	Шаблон формы аутентификации интерфейса По умолчанию: `""`
frontend_login string	Имя входа в интерфейс
frontend_logout string	Имя выхода из интерфейса
frontend_mode string	Режим аутентификации интерфейса (Form\|Basic) Варианты: `"Basic"` ← (default) `"Form"`
frontend_realm string	Сфера аутентификации интерфейса
frontend_session_allow_persistency boolean	Разрешить сохранение сессии Варианты: `false` ← (default) `true`
frontend_session_lifetime integer / required	Время жизни сессии
frontend_session_lifetime_limited boolean	Указывает, активно ли ограничение времени жизни сессии Варианты: `false` `true` ← (default)
frontend_session_lifetime_scope string	Область действия для frontend_session_lifetime (days\|hours\|minutes) Варианты: `"days"` `"hours"` ← (default) `"minutes"`
frontend_session_timeout integer / required	Таймаут сессии
frontend_session_timeout_enabled boolean	Указывает, активен ли таймаут сессии Варианты: `false` `true` ← (default)

frontend_session_timeout_scope string	область действия для frontend_session_timeout (дни\|часы\|минуты) Варианты: `"days"` `"hours"` `"minutes"` ← (по умолчанию)
headers словарь	Словарь дополнительных заголовков, которые будут отправлены в запросах POST и PUT. Необходим для некоторых модулей. По умолчанию: `{}`
logout_delegation_urls список / элементы=строка	Список URL-адресов выхода, на которые делегируется выход. По умолчанию: `[]`
logout_mode строка	Режим выхода (None\|Делегирование) Варианты: `"None"` ← (по умолчанию) `"Delegation"`
name строка / обязательно	Имя объекта. Будет использовано для идентификации записи
redirect_to_requested_url булево	Нужно ли перенаправлять на запрашиваемый URL Варианты: `false` ← (по умолчанию) `true`
state строка	Желаемое состояние объекта. `present` будет создавать или обновлять объект. `absent` будет удалять объект, если он был. Варианты: `"absent"` `"present"` ← (по умолчанию)
utm_host строка / обязательно	REST-точка входа Sophos UTM.
utm_port целое число	Порт REST-интерфейса. По умолчанию: `4444`
utm_protocol строка	Протокол REST-точки входа. Варианты: `"http"` `"https"` ← (по умолчанию)
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-интерфейса. Варианты: `false` `true` ← (по умолчанию)

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: отсутствует	Может работать в режиме `check_mode` и возвращать прогноз изменения состояния без изменения целевого объекта.
diff_mode	Поддержка: отсутствует	Вернёт информацию о том, что изменилось (или, возможно, требует изменения в `check_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, который был создан Возвращается: success
_locked boolean	Заблокирован ли объект в данный момент Возвращается: success
_ref string	Имя ссылки на объект Возвращается: success
_type string	Тип объекта Возвращается: success
aaa list / elements=string	Список ссылок на объекты utm_aaa (разрешённые пользователи или группы) Возвращается: success
backend_mode string	Указывает, требуется ли серверу бэкенда аутентификация ([Basic\|None]) Возвращается: success
backend_strip_basic_auth boolean	Следует ли удалять данные входа при проксировании запроса к хосту бэкенда Возвращается: success
backend_user_prefix string	Префиксная строка для добавления перед именем пользователя для аутентификации бэкенда Возвращается: success
backend_user_suffix string	Суффиксная строка для добавления после имени пользователя для аутентификации бэкенда Возвращается: success
basic_prompt string	Сообщение в запросе базовой аутентификации Возвращается: success
comment string	Необязательная строка комментария Возвращается: success
frontend_cookie string	Имя файла cookie интерфейса Возвращается: success
frontend_form string	Имя формы аутентификации интерфейса Возвращается: success
frontend_form_template string	Шаблон формы аутентификации интерфейса Возвращается: success
frontend_login string	Имя входа в интерфейс Возвращается: success
frontend_logout string	Имя выхода из интерфейса Возвращается: success
frontend_mode string	Режим аутентификации интерфейса (Form\|Basic) Возвращается: success
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	диапазон для frontend_session_lifetime (дни\|часы\|минуты) Возвращаемое значение: success
frontend_session_timeout integer	тайм-аут сессии Возвращаемое значение: success
frontend_session_timeout_enabled boolean	Указывает, активен ли тайм-аут сессии Возвращаемое значение: success
frontend_session_timeout_scope string	диапазон для frontend_session_timeout (дни\|часы\|минуты) Возвращаемое значение: success
logout_delegation_urls list / elements=string	Список URL-адресов завершения сессии, на которые делегируются выхода Возвращаемое значение: success
logout_mode string	Режим выхода (None\|Delegation) Возвращаемое значение: success
name string	Имя объекта Возвращаемое значение: success
redirect_to_requested_url boolean	Необходимо ли перенаправление на запрашиваемый URL Возвращаемое значение: success

Авторы

Stephan Schwarz (@stearz)

Ссылки на сборку

© 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_auth_profile_module.html