Модуль sensu.sensu_go.user_info – Список пользователей 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_info.

Добавлен в sensu.sensu_go 1.0.0

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

Описание

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

Требования

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

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

См. также

Примеры

- 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. Возвращается: success Пример: `[{"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–2024 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/sensu/sensu_go/user_info_module.html