community.general.dsv lookup – Get secrets from Thycotic DevOps Secrets Vault
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.dsv
.
New in community.general 1.0.0
Synopsis
Uses the Thycotic DevOps Secrets Vault Python SDK to get Secrets from a DSV tenant using a client_id and client_secret.
Requirements
The below requirements are needed on the local controller node that executes this lookup.
python-dsv-sdk - https://pypi.org/project/python-dsv-sdk/
Terms
Parameter |
Comments |
---|---|
The path to the secret, e.g. |
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.dsv', key1=value1, key2=value2, ...)
and query('community.general.dsv', key1=value1, key2=value2, ...)
Parameter |
Comments |
---|---|
The client_id with which to request the Access Grant. Configuration:
|
|
The client secret associated with the specific client_id. Configuration:
|
|
The first format parameter in the default url_template. Configuration:
|
|
The top-level domain of the tenant; the second format parameter in the default url_template. Default: Configuration:
|
|
The path to prepend to the base URL to form a valid REST API request. Default: Configuration:
|
Notes
Note
When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters:
lookup('community.general.dsv', term1, term2, key1=value1, key2=value2)
andquery('community.general.dsv', term1, term2, key1=value1, key2=value2)
Examples
- hosts: localhost
vars:
secret: "{{ lookup('community.general.dsv', '/test/secret') }}"
tasks:
- ansible.builtin.debug:
msg: 'the password is {{ secret["data"]["password"] }}'
Return Value
Key |
Description |
---|---|
One or more JSON responses to See https://dsv.thycotic.com/api/index.html#operation/getSecret. Returned: success |
Collection links
Issue Tracker Repository (Sources) Submit a bug report Request a feature Communication