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.
| parameter | required | default | choices | comments |
|---|---|---|---|---|
| backup | no | no |
| Create a backup file including the timestamp information so you can get the original file back if you somehow clobbered it incorrectly. |
| create (added in 2.2)
| no | no |
| If specified, the file will be created if it does not already exist. By default it will fail if the file is missing. |
| dest | yes | Path to the INI-style file; this file is created if required |
||
| group | no | Name of the group that should own the file/directory, as would be fed to chown. |
||
| mode | no | Mode the file or directory should be. For those used to /usr/bin/chmod remember that modes are actually octal numbers (like 0644). Leaving off the leading zero will likely have unexpected results. As of version 1.8, the mode may be specified as a symbolic mode (for example, u+rwx or u=rw,g=r,o=r). |
||
| no_extra_spaces (added in 2.1)
| no | do not insert spaces before and after '=' symbol |
||
| option | no |
if set (required for changing a value), this is the name of the option.
May be omitted if adding/removing a whole section.
|
||
| others | no | all arguments accepted by the file module also work here |
||
| owner | no | Name of the user that should own the file/directory, as would be fed to chown. |
||
| section | yes | Section name in INI file. This is added if state=present automatically when a single value is being set. |
||
| selevel | no | s0 | Level part of the SELinux file context. This is the MLS/MCS attribute, sometimes known as the range. _default feature works as for seuser. |
|
| serole | no | Role part of SELinux file context, _default feature works as for seuser. |
||
| setype | no | Type part of SELinux file context, _default feature works as for seuser. |
||
| seuser | no | User part of SELinux file context. Will default to system policy, if applicable. If set to _default, it will use the user portion of the policy if available. |
||
| state | no | present |
| If set to absent the option or section will be removed if present instead of created. |
| unsafe_writes (added in 2.2)
| no |
Normally this module uses atomic operations to prevent data corruption or inconsistent reads from the target files, sometimes systems are configured or just broken in ways that prevent this. One example are docker mounted files, they cannot be updated atomically and can only be done in an unsafe manner.
This boolean option allows ansible to fall back to unsafe methods of updating files for those cases in which you do not have any other choice. Be aware that this is subject to race conditions and can lead to data corruption.
|
||
| value | no | the string value to be associated with an option. May be omitted when removing an option. |
# Ensure "fav=lemonade is in section "[drinks]" in specified file
- ini_file: dest=/etc/conf section=drinks option=fav value=lemonade mode=0600 backup=yes
- ini_file: dest=/etc/anotherconf
section=drinks
option=temperature
value=cold
backup=yes
Note
While it is possible to add an option without specifying a value, this makes no sense.
Note
A section named default cannot be added by the module, but if it exists, individual options within the section can be updated. (This is a limitation of Python’s ConfigParser.) Either use template to create a base INI file with a [default] section, or use lineinfile to add the missing line.
For more information on what this means please read Core Modules
For help in developing on modules, should you be so inclined, please read Community Information & Contributing, developing_test_pr and Developing Modules.
© 2012–2016 Michael DeHaan
© 2016 Red Hat, Inc.
Licensed under the GNU General Public License version 3.
https://docs.ansible.com/ansible/ini_file_module.html