Documentation

keyring – grab secrets from the OS keyring

New in version 2.3.

Synopsis

  • Allows you to access data stored in the OS provided keyring/keychain.

Requirements

The below requirements are needed on the local master node that executes this lookup.

  • keyring (python library)

Examples

- name : output secrets to screen (BAD IDEA)
  debug:
    msg: "Password: {{item}}"
  with_keyring:
    - 'servicename username'

- name: access mysql with password from keyring
  mysql_db: login_password={{lookup('keyring','mysql joe')}} login_user=joe

Return Values

Common return values are documented here, the following are the fields unique to this lookup:

Key Returned Description
_raw
-
secrets stored



Status

Authors

Hint

If you notice any issues in this documentation you can edit this document to improve it.