ini_file – Tweak settings in INI files
ini_file – Tweak settings in INI files
Synopsis
- Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, template or assemble.
- Adds missing sections if they don’t exist.
- Before Ansible 2.0, comments are discarded when the source file is read, and therefore will not show up in the destination file.
- Since Ansible 2.3, this module adds missing ending newlines to files to keep in line with the POSIX standard, even when no other modifications need to be applied.
Parameters
Parameter | Choices/Defaults | Comments |
---|---|---|
allow_no_value boolean added in 2.6 |
|
Allow option without value and without '=' symbol. |
attributes string added in 2.3 |
The attributes the resulting file or directory should have. To get supported flags look at the man page for chattr on the target system. This string should contain the attributes in the same order as the one displayed by lsattr. The
| |
backup boolean |
|
Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. |
create boolean added in 2.2 |
|
If set to By default it will create the file if it is missing. |
group string |
Name of the group that should own the file/directory, as would be fed to chown. | |
mode string |
The permissions the resulting file or directory should have. For those used to /usr/bin/chmod remember that modes are actually octal numbers. You must either add a leading zero so that Ansible's YAML parser knows it is an octal number (like Giving Ansible a number without following one of these rules will end up with a decimal number which will have unexpected results. As of Ansible 1.8, the mode may be specified as a symbolic mode (for example, | |
no_extra_spaces boolean added in 2.1 |
|
Do not insert spaces before and after '=' symbol. |
option string |
If set (required for changing a value), this is the name of the option. May be omitted if adding/removing a whole section. | |
others string |
All arguments accepted by the file module also work here. | |
owner string |
Name of the user that should own the file/directory, as would be fed to chown. | |
path path / required |
Path to the INI-style file; this file is created if required. Before Ansible 2.3 this option was only usable as dest.
| |
section string / required |
Section name in INI file. This is added if If left empty or set to Using | |
selevel string |
Default: "s0" |
The level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the When set to |
serole string |
The role part of the SELinux file context. When set to | |
setype string |
The type part of the SELinux file context. When set to | |
seuser string |
The user part of the SELinux file context. By default it uses the When set to | |
state string |
|
If set to |
unsafe_writes boolean added in 2.2 |
|
Influence when to use atomic operation to prevent data corruption or inconsistent reads from the target file. By default this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, but sometimes systems are configured or just broken in ways that prevent this. One example is docker mounted files, which cannot be updated atomically from inside the container and can only be written in an unsafe manner. This option allows Ansible to fall back to unsafe methods of updating files when atomic operations fail (however, it doesn't force Ansible to perform unsafe writes). IMPORTANT! Unsafe writes are subject to race conditions and can lead to data corruption. |
value string |
The string value to be associated with an option. May be omitted when removing an option. |
Notes
Note
- While it is possible to add an option without specifying a value, this makes no sense.
- As of Ansible 2.3, the dest option has been changed to path as default, but dest still works as well.
Examples
# Before Ansible 2.3, option 'dest' was used instead of 'path'
- name: Ensure "fav=lemonade is in section "[drinks]" in specified file
ini_file:
path: /etc/conf
section: drinks
option: fav
value: lemonade
mode: '0600'
backup: yes
- name: Ensure "temperature=cold is in section "[drinks]" in specified file
ini_file:
path: /etc/anotherconf
section: drinks
option: temperature
value: cold
backup: yes
Status
- This module is not guaranteed to have a backwards compatible interface. [preview]
- This module is maintained by the Ansible Community. [community]
Authors
- Jan-Piet Mens (@jpmens)
- Ales Nosek (@noseka1)
© 2012–2018 Michael DeHaan
© 2018–2019 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/2.8/modules/ini_file_module.html