ansible.builtin.file – read file 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
file
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 0.9: of ansible.builtin
Parameters
Parameter |
Comments |
---|---|
path(s) of files to read |
|
whether or not to remove whitespace from the beginning of the looked-up file Choices:
|
|
whether or not to remove whitespace from the ending of the looked-up file Choices:
|
Notes
Note
if read in variable context, the file can be interpreted as YAML if the content is valid to the parser.
this lookup does not understand ‘globing’, use the fileglob lookup instead.
Examples
- debug: msg="the value of foo.txt is {{lookup('file', '/etc/foo.txt') }}"
- name: display multiple file contents
debug: var=item
with_file:
- "/path/to/foo.txt"
- "bar.txt" # will be looked in files/ dir relative to play or in role
- "/path/to/biz.txt"
Return Values
Common return values are documented here, the following are the fields unique to this lookup:
Key |
Description |
---|---|
content of file(s) Returned: success |
Authors
Daniel Hokka Zakrisson (!UNKNOWN) <daniel@hozac.com>