ansible.builtin.unvault – read vaulted file(s) contents
ansible.builtin.unvault – read vaulted file(s) contents
Note
This module is part of ansible-base and included in all Ansible installations. In most cases, you can use the short module name unvault even without specifying the collections: keyword. Despite that, we recommend you use the FQCN for easy linking to the module documentation and to avoid conflicting with other collections that may have the same module 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 | Choices/Defaults | Configuration | Comments |
|---|---|---|---|
|
_terms string / required |
path(s) of files to read |
Notes
Note
- This lookup does not understand ‘globbing’ nor shell environment variables.
Examples
- debug: msg="the value of foo.txt is {{lookup('unvault', '/etc/foo.txt')|to_string }}"Return Values
Common return values are documented here, the following are the fields unique to this lookup:
| Key | Returned | Description |
|---|---|---|
|
_raw list / elements=any |
success |
content of file(s) as bytes
|
Authors
- Ansible Core Team
© 2012–2018 Michael DeHaan
© 2018–2021 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.11/collections/ansible/builtin/unvault_lookup.html
