community.hashi_vault.vault_read – Perform a read operation against HashiCorp Vault

• Synopsis
• Requirements
• Parameters
• See Also
• Examples
• Return Values

Synopsis

• Performs a generic read operation against a given path in HashiCorp Vault.

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

See Also

Examples

- name: Read a kv2 secret from Vault via the remote host with userpass auth
  community.hashi_vault.vault_read:
    url: https://vault:8201
    path: secret/data/hello
    auth_method: userpass
    username: user
    password: '{{ passwd }}'
  register: secret

- name: Display the secret data
  ansible.builtin.debug:
    msg: "{{ secret.data.data.data }}"

- name: Retrieve an approle role ID from Vault via the remote host
  community.hashi_vault.vault_read:
    url: https://vault:8201
    path: auth/approle/role/role-name/role-id
  register: approle_id

- name: Display the role ID
  ansible.builtin.debug:
    msg: "{{ approle_id.data.data.role_id }}"

Return Values

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

Authors

• Brian Scholer (@briantist)