Модуль sensu.sensu_go.user – Управление пользователями Sensu

Примечание

Этот модуль является частью коллекции sensu.sensu_go (версия 1.14.0).

У вас, возможно, уже установлена эта коллекция, если вы используете пакет ansible. Она не включена в ansible-core. Чтобы проверить установку, выполните ansible-galaxy collection list.

Для установки используйте: ansible-galaxy collection install sensu.sensu_go. Для использования этого модуля необходимы дополнительные требования, см. Требования для подробностей.

Для использования в книге задач укажите: sensu.sensu_go.user.

Введено в sensu.sensu_go 1.0.0

Описание
Требования
Параметры
См. также
Примеры
Значения возврата

Описание

Создать, обновить, активировать или деактивировать пользователя Sensu.
Для получения дополнительной информации обратитесь к документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/reference/rbac/#users.

Требования

Ниже приведены требования, необходимые на хосте, который выполняет этот модуль.

bcrypt (при управлении Sensu Go 5.21.0 или более поздней версии)
python >= 2.7

Параметры

Параметр	Комментарии
auth словарь	Параметры аутентификации. Можно определить каждый из них с помощью переменной окружения.
api_key строка добавлен в sensu.sensu_go 1.3.0	Ключ API, который должен использоваться при аутентификации. Если он не задан, будет проверен значение переменной окружения SENSU_API_KEY. Заменяет параметры auth.user и auth.password. Дополнительную информацию о ключе API см. в официальной документации Sensu по адресу https://docs.sensu.io/sensu-go/latest/guides/use-apikey-feature/.
ca_path путь добавлен в sensu.sensu_go 1.5.0	Путь к файлу сертификатов CA, который должен использоваться для проверки сертификата бэкенда. Если этот параметр не задан, модуль будет использовать сертификаты CA, используемые Python. Также можно задать этот параметр через переменную окружения SENSU_CA_PATH.
password строка	Пароль пользователя Sensu. Если не задан, будет проверено значение переменной окружения SENSU_PASSWORD. Этот параметр игнорируется, если параметр auth.api_key задан. По умолчанию: `"P@ssw0rd!"`
url строка	Местоположение API бэкенда Sensu. Если не задан, будет проверено значение переменной окружения SENSU_URL. По умолчанию: `"http://localhost:8080"`
user строка	Имя пользователя для подключения к API Sensu. Если не задан, будет проверено значение переменной окружения SENSU_USER. Этот параметр игнорируется, если параметр auth.api_key задан. По умолчанию: `"admin"`
verify булево добавлен в sensu.sensu_go 1.5.0	Флаг, контролирующий проверку сертификатов. Если вы используете самозаверяющие сертификаты, вы можете установить этот параметр в значение `false`. Используйте этот параметр ТОЛЬКО в сценариях разработки! Если вы используете самозаверяющие сертификаты в производственной среде, обратитесь к параметру auth.ca_path. Также можно задать этот параметр через переменную окружения SENSU_VERIFY. Варианты: `false` `true` ← (по умолчанию)
groups список / элементы=строка	Список групп, к которым принадлежит пользователь.
name строка / обязательно	Имя ресурса Sensu. Это имя (в сочетании с пространством имен, где применимо) однозначно идентифицирует ресурс, с которым работает Ansible. Если ресурс с указанным именем уже существует, модуль Ansible обновит его в соответствии со спецификацией в задаче. См. спецификацию атрибута метаданных name в документации upstream по адресу https://docs.sensu.io/sensu-go/latest/reference/ для получения дополнительных сведений о допустимых именах и других ограничениях.
password строка	Пароль пользователя. Требуется, если пользователь с желаемым именем еще не существует в бэкенде и password_hash не задан. Если оба параметра password и password_hash заданы, password_hash игнорируется и вычисляется из password, если это необходимо.
password_hash строка добавлен в sensu.sensu_go 1.8.0	Хеш пароля bcrypt для пользователя. Используйте `sensuctl user hash-password PASSWORD` для генерации хеша. Требуется, если пользователь с желаемым именем еще не существует в бэкенде и password не задан. Если оба параметра password и password_hash заданы, password_hash игнорируется и вычисляется из password, если это необходимо. Sensu Go < 5.21.0 не поддерживает создание/обновление пользователей с использованием хешированных паролей. Используйте параметр password, если вам нужно управлять такими установками Sensu Go. В настоящее время обнаружение изменений не работает должным образом при использовании хешей паролей, потому что бэкенд Sensu Go не предоставляет достаточно информации через свой API.
state строка	Желаемое состояние пользователя. Пользователей нельзя фактически удалить, только деактивировать. Варианты: `"enabled"` ← (по умолчанию) `"disabled"`

См. также

sensu.sensu_go.user_info: Список пользователей Sensu.

Примеры

- name: Create a user
  sensu.sensu_go.user:
    auth:
      url: http://localhost:8080
    name: awesome_username
    password: hidden_password?
    groups:
      - dev
      - prod

- name: Use pre-hashed password
  sensu.sensu_go.user:
    auth:
      url: http://localhost:8080
    name: awesome_username
    password_hash: $5f$14$.brXRviMZpbaleSq9kjoUuwm67V/s4IziOLGHjEqxJbzPsreQAyNm

- name: Deactivate a user
  sensu.sensu_go.user:
    name: awesome_username
    state: disabled

Значения возврата

Общие значения возврата документированы здесь, следующие — поля, уникальные для данного модуля:

Ключ	Описание
object словарь	Объект, представляющий пользователя Sensu. Возвращено: успешно Пример: `{"disabled": false, "groups": ["ops", "dev"], "password": "USER_PASSWORD", "password_hash": "$5f$14$.brXRviMZpbaleSq9kjoUuwm67V/s4IziOLGHjEqxJbzPsreQAyNm", "username": "alice"}`

Авторы

Пол Артур (@flowerysong)
Альджаз Косир (@aljazkosir)
Тадей Боровсак (@tadeboro)

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

© 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/sensu/sensu_go/user_module.html