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

Примечание

Этот плагин входит в коллекцию sensu.sensu_go (версия 1.8.0).

Для его установки используйте: ansible-galaxy collection install sensu.sensu_go.

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

Новый в версии 1.0.0: of sensu.sensu_go

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

Обзор

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

Требования

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

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

Параметры

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

См. также

sensu.sensu_go.user_info: Официальная документация модуля sensu.sensu_go.user_info.

Примеры

- 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'}

Авторы

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Tadej Borovsak (@tadeboro)

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