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

Примечание

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

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

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

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

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

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

Краткое описание

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

Требования

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

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

Параметры

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

Атрибуты

Атрибут	Поддержка	Описание
check_mode	Поддержка: полная Это действие не изменяет состояние.	Может выполняться в `check_mode` и возвращать прогноз изменения состояния, не изменяя целевой узел.
diff_mode	Поддержка: Н/Д Это действие не изменяет состояние.	В режиме diff возвращает сведения о том, что изменилось (или, возможно, должно быть изменено в `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 string	Строка, содержащая пароль. Возвращается: при успешном выполнении, если пароль существует Пример: `"Password123"`

Авторы

Alexander Hussey (@ahussey-redhat)

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

© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/projects/ansible/latest/collections/community/general/keyring_info_module.html