community.general.keyring_info module – Get a passphrase using the Operating System’s native keyring
Note
This module is part of the community.general collection (version 8.6.4).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
You need further requirements to be able to use this module,
see Requirements for details.
To use it in a playbook, specify: community.general.keyring_info
.
New in community.general 5.2.0
Synopsis
This module uses the keyring Python library to retrieve passphrases for a given service and username from the OS’ native keyring.
Aliases: system.keyring_info
Requirements
The below requirements are needed on the host that executes this module.
keyring (Python library)
gnome-keyring (application - required for headless Linux keyring access)
dbus-run-session (application - required for headless Linux keyring access)
Parameters
Parameter |
Comments |
---|---|
Password to unlock keyring. |
|
The name of the service. |
|
The user belonging to the service. |
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full This action does not modify state. |
Can run in |
|
Support: N/A This action does not modify state. |
Will return details on what has changed (or possibly needs changing in |
Examples
- 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 }}"
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
A string containing the password. Returned: success and the password exists Sample: |