csvfile - read data from a TSV or CSV file

New in version 1.5.

Synopsis

  • The csvfile lookup reads the contents of a file in CSV (comma-separated value) format. The lookup looks for the row where the first column matches keyname, and returns the value in the second column, unless a different column is specified.

Parameters

Parameter Choices/Defaults Configuration Comments
col Default:
1
column to return (0 index).
default Default:
what to return if the value is not found in the file.
delimiter Default:
TAB
field separator in the file, for a tab you can specify "TAB" or "t".
encoding
(added in 2.1)
 Default:
utf-8
Encoding (character set) of the used CSV file.
file Default:
ansible.csv
name of the CSV/TSV file to open.

Notes

Note

  • The default is for TSV files (tab delimeted) not CSV (comma delimted) ... yes the name is misleading.

Examples

- name:  Match 'Li' on the first column, return the second column (0 based index)
  debug: msg="The atomic number of Lithium is {{ lookup('csvfile', 'Li file=elements.csv delimiter=,') }}"

- name: msg="Match 'Li' on the first column, but return the 3rd column (columns start counting after the match)"
  debug: msg="The atomic mass of Lithium is {{ lookup('csvfile', 'Li file=elements.csv delimiter=, col=2') }}"

Return Values

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

Key Returned Description
_raw
value(s) stored in file column


Status

Author

  • Jan-Piet Mens (@jpmens) <jpmens(at)gmail.com>

Hint

If you notice any issues in this documentation you can edit this document to improve it.

© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.5/plugins/lookup/csvfile.html