Try SpotterTweak settings in INI files
Authors: Jan-Piet Mens (@jpmens), Ales Nosek (@noseka1)
Install with ansible-galaxy collection install community.general:==8.5.0
collections:
- name: community.general
version: 8.5.0Manage (add, remove, change) individual settings in an INI-style file without having to manage the file as a whole with, say, M(ansible.builtin.template) or M(ansible.builtin.assemble).
Adds missing sections if they don't exist.
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.
- name: Ensure "fav=lemonade is in section "[drinks]" in specified file
community.general.ini_file:
path: /etc/conf
section: drinks
option: fav
value: lemonade
mode: '0600'
backup: true
- name: Ensure "temperature=cold is in section "[drinks]" in specified file
community.general.ini_file:
path: /etc/anotherconf
section: drinks
option: temperature
value: cold
backup: true
- name: Add "beverage=lemon juice" is in section "[drinks]" in specified file
community.general.ini_file:
path: /etc/conf
section: drinks
option: beverage
value: lemon juice
mode: '0600'
state: present
exclusive: false
- name: Ensure multiple values "beverage=coke" and "beverage=pepsi" are in section "[drinks]" in specified file
community.general.ini_file:
path: /etc/conf
section: drinks
option: beverage
values:
- coke
- pepsi
mode: '0600'
state: present
- name: Add "beverage=lemon juice" outside a section in specified file
community.general.ini_file:
path: /etc/conf
option: beverage
value: lemon juice
state: present
mode:
description:
- The permissions the resulting filesystem object should have.
- For those used to I(/usr/bin/chmod) remember that modes are actually octal numbers.
You must give Ansible enough information to parse them correctly. For consistent
results, quote octal numbers (for example, V('644') or V('1777')) so Ansible receives
a string and can do its own conversion from string into number. Adding a leading
zero (for example, V(0755)) works sometimes, but can fail in loops and some other
circumstances.
- Giving Ansible a number without following either 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, V(u+rwx)
or V(u=rw,g=r,o=r)).
- If O(mode) is not specified and the destination filesystem object B(does not) exist,
the default C(umask) on the system will be used when setting the mode for the newly
created filesystem object.
- If O(mode) is not specified and the destination filesystem object B(does) exist,
the mode of the existing filesystem object will be used.
- Specifying O(mode) is the best way to ensure filesystem objects are created with
the correct permissions. See CVE-2020-1736 for further details.
type: raw
path:
aliases:
- dest
description:
- Path to the INI-style file; this file is created if required.
required: true
type: path
group:
description:
- Name of the group that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current group of the current user unless you
are root, in which case it can preserve the previous ownership.
type: str
owner:
description:
- Name of the user that should own the filesystem object, as would be fed to I(chown).
- When left unspecified, it uses the current user unless you are root, in which case
it can preserve the previous ownership.
- Specifying a numeric username will be assumed to be a user ID and not a username.
Avoid numeric usernames to avoid this confusion.
type: str
state:
choices:
- absent
- present
default: present
description:
- If set to V(absent) and O(exclusive) set to V(true) all matching O(option) lines
are removed.
- If set to V(absent) and O(exclusive) set to V(false) the specified O(option=value)
lines are removed, but the other O(option)s with the same name are not touched.
- If set to V(present) and O(exclusive) set to V(false) the specified O(option=values)
lines are added, but the other O(option)s with the same name are not touched.
- If set to V(present) and O(exclusive) set to V(true) all given O(option=values)
lines will be added and the other O(option)s with the same name are removed.
type: str
value:
description:
- The string value to be associated with an O(option).
- May be omitted when removing an O(option).
- Mutually exclusive with O(values).
- O(value=v) is equivalent to O(values=[v]).
type: str
backup:
default: false
description:
- Create a backup file including the timestamp information so you can get the original
file back if you somehow clobbered it incorrectly.
type: bool
create:
default: true
description:
- If set to V(false), the module will fail if the file does not already exist.
- By default it will create the file if it is missing.
type: bool
follow:
default: false
description:
- This flag indicates that filesystem links, if they exist, should be followed.
- O(follow=true) can modify O(path) when combined with parameters such as O(mode).
type: bool
version_added: 7.1.0
version_added_collection: community.general
option:
description:
- If set (required for changing a O(value)), this is the name of the option.
- May be omitted if adding/removing a whole O(section).
type: str
serole:
description:
- The role part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(role) portion of the policy if available.
type: str
setype:
description:
- The type part of the SELinux filesystem object context.
- When set to V(_default), it will use the C(type) portion of the policy if available.
type: str
seuser:
description:
- The user part of the SELinux filesystem object context.
- By default it uses the V(system) policy, where applicable.
- When set to V(_default), it will use the C(user) portion of the policy if available.
type: str
values:
description:
- The string value to be associated with an O(option).
- May be omitted when removing an O(option).
- Mutually exclusive with O(value).
- O(value=v) is equivalent to O(values=[v]).
elements: str
type: list
version_added: 3.6.0
version_added_collection: community.general
section:
description:
- Section name in INI file. This is added if O(state=present) automatically when a
single value is being set.
- If being omitted, the O(option) will be placed before the first O(section).
- Omitting O(section) is also required if the config format does not support sections.
type: str
selevel:
description:
- The level part of the SELinux filesystem object context.
- This is the MLS/MCS attribute, sometimes known as the C(range).
- When set to V(_default), it will use the C(level) portion of the policy if available.
type: str
exclusive:
default: true
description:
- If set to V(true) (default), all matching O(option) lines are removed when O(state=absent),
or replaced when O(state=present).
- If set to V(false), only the specified O(value)/O(values) are added when O(state=present),
or removed when O(state=absent), and existing ones are not modified.
type: bool
version_added: 3.6.0
version_added_collection: community.general
attributes:
aliases:
- attr
description:
- The attributes the resulting filesystem object should have.
- To get supported flags look at the man page for I(chattr) on the target system.
- This string should contain the attributes in the same order as the one displayed
by I(lsattr).
- The C(=) operator is assumed as default, otherwise C(+) or C(-) operators need to
be included in the string.
type: str
version_added: '2.3'
version_added_collection: ansible.builtin
ignore_spaces:
default: false
description:
- Do not change a line if doing so would only add or remove spaces before or after
the V(=) symbol.
type: bool
version_added: 7.5.0
version_added_collection: community.general
unsafe_writes:
default: false
description:
- Influence when to use atomic operation to prevent data corruption or inconsistent
reads from the target filesystem object.
- By default this module uses atomic operations to prevent data corruption or inconsistent
reads from the target filesystem objects, but sometimes systems are configured or
just broken in ways that prevent this. One example is docker mounted filesystem
objects, 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 filesystem
objects 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.
type: bool
version_added: '2.2'
version_added_collection: ansible.builtin
allow_no_value:
default: false
description:
- Allow option without value and without '=' symbol.
type: bool
no_extra_spaces:
default: false
description:
- Do not insert spaces before and after '=' symbol.
type: bool
modify_inactive_option:
default: true
description:
- By default the module replaces a commented line that matches the given option.
- Set this option to V(false) to avoid this. This is useful when you want to keep
commented example C(key=value) pairs for documentation purposes.
type: bool
version_added: 8.0.0
version_added_collection: community.general