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

Примечание

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

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

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

Новое в версии 1.0.0: из sensu.sensu_go

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

Описание

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

Требования

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

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.
name строка			Получение информации об этом конкретном объекте вместо перечисления всех объектов.

См. также

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

Примеры

- name: List Sensu users
  sensu.sensu_go.user_info:
  register: result

- name: Retrieve a single Sensu user
  sensu.sensu_go.user_info:
    name: my-user
  register: result

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

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

Ключ	Возвращаемое значение	Описание
objects список / элементы=словарь	успех	Список пользователей Sensu. Пример: [{'disabled': False, 'groups': ['ops', 'dev'], 'password': 'USER_PASSWORD', 'password_hash': '$5f$14$.brXRviMZpbaleSq9kjoUuwm67V/s4IziOLGHjEqxJbzPsreQAyNm', 'username': 'alice'}]

Авторы

Paul Arthur (@flowerysong)
Aljaz Kosir (@aljazkosir)
Miha Plesko (@miha-plesko)
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_info_module.html