community.general.to_ini filter – Converts a dictionary to the INI file format
Note
This filter plugin is part of the community.general collection (version 8.6.4).
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.to_ini
.
New in community.general 8.2.0
Synopsis
Converts a dictionary to the INI file format.
Input
This describes the input of the filter, the value before | community.general.to_ini
.
Parameter |
Comments |
---|---|
The dictionary that should be converted to the INI format. |
Examples
- name: Define a dictionary
ansible.builtin.set_fact:
my_dict:
section_name:
key_name: 'key value'
another_section:
connection: 'ssh'
- name: Write dictionary to INI file
ansible.builtin.copy:
dest: /tmp/test.ini
content: '{{ my_dict | community.general.to_ini }}'
# /tmp/test.ini will look like this:
# [section_name]
# key_name = key value
#
# [another_section]
# connection = ssh
Return Value
Key |
Description |
---|---|
A string formatted as INI file. Returned: success |