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 version 2.0, comments are discarded when the source file is read, and therefore will not show up in the destination file.
- Since version 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 - added in 2.3 |
Attributes the 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.
| |
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 'no', the module will fail if the file does not already exist. By default it will create the file if it is missing. |
group - |
Name of the group that should own the file/directory, as would be fed to chown. | |
mode - |
Mode the file or directory should be. 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 | |
no_extra_spaces boolean added in 2.1 |
|
Do not insert spaces before and after '=' symbol |
option - |
If set (required for changing a value), this is the name of the option. May be omitted if adding/removing a whole section. | |
others - |
All arguments accepted by the file module also work here | |
owner - |
Name of the user that should own the file/directory, as would be fed to chown. | |
path - / required |
Path to the INI-style file; this file is created if required. Before 2.3 this option was only usable as dest.
| |
section - / required |
Section name in INI file. This is added if If left empty or set to `null`, the option will be placed before the first section. Using `null` is also required if the config format does not support sections. | |
selevel - |
Default: "s0" |
Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the |
serole - |
Role part of SELinux file context, | |
setype - |
Type part of SELinux file context, | |
seuser - |
User part of SELinux file context. Will default to system policy, if applicable. If set to | |
state - |
|
If set to |
unsafe_writes boolean added in 2.2 |
|
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 - |
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 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.7/modules/ini_file_module.html