community.general.revbitspss lookup – Get secrets from RevBits PAM server

Note

This lookup plugin is part of the community.general collection (version 4.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.

To use it in a playbook, specify: community.general.revbitspss.

New in version 4.1.0: of community.general

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.

Parameters

Parameter

Comments

_terms

list / elements=string / required

This will be an array of keys for secrets which you want to fetch from RevBits PAM.

api_key

string / required

This will be the API key for authentication. You can get it from the RevBits PAM secret manager module.

base_url

string / required

This will be the base URL of the server, for example https://server-url-here.

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 Values

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

Key

Description

_list

list / elements=dictionary

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

Authors

  • RevBits (@RevBits)

Hint

Configuration entries for each entry type have a low to high priority order. For example, a variable that is lower in the list will override a variable that is higher up.