community.general.revbitspss lookup – Get secrets from RevBits PAM server
Note
This lookup plugin is part of the community.general collection (version 5.8.3).
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 lookup plugin,
see Requirements for details.
To use it in a playbook, specify: community.general.revbitspss
.
New in community.general 4.1.0
Synopsis
Uses the revbits_ansible Python SDK to get Secrets from RevBits PAM Server using API key authentication with the REST API.
Requirements
The below requirements are needed on the local controller node that executes this lookup.
revbits_ansible - https://pypi.org/project/revbits_ansible/
Terms
Parameter |
Comments |
---|---|
This will be an array of keys for secrets which you want to fetch from RevBits PAM. |
Keyword parameters
This describes keyword parameters of the lookup. These are the values key1=value1
, key2=value2
and so on in the following
examples: lookup('community.general.revbitspss', key1=value1, key2=value2, ...)
and query('community.general.revbitspss', key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
This will be the API key for authentication. You can get it from the RevBits PAM secret manager module. |
|
This will be the base URL of the server, for example |
Notes
Note
When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters:
lookup('community.general.revbitspss', term1, term2, key1=value1, key2=value2)
andquery('community.general.revbitspss', term1, term2, key1=value1, key2=value2)
Examples
- hosts: localhost
vars:
secret: >-
{{
lookup(
'community.general.revbitspss',
'UUIDPAM', 'DB_PASS',
base_url='https://server-url-here',
api_key='API_KEY_GOES_HERE'
)
}}
tasks:
- ansible.builtin.debug:
msg: >
UUIDPAM is {{ (secret['UUIDPAM']) }} and DB_PASS is {{ (secret['DB_PASS']) }}
Return Value
Key |
Description |
---|---|
The JSON responses which you can access with defined keys. If you are fetching secrets named as UUID, PASSWORD it will gives you the dict of all secrets. Returned: success |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication