Resource types
ini_setting: ini_settings is used to manage a single setting in an INI fileini_subsetting: ini_subsettings is used to manage multiple values in a setting in an INI file
Functions
create_ini_settings: create_resources is used to create a set of ini_setting resources from a hash
ini_settings is used to manage a single setting in an INI file
The following properties are available in the ini_setting type.
Valid values: present, absent
Ensurable method handles modeling creation. It creates an ensure property
Default value: present
The value of the setting to be defined.
The following parameters are available in the ini_setting type.
namevar
An arbitrary name used as the identity of the resource.
The name of the section in the ini file in which the setting should be defined.
Default value: ''
The name of the setting to be defined.
Valid values: true, false, yes, no
Create setting only if the section exists
Default value: true
The ini file Puppet will ensure contains the specified setting.
Valid values: true, md5, false
Whether to display differences when the setting changes.
Default value: true
The separator string to use between each setting name and value.
Default value: =
The prefix to the section name's header.
Default value: [
The suffix to the section name's header.
Default value: ]
The character to indent new settings with.
Default value:
The number of indent_chars to use to indent a new setting.
Valid values: true, false, yes, no
A flag indicating whether or not the ini_setting should be updated only when called as part of a refresh event
Default value: false
ini_subsettings is used to manage multiple values in a setting in an INI file
The following properties are available in the ini_subsetting type.
Valid values: present, absent
Ensurable method handles modeling creation. It creates an ensure property
Default value: present
The value of the subsetting to be defined.
The following parameters are available in the ini_subsetting type.
namevar
An arbitrary name used as the identity of the resource.
The name of the section in the ini file in which the setting should be defined.
Default value: ''
The name of the setting to be defined.
The name of the subsetting to be defined.
The separator string between subsettings. Defaults to the empty string.
Default value:
The separator string between the subsetting name and its value. Defaults to the empty string.
Default value: ''
The ini file Puppet will ensure contains the specified setting.
Valid values: true, md5, false
Whether to display differences when the setting changes.
Default value: true
The separator string to use between each setting name and value.
Default value: =
The character used to quote the entire value of the setting. Valid values are '', '"' and "'"
Default value: ''
Valid values: true, false
Set to true if your subsettings don't have values and you want to use exact matches to determine if the subsetting exists.
Default value: false
Valid values: start, end, before, after, index
Where the new subsetting item should be inserted
- :start - insert at the beginning of the line.
- :end - insert at the end of the line (default).
- :before - insert before the specified element if possible.
- :after - insert after the specified element if possible.
- :index - insert at the specified index number.
Default value: end
The value for the insert types which require one.
Type: Ruby 3.x API
create_resources is used to create a set of ini_setting resources from a hash
create_resources is used to create a set of ini_setting resources from a hash
Returns: String Returns a string.