Модуль community.general.keyring_info – Получение парольной фразы с помощью собственного хранилища ключей операционной системы

Примечание

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

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

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

Чтобы использовать его в книге задач, укажите: community.general.keyring_info.

Добавлена в community.general 5.2.0

Описание
Требования
Параметры
Атрибуты
Примеры
Возвращаемые значения

Описание

Этот модуль использует библиотеку keyring Python для извлечения парольных фраз для заданной службы и пользователя из собственного хранилища ключей ОС.

Требования

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

keyring (Python библиотека)
gnome-keyring (приложение — необходимо для доступа к хранилищу ключей Linux в режиме без графической оболочки)
dbus-run-session (приложение — необходимо для доступа к хранилищу ключей Linux в режиме без графической оболочки)

Параметры

Параметр	Комментарии
keyring_password строка / обязательно	Пароль для разблокировки хранилища ключей.
service строка / обязательно	Имя службы.
username строка / обязательно	Пользователь, принадлежащий к службе.

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может работать в режиме `check_mode` и возвращать прогнозируемое изменение статуса без модификации целевого объекта.
diff_mode	Поддержка: Нет Это действие не изменяет состояние.	Вернет подробности о том, что изменилось (или, возможно, нуждается в изменении в `check_mode`), когда используется режим сравнения.

Примеры

- name: Retrieve password for service_name/user_name
  community.general.keyring_info:
    service: test
    username: test1
    keyring_password: "{{ keyring_password }}"
  register: test_password

- name: Display password
  ansible.builtin.debug:
    msg: "{{ test_password.passphrase }}"

Возвращаемые значения

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

Ключ	Описание
passphrase строка	Строка, содержащая пароль. Возвращается: при успехе и наличии пароля Пример: `"Password123"`

Авторы

Александр Хасси (@ahussey-redhat)

Ссылки на коллекцию

© 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/keyring_info_module.html