community.general.read_csv module – Read a CSV file
Note
This module is part of the community.general collection (version 9.4.0).
You might already have this collection installed if you are using the ansible
package.
It is not included in ansible-core
.
To check whether it is installed, run ansible-galaxy collection list
.
To install it, use: ansible-galaxy collection install community.general
.
To use it in a playbook, specify: community.general.read_csv
.
Synopsis
Read a CSV file and return a list or a dictionary, containing one dictionary per row.
Parameters
Parameter |
Comments |
---|---|
A one-character string used to separate fields. When using this parameter, you change the default value used by The default value depends on the dialect used. |
|
The CSV dialect to use when parsing the CSV file. Possible values include Default: |
|
A list of field names for every column. This is needed if the CSV does not have a header. |
|
The column name used as a key for the resulting dictionary. If |
|
The CSV filename to read data from. |
|
Whether to ignore any whitespaces immediately following the delimiter. When using this parameter, you change the default value used by The default value depends on the dialect used. Choices:
|
|
Whether to raise an exception on bad CSV input. When using this parameter, you change the default value used by The default value depends on the dialect used. Choices:
|
|
Attributes
Attribute |
Support |
Description |
---|---|---|
Support: full |
Can run in |
|
Support: none |
Will return details on what has changed (or possibly needs changing in |
See Also
See also
- ansible.builtin.csvfile lookup plugin
Can be used to do selective lookups in CSV files from Jinja.
Examples
# Example CSV file with header
#
# name,uid,gid
# dag,500,500
# jeroen,501,500
# Read a CSV file and access user 'dag'
- name: Read users from CSV file and return a dictionary
community.general.read_csv:
path: users.csv
key: name
register: users
delegate_to: localhost
- ansible.builtin.debug:
msg: 'User {{ users.dict.dag.name }} has UID {{ users.dict.dag.uid }} and GID {{ users.dict.dag.gid }}'
# Read a CSV file and access the first item
- name: Read users from CSV file and return a list
community.general.read_csv:
path: users.csv
register: users
delegate_to: localhost
- ansible.builtin.debug:
msg: 'User {{ users.list.1.name }} has UID {{ users.list.1.uid }} and GID {{ users.list.1.gid }}'
# Example CSV file without header and semi-colon delimiter
#
# dag;500;500
# jeroen;501;500
# Read a CSV file without headers
- name: Read users from CSV file and return a list
community.general.read_csv:
path: users.csv
fieldnames: name,uid,gid
delimiter: ';'
register: users
delegate_to: localhost
Return Values
Common return values are documented here, the following are the fields unique to this module:
Key |
Description |
---|---|
The CSV content as a dictionary. Returned: success Sample: |
|
The CSV content as a list. Returned: success Sample: |