community.hashi_vault.vault_kv2_get module – Get a secret from HashiCorp Vault’s KV version 2 secret store
Note
This module is part of the community.hashi_vault collection (version 6.2.0).
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 module,
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 host that executes this module.
hvac(Python library)For detailed requirements, see the collection requirements page.
Parameters
Parameter |
Comments |
|---|---|
Authentication method to be used.
Choices:
|
|
The AWS access key to use. |
|
If specified, sets the value to use for the |
|
The AWS profile |
|
The AWS secret key that corresponds to the access key. |
|
The AWS security token if using temporary access and secret keys. |
|
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. |
|
The client secret of the Azure AD service principal. |
|
The resource URL for the application registered in Azure Active Directory. Usually should not be changed from the default. Default: |
|
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. |
|
Path to certificate to use for authentication. If not specified by any other means, the |
|
For |
|
For |
|
The path where the secret backend is mounted. Default: |
|
The JSON Web Token (JWT) to use for JWT authentication to Vault. |
|
Vault mount point. If not specified, the default mount point for a given auth method is used. Does not apply to token authentication. |
|
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 |
|
Authentication password. |
|
Vault KV path to be read. This is relative to the engine_mount_point, so the mount path should not be included. For kv2, do not include |
|
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. |
|
The AWS region for which to create the connection. |
|
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. |
|
Controls whether and how to show messages on retries. This has no effect if a request is not retried. Choices:
|
|
Vault Role ID or name. Used in For For |
|
Secret ID to be used for Vault AppRole authentication. |
|
Sets the connection timeout in seconds. If not set, then the |
|
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 |
|
If no token is specified, will try to read the token from this file in token_path. Default: |
|
If no token is specified, will try to read the token_file from this path. |
|
For token auth, will perform a Disable if your token does not have the Choices:
|
|
URL to the Vault service. If not specified by any other means, the value of the If |
|
Authentication user name. |
|
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:
|
|
Specifies the version to return. If not set the latest version is returned. |
Attributes
Attribute |
Support |
Description |
|---|---|---|
Action group: community.hashi_vault.vault |
Use |
|
Support: full This module is “read only” and operates the same regardless of check mode. |
Can run in |
See Also
See also
- community.hashi_vault.vault_kv2_get lookup
The official documentation for the
community.hashi_vault.vault_kv2_getlookup plugin.- community.hashi_vault.vault_kv1_get
Get a secret from HashiCorp Vault’s KV version 1 secret store.
- community.hashi_vault.vault_kv2_write
Perform a write operation against a KVv2 secret in HashiCorp Vault.
- KV2 Secrets Engine
Documentation for the Vault KV secrets engine, version 2.
Examples
- name: Read the latest version of a kv2 secret from Vault via the remote host with userpass auth
community.hashi_vault.vault_kv2_get:
url: https://vault:8201
path: hello
auth_method: userpass
username: user
password: '{{ passwd }}'
register: response
# equivalent API path 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 secret from kv2 with a different mount via the remote host
community.hashi_vault.vault_kv2_get:
url: https://vault:8201
engine_mount_point: custom/kv2/mount
path: hello
version: 5
register: response
# 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
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
|---|---|
The Returned: success Sample: |
|
The Returned: success Sample: |
|
The raw result of the read against the given path. Returned: success Sample: |
|
The Returned: success Sample: |