community.hashi_vault.vault_kv2_get lookup – Get a secret from HashiCorp Vault’s KV version 2 secret store
Note
This lookup plugin is part of the community.hashi_vault collection (version 6.2.1).
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.hashi_vault. You need further requirements to be able to use this lookup plugin, see Requirements for details.
To use it in a playbook, specify: community.hashi_vault.vault_kv2_get.
New in community.hashi_vault 2.5.0
Synopsis
- Gets a secret from HashiCorp Vault’s KV version 2 secret store.
Requirements
The below requirements are needed on the local controller node that executes this lookup.
-
hvac(Python library) - For detailed requirements, see the collection requirements page.
Terms
Parameter | Comments |
|---|---|
Terms string / required | Vault KV path(s) to be read. These are relative to the engine_mount_point, so the mount path should not be included. |
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.hashi_vault.vault_kv2_get', key1=value1, key2=value2, ...) and query('community.hashi_vault.vault_kv2_get', key1=value1, key2=value2, ...)
Parameter | Comments |
|---|---|
auth_method string | Authentication method to be used.
Choices:
Configuration:
|
aws_access_key aliases: aws_access_key_id string | The AWS access key to use. Configuration:
|
aws_iam_server_id string added in community.hashi_vault 0.2.0 | If specified, sets the value to use for the Configuration:
|
aws_profile aliases: boto_profile string | The AWS profile Configuration:
|
aws_secret_key aliases: aws_secret_access_key string | The AWS secret key that corresponds to the access key. Configuration:
|
aws_security_token string | The AWS security token if using temporary access and secret keys. Configuration:
|
azure_client_id string added in community.hashi_vault 3.2.0 | The client ID (also known as application ID) of the Azure AD service principal or managed identity. Should be a UUID. If not specified, will use the system assigned managed identity. Configuration:
|
azure_client_secret string added in community.hashi_vault 3.2.0 | The client secret of the Azure AD service principal. Configuration:
|
azure_resource string added in community.hashi_vault 3.2.0 | The resource URL for the application registered in Azure Active Directory. Usually should not be changed from the default. Default: Configuration:
|
azure_tenant_id string added in community.hashi_vault 3.2.0 | The Azure Active Directory Tenant ID (also known as the Directory ID) of the service principal. Should be a UUID. Required when using a service principal to authenticate to Vault, e.g. required when both azure_client_id and azure_client_secret are specified. Optional when using managed identity to authenticate to Vault. Configuration:
|
ca_cert aliases: cacert string | Path to certificate to use for authentication. If not specified by any other means, the Configuration:
|
cert_auth_private_key path added in community.hashi_vault 1.4.0 | For Configuration:
|
cert_auth_public_key path added in community.hashi_vault 1.4.0 | For Configuration:
|
engine_mount_point string | The path where the secret backend is mounted. Default: Configuration:
|
jwt string | The JSON Web Token (JWT) to use for JWT authentication to Vault. Configuration:
|
mount_point string | Vault mount point. If not specified, the default mount point for a given auth method is used. Does not apply to token authentication. Configuration:
|
namespace string | Vault namespace where secrets reside. This option requires HVAC 0.7.0+ and Vault 0.11+. Optionally, this may be achieved by prefixing the authentication mount point and/or secret path with the namespace (e.g If environment variable Configuration:
|
password string | Authentication password. Configuration:
|
proxies any added in community.hashi_vault 1.1.0 | URL(s) to the proxies used to access the Vault service. It can be a string or a dict. If it’s a dict, provide the scheme (eg. If it’s a string, provide a single URL that will be used as the proxy for both A string that can be interpreted as a dictionary will be converted to one (see examples). You can specify a different proxy for HTTP and HTTPS resources. If not specified, environment variables from the Requests library are used. Configuration:
|
region string | The AWS region for which to create the connection. Configuration:
|
retries any added in community.hashi_vault 1.3.0 | Allows for retrying on errors, based on the Retry class in the urllib3 library. This collection defines recommended defaults for retrying connections to Vault. This option can be specified as a positive number (integer) or dictionary. If this option is not specified or the number is A number sets the total number of retries, and uses collection defaults for the other settings. A dictionary value is used directly to initialize the For detailed information on retries, see the collection User Guide. Configuration:
|
retry_action string added in community.hashi_vault 1.3.0 | Controls whether and how to show messages on retries. This has no effect if a request is not retried. Choices:
Configuration:
|
role_id string | Vault Role ID or name. Used in For For Configuration:
|
secret_id string | Secret ID to be used for Vault AppRole authentication. Configuration:
|
timeout integer added in community.hashi_vault 1.3.0 | Sets the connection timeout in seconds. If not set, then the Configuration:
|
token string | Vault token. Token may be specified explicitly, through the listed [env] vars, and also through the If no token is supplied, explicitly or through env, then the plugin will check for a token file, as determined by token_path and token_file. The order of token loading (first found wins) is Configuration:
|
token_file string | If no token is specified, will try to read the token from this file in token_path. Default: Configuration:
|
token_path string | If no token is specified, will try to read the token_file from this path. Configuration:
|
token_validate boolean added in community.hashi_vault 0.2.0 | For token auth, will perform a Disable if your token does not have the Choices:
Configuration:
|
url string | URL to the Vault service. If not specified by any other means, the value of the If Configuration:
|
username string | Authentication user name. Configuration:
|
validate_certs boolean | Controls verification and validation of SSL certificates, mostly you only want to turn off with self signed ones. Will be populated with the inverse of Will default to Choices:
Configuration:
|
version integer | Specifies the version to return. If not set the latest version is returned. |
Note
Configuration entries listed above for each entry type (Ansible variable, environment variable, and so on) 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. The entry types are also ordered by precedence from low to high priority order. For example, an ansible.cfg entry (further up in the list) is overwritten by an Ansible variable (further down in the list).
Notes
Note
- When keyword and positional parameters are used together, positional parameters must be listed before keyword parameters:
lookup('community.hashi_vault.vault_kv2_get', term1, term2, key1=value1, key2=value2)andquery('community.hashi_vault.vault_kv2_get', term1, term2, key1=value1, key2=value2)
See Also
See also
- community.hashi_vault.vault_kv2_get
-
Get a secret from HashiCorp Vault’s KV version 2 secret store.
- community.hashi_vault.vault_kv1_get lookup
-
The official documentation for the
community.hashi_vault.vault_kv1_getlookup plugin. - community.hashi_vault.vault_kv1_get
-
Get a secret from HashiCorp Vault’s KV version 1 secret store.
- community.hashi_vault Lookup Guide
-
Guidance on using lookups in
community.hashi_vault. - KV2 Secrets Engine
-
Documentation for the Vault KV secrets engine, version 2.
Examples
- name: Read a kv2 secret with the default mount point
ansible.builtin.set_fact:
response: "{{ lookup('community.hashi_vault.vault_kv2_get', 'hello', url='https://vault:8201') }}"
# equivalent API path in 3.x.x is kv/data/hello
# equivalent API path in 4.0.0+ is secret/data/hello
- name: Display the results
ansible.builtin.debug:
msg:
- "Secret: {{ response.secret }}"
- "Data: {{ response.data }} (contains secret data & metadata in kv2)"
- "Metadata: {{ response.metadata }}"
- "Full response: {{ response.raw }}"
- "Value of key 'password' in the secret: {{ response.secret.password }}"
- name: Read version 5 of a kv2 secret with a different mount point
ansible.builtin.set_fact:
response: "{{ lookup('community.hashi_vault.vault_kv2_get', 'hello', version=5, engine_mount_point='custom/kv2/mount', url='https://vault:8201') }}"
# equivalent API path is custom/kv2/mount/data/hello
- name: Assert that the version returned is as expected
ansible.builtin.assert:
that:
- response.metadata.version == 5
- name: Perform multiple kv2 reads with a single Vault login, showing the secrets
vars:
paths:
- hello
- my-secret/one
- my-secret/two
ansible.builtin.debug:
msg: "{{ lookup('community.hashi_vault.vault_kv2_get', *paths, auth_method='userpass', username=user, password=pwd)['secret'] }}"
- name: Perform multiple kv2 reads with a single Vault login in a loop
vars:
paths:
- hello
- my-secret/one
- my-secret/two
ansible.builtin.debug:
msg: '{{ item }}'
loop: "{{ query('community.hashi_vault.vault_kv2_get', *paths, auth_method='userpass', username=user, password=pwd) }}"
- name: Perform multiple kv2 reads with a single Vault login in a loop (via with_), display values only
vars:
ansible_hashi_vault_auth_method: userpass
ansible_hashi_vault_username: '{{ user }}'
ansible_hashi_vault_password: '{{ pwd }}'
ansible_hashi_vault_engine_mount_point: special/kv2
ansible.builtin.debug:
msg: '{{ item.values() | list }}'
with_community.hashi_vault.vault_kv2_get:
- hello
- my-secret/one
- my-secret/two
Return Value
Key | Description |
|---|---|
Return value list / elements=dictionary | The result of the read(s) against the given path(s). Returned: success |
|
data dictionary |
The Returned: success Sample: |
|
metadata dictionary |
The Returned: success Sample: |
|
raw dictionary |
The raw result of the read against the given path. Returned: success Sample: |
|
secret dictionary |
The Returned: success Sample: |
Collection links
© 2012–2018 Michael DeHaan
© 2018–2025 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/latest/collections/community/hashi_vault/vault_kv2_get_lookup.html