Page Menu
Home
Software Heritage
Search
Configure Global Search
Log In
Files
F11023567
REFERENCE.md
No One
Temporary
Actions
View File
Edit File
Delete File
View Transforms
Subscribe
Mute Notifications
Award Token
Flag For Later
Size
6 KB
Subscribers
None
REFERENCE.md
View Options
#
Reference
<!--
DO
NOT
EDIT
:
This
document
was
generated
by
Puppet
Strings
-->
##
Table
of
Contents
**
Resource
types
**
*
[
`
ini_setting
`
](#
ini_setting
):
ini_settings
is
used
to
manage
a
single
setting
in
an
INI
file
*
[
`
ini_subsetting
`
](#
ini_subsetting
):
ini_subsettings
is
used
to
manage
multiple
values
in
a
setting
in
an
INI
file
**
Functions
**
*
[
`
create_ini_settings
`
](#
create_ini_settings
):
create_resources
is
used
to
create
a
set
of
ini_setting
resources
from
a
hash
*
[
`
inifile
::
create_ini_settings
`
](#
inifilecreate_ini_settings
):
@
return
[
String
]
Returns
a
string
.
##
Resource
types
###
ini_setting
ini_settings
is
used
to
manage
a
single
setting
in
an
INI
file
####
Properties
The
following
properties
are
available
in
the
`
ini_setting
`
type
.
#####
`
ensure
`
Valid
values
:
present
,
absent
Ensurable
method
handles
modeling
creation
.
It
creates
an
ensure
property
Default
value
:
present
#####
`
value
`
The
value
of
the
setting
to
be
defined
.
####
Parameters
The
following
parameters
are
available
in
the
`
ini_setting
`
type
.
#####
`
name
`
namevar
An
arbitrary
name
used
as
the
identity
of
the
resource
.
#####
`
section
`
The
name
of
the
section
in
the
ini
file
in
which
the
setting
should
be
defined
.
Default
value
:
''
#####
`
setting
`
The
name
of
the
setting
to
be
defined
.
#####
`
force_new_section_creation
`
Valid
values
:
`
true
`
,
`
false
`
,
yes
,
no
Create
setting
only
if
the
section
exists
Default
value
:
`
true
`
#####
`
path
`
The
ini
file
Puppet
will
ensure
contains
the
specified
setting
.
#####
`
show_diff
`
Valid
values
:
`
true
`
,
md5
,
`
false
`
Whether
to
display
differences
when
the
setting
changes
.
Default
value
:
`
true
`
#####
`
key_val_separator
`
The
separator
string
to
use
between
each
setting
name
and
value
.
Default
value
:
=
#####
`
section_prefix
`
The
prefix
to
the
section
name
\
'
s
header
.
Default
value
:
[
#####
`
section_suffix
`
The
suffix
to
the
section
name
\
'
s
header
.
Default
value
:
]
#####
`
indent_char
`
The
character
to
indent
new
settings
with
.
Default
value
:
#####
`
indent_width
`
The
number
of
indent_chars
to
use
to
indent
a
new
setting
.
#####
`
refreshonly
`
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_subsetting
ini_subsettings
is
used
to
manage
multiple
values
in
a
setting
in
an
INI
file
####
Properties
The
following
properties
are
available
in
the
`
ini_subsetting
`
type
.
#####
`
ensure
`
Valid
values
:
present
,
absent
Ensurable
method
handles
modeling
creation
.
It
creates
an
ensure
property
Default
value
:
present
#####
`
value
`
The
value
of
the
subsetting
to
be
defined
.
####
Parameters
The
following
parameters
are
available
in
the
`
ini_subsetting
`
type
.
#####
`
name
`
namevar
An
arbitrary
name
used
as
the
identity
of
the
resource
.
#####
`
section
`
The
name
of
the
section
in
the
ini
file
in
which
the
setting
should
be
defined
.
Default
value
:
''
#####
`
setting
`
The
name
of
the
setting
to
be
defined
.
#####
`
subsetting
`
The
name
of
the
subsetting
to
be
defined
.
#####
`
subsetting_separator
`
The
separator
string
between
subsettings
.
Defaults
to
the
empty
string
.
Default
value
:
#####
`
subsetting_key_val_separator
`
The
separator
string
between
the
subsetting
name
and
its
value
.
Defaults
to
the
empty
string
.
Default
value
:
''
#####
`
path
`
The
ini
file
Puppet
will
ensure
contains
the
specified
setting
.
#####
`
show_diff
`
Valid
values
:
`
true
`
,
md5
,
`
false
`
Whether
to
display
differences
when
the
setting
changes
.
Default
value
:
`
true
`
#####
`
key_val_separator
`
The
separator
string
to
use
between
each
setting
name
and
value
.
Default
value
:
=
#####
`
quote_char
`
The
character
used
to
quote
the
entire
value
of
the
setting
.
Valid
values
are
''
,
'\"'
and
\
"'
\
"
Default
value
:
''
#####
`
use_exact_match
`
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
`
#####
`
insert_type
`
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
#####
`
insert_value
`
The
value
for
the
insert
types
which
require
one
.
##
Functions
###
create_ini_settings
Type
:
Ruby
3
.
x
API
create_resources
is
used
to
create
a
set
of
ini_setting
resources
from
a
hash
####
`
create_ini_settings
()
`
create_resources
is
used
to
create
a
set
of
ini_setting
resources
from
a
hash
Returns
:
`
String
`
Returns
a
string
.
###
inifile
::
create_ini_settings
Type
:
Ruby
4
.
x
API
This
is
an
autogenerated
function
,
ported
from
the
original
legacy
version
.
It
/
should
work
/
as
is
,
but
will
not
have
all
the
benefits
of
the
modern
function
API
.
You
should
see
the
function
docs
to
learn
how
to
add
function
signatures
for
type
safety
and
to
document
this
function
using
puppet
-
strings
.
https
:
//puppet.com/docs/puppet/latest/custom_functions_ruby.html
----
original
file
header
----
create_ini_settings
.
rb
----
original
file
header
----
create_resources
is
used
to
create
a
set
of
ini_setting
resources
from
a
hash
####
`
inifile
::
create_ini_settings
(
Any
*$
arguments
)
`
This
is
an
autogenerated
function
,
ported
from
the
original
legacy
version
.
It
/
should
work
/
as
is
,
but
will
not
have
all
the
benefits
of
the
modern
function
API
.
You
should
see
the
function
docs
to
learn
how
to
add
function
signatures
for
type
safety
and
to
document
this
function
using
puppet
-
strings
.
https
:
//puppet.com/docs/puppet/latest/custom_functions_ruby.html
----
original
file
header
----
create_ini_settings
.
rb
----
original
file
header
----
create_resources
is
used
to
create
a
set
of
ini_setting
resources
from
a
hash
Returns
:
`
Data
type
`
Describe
what
the
function
returns
here
#####
`
*
arguments
`
Data
type
:
`
Any
`
The
original
array
of
arguments
.
Port
this
to
individually
managed
params
to
get
the
full
benefit
of
the
modern
function
API
.
File Metadata
Details
Attached
Mime Type
text/plain
Expires
Thu, Sep 18, 4:48 PM (22 h, 17 m)
Storage Engine
blob
Storage Format
Raw Data
Storage Handle
3283479
Attached To
rSPINI Resource types for managing settings in INI files
Event Timeline
Log In to Comment