ansible.builtin.unvault lookup – read vaulted file(s) contents

Note

This lookup plugin is part of ansible-core and included in all Ansible installations. In most cases, you can use the short plugin name unvault even without specifying the collections: keyword. However, we recommend you use the FQCN for easy linking to the plugin documentation and to avoid conflicting with other collections that may have the same lookup plugin name.

New in version 2.10: of ansible.builtin

Synopsis

  • This lookup returns the contents from vaulted (or not) file(s) on the Ansible controller’s file system.

Parameters

Parameter

Comments

_terms

string / required

path(s) of files to read

Notes

Note

  • This lookup does not understand ‘globbing’ nor shell environment variables.

Examples

- ansible.builtin.debug: msg="the value of foo.txt is {{lookup('ansible.builtin.unvault', '/etc/foo.txt')|to_string }}"

Return Values

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

Key

Description

_raw

list / elements=any

content of file(s) as bytes

Returned: success

Authors

  • Ansible Core Team

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.