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 ansible-base 2.10

Synopsis

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

Terms

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') | string | trim }}"

Return Value

Key

Description

Return value

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.