salt.modules.ini_manage

Edit ini files

maintainer:<akilesh1597@gmail.com>
maturity:new
depends:re
platform:all

Use section as DEFAULT_IMPLICIT if your ini file does not have any section (for example /etc/sysctl.conf)

salt.modules.ini_manage.get_option(file_name, section, option)

Get value of a key from a section in an ini file. Returns None if no matching key was found.

API Example:

import salt
sc = salt.client.get_local_client()
sc.cmd('target', 'ini.get_option',
       [path_to_ini_file, section_name, option])

CLI Example:

salt '*' ini.get_option /path/to/ini section_name option_name
salt.modules.ini_manage.get_section(file_name, section)

Retrieve a section from an ini file. Returns the section as dictionary. If the section is not found, an empty dictionary is returned.

API Example:

import salt
sc = salt.client.get_local_client()
sc.cmd('target', 'ini.get_section',
       [path_to_ini_file, section_name])

CLI Example:

salt '*' ini.get_section /path/to/ini section_name
salt.modules.ini_manage.remove_option(file_name, section, option)

Remove a key/value pair from a section in an ini file. Returns the value of the removed key, or None if nothing was removed.

API Example:

import salt
sc = salt.client.get_local_client()
sc.cmd('target', 'ini.remove_option',
       [path_to_ini_file, section_name, option])

CLI Example:

salt '*' ini.remove_option /path/to/ini section_name option_name
salt.modules.ini_manage.remove_section(file_name, section)

Remove a section in an ini file. Returns the removed section as dictionary, or None if nothing was removed.

API Example:

import salt
sc = salt.client.get_local_client()
sc.cmd('target', 'ini.remove_section',
       [path_to_ini_file, section_name])

CLI Example:

salt '*' ini.remove_section /path/to/ini section_name
salt.modules.ini_manage.set_option(file_name, sections=None, summary=True)

Edit an ini file, replacing one or more sections. Returns a dictionary containing the changes made.

file_name
path of ini_file
sections : None
A dictionary representing the sections to be edited ini file

Set summary=False if return data need not have previous option value

API Example:

import salt
sc = salt.client.get_local_client()
sc.cmd('target', 'ini.set_option',
       ['path_to_ini_file', '{"section_to_change": {"key": "value"}}'])

CLI Example:

salt '*' ini.set_option /path/to/ini '{section_foo: {key: value}}'