Skip to content

file

Collection Note

This module is part of the ansible.builtin collection. To install the collection, use:

ansible-galaxy collection install ansible.builtin
Added in version 0.9.

Synopsis

  • This lookup returns the contents from a file on the Ansible controller's file system.

Parameters

Parameter Defaults / Choices Comments
_terms
required		 path(s) of files to read
lstrip
bool		 whether or not to remove whitespace from the beginning of the looked-up file
rstrip
bool		 Default: True
 whether or not to remove whitespace from the ending of the looked-up file

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 'globbing', use the fileglob lookup instead.

Examples

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

- name: display multiple file contents
  ansible.builtin.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

Key Data Type Description Returned
_raw list content of file(s)

Authors