stdlib
: This module manages stdlib.stdlib::manage
: A simple place to define trivial resourcesstdlib::stages
: This class manages a standard set of run stages for Puppet. It is managed by the stdlib class, and should not be declared independently.
anchor
: A simple resource type intended to be used as an anchor in a composite class.file_line
: Ensures that a given line is contained within a file.
abs
: Deprecated: Returns the absolute value of a numberany2array
: This converts any object to an array containing that object.any2bool
: Converts 'anything' to a boolean.assert_private
: Sets the current class or definition as private.base64
: Base64 encode or decode a string based on the command and the string submittedbasename
: Strips directory (and optional suffix) from a filenamebatch_escape
: Escapes a string so that it can be safely used in a batch shell command line.bool2num
: Converts a boolean to a number.bool2str
: Converts a boolean to a string using optionally supplied arguments.camelcase
: Deprecated Converts the case of a string or all strings in an array to camel case.capitalize
: Deprecated Capitalizes the first letter of a string or array of strings.ceiling
: Deprecated Returns the smallest integer greater or equal to the argument.chomp
: Deprecated Removes the record separator from the end of a string or an array of strings.chop
: Deprecated Returns a new string with the last character removed.clamp
: Keeps value within the range [Min, X, Max] by sort based on integer value (parameter order doesn't matter).concat
: Appends the contents of multiple arrays into array 1.convert_base
: Converts a given integer or base 10 string representing an integer to a specified base, as a string.count
: Counts the number of elements in array.deep_merge
: Recursively merges two or more hashes together and returns the resulting hash.defined_with_params
: Takes a resource reference and an optional hash of attributes.delete
: Deletes all instances of a given element from an array, substring from a string, or key from a hash.delete_at
: Deletes a determined indexed value from an array.delete_regex
: Deletes all instances of a given element that match a regular expression from an array or key from a hash.delete_undef_values
: Returns a copy of input hash or array with all undefs deleted.delete_values
: Deletes all instances of a given value from a hash.deprecation
: Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message tedeprecation
: Function to print deprecation warnings (this is the 3.X version of it).difference
: This function returns the difference between two arrays.dig
: DEPRECATED Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path.dig44
: DEPRECATED: Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found.dirname
: Returns the dirname of a path.dos2unix
: Returns the Unix version of the given string.downcase
: Deprecated: Converts the case of a string or all strings in an array to lower case.empty
: Deprecated: Returns true if the variable is empty.enclose_ipv6
: Takes an array of ip addresses and encloses the ipv6 addresses with square brackets.ensure_packages
: Takes a list of packages and only installs them if they don't already exist.ensure_packages
: Deprecated 3x version of theensure_packages
functionensure_resource
: Takes a resource type, title, and a list of attributes that describe a resource.ensure_resources
: Takes a resource type, title (only hash), and a list of attributes that describe a resource.fact
: Digs into the facts hash using dot-notationflatten
: This function flattens any deeply nested arrays and returns a single flat array as a result.floor
: Returns the largest integer less or equal to the argument.fqdn_rand_string
: Generates a random alphanumeric string. Combining the$fqdn
fact and an optional seed for repeatable randomness.fqdn_rotate
: Rotates an array or string a random number of times, combining the$fqdn
fact and an optional seed for repeatable randomness.fqdn_uuid
: Returns a RFC 4122 valid version 5 UUID based on an FQDN string under the DNS namespaceget_module_path
: Returns the absolute path of the specified module for the current environment.getparam
: Returns the value of a resource's parameter.getvar
: Lookup a variable in a given namespace.glob
: Uses same patterns as Dir#glob.grep
: This function searches through an array and returns any elements that match the provided regular expression.has_interface_with
: Returns boolean based on kind and value.has_ip_address
: Returns true if the client has the requested IP address on some interface.has_ip_network
: Returns true if the client has an IP address within the requested network.has_key
: Deprecated: Determine if a hash has a certain key value.hash
: Deprecated: This function converts an array into a hash.intersection
: This function returns an array of the intersection of two.is_a
: Boolean check to determine whether a variable is of a given data type. This is equivalent to the=~
type checks.is_absolute_path
: Wrapper that calls the Puppet 3.x function of the same name.is_absolute_path
: Deprecated: Returns boolean true if the string represents an absolute path in the filesystem.is_array
: Wrapper that calls the Puppet 3.x function of the same name.is_array
: Deprecated: Returns true if the variable passed to this function is an array.is_bool
: Wrapper that calls the Puppet 3.x function of the same name.is_bool
: Deprecated: Returns true if the variable passed to this function is a boolean.is_domain_name
: Deprecated: Returns true if the string passed to this function is a syntactically correct domain name.is_email_address
: Deprecated: Returns true if the string passed to this function is a valid email address.is_float
: Wrapper that calls the Puppet 3.x function of the same name.is_float
: Deprecated: Returns true if the variable passed to this function is a float.is_function_available
: Deprecated: Determines whether the Puppet runtime has access to a function by that name.is_hash
: Deprecated: Returns true if the variable passed to this function is a hash.is_integer
: Deprecated: Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form.is_ip_address
: Wrapper that calls the Puppet 3.x function of the same name.is_ip_address
: Deprecated: Returns true if the string passed to this function is a valid IP address.is_ipv4_address
: Wrapper that calls the Puppet 3.x function of the same name.is_ipv4_address
: Deprecated: Returns true if the string passed to this function is a valid IPv4 address.is_ipv6_address
: Wrapper that calls the Puppet 3.x function of the same name.is_ipv6_address
: Deprecated: Returns true if the string passed to this function is a valid IPv6 address.is_mac_address
: Deprecated: Returns true if the string passed to this function is a valid mac address.is_numeric
: Wrapper that calls the Puppet 3.x function of the same name.is_numeric
: Deprecated: Returns true if the given value is numeric.is_string
: Wrapper that calls the Puppet 3.x function of the same name.is_string
: Deprecated: Returns true if the variable passed to this function is a string.join
: Deprecated: This function joins an array into a string using a separator.join_keys_to_values
: This function joins each key of a hash to that key's corresponding value with a separator.keys
: Deprecated: Returns the keys of a hash as an array.length
: Deprecated: A function to eventually replace the old size() function for stdlibload_module_metadata
: This function loads the metadata of a given module.loadjson
: Load a JSON file containing an array, string, or hash, and return the data in the corresponding native data type.loadyaml
: Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type.lstrip
: Deprecated: Strips leading spaces to the left of a string.max
: Deprecated: Returns the highest value of all arguments.member
: This function determines if a variable is a member of an array.merge
: Merges two or more hashes together or hashes resulting from iteration, and returns the resulting hash.merge
: Merges two or more hashes together and returns the resulting hash.min
: Deprecated: Returns the lowest value of all arguments.num2bool
: This function converts a number or a string representation of a number into a true boolean.os_version_gte
: Checks if the OS version is at least a certain version.parsehocon
: This function accepts HOCON as a string and converts it into the correct Puppet structureparsejson
: This function accepts JSON as a string and converts it into the correct Puppet structure.parsepson
: This function accepts PSON, a Puppet variant of JSON, as a string and converts it into the correct Puppet structureparseyaml
: This function accepts YAML as a string and converts it into the correct Puppet structure.pick
: This function will return the first value in a list of values that is not undefined or an empty string.pick_default
: This function will return the first value in a list of values that is not undefined or an empty string.powershell_escape
: Escapes a string so that it can be safely used in a PowerShell command line.prefix
: This function applies a prefix to all elements in an array or a hash.private
: Deprecated: Sets the current class or definition as private. Calling the class or definition from outside the current module will fail.pry
: This function invokes a pry debugging session in the current scope object.pw_hash
: Hashes a password using the crypt function. Provides a hash usable on most POSIX systems.range
: When given range in the form of (start, stop) it will extrapolate a range as an array.regexpescape
: Regexp escape a string or array of strings. Requires either a single string or an array as an input.reject
: This function searches through an array and rejects all elements that match the provided regular expression.reverse
: Reverses the order of a string or array.round
: Rounds a number to the nearest integerrstrip
: Strips leading spaces to the right of the string.seeded_rand
: Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness.seeded_rand_string
: Generates a consistent random string of specific length based on provided seed.shell_escape
: Escapes a string so that it can be safely used in a Bourne shell command line.shell_join
: Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined togethershell_split
: Splits a string into an array of tokens in the same way the Bourne shell does.shuffle
: @summary Randomizes the order of a string or array elements.size
: Returns the number of elements in a string, an array or a hashsort
: Sorts strings and arrays lexically.sprintf_hash
: Uses sprintf with named references.squeeze
: Returns a new string where runs of the same character that occur in this set are replaced by a single character.stdlib::crc32
: Run a CRC32 calculation against a given value.stdlib::deferrable_epp
: This function returns either a rendered template or a deferred function to render at runtime. If any of the values in the variables hash arestdlib::end_with
: Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String.stdlib::ensure
: function to cast ensure parameter to resource specific valuestdlib::extname
: Returns the Extension (the Portion of Filename in Path starting from the last Period).stdlib::ip_in_range
: Returns true if the ipaddress is within the given CIDRsstdlib::start_with
: Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String.stdlib::str2resource
: This converts a string to a puppet resource.stdlib::xml_encode
: Encode strings for XML filesstr2bool
: This converts a string to a boolean.str2saltedpbkdf2
: Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+str2saltedsha512
: This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7).strip
: This function removes leading and trailing whitespace from a string or from every string inside an array.suffix
: This function applies a suffix to all elements in an array, or to the keys in a hash.swapcase
: This function will swap the existing case of a string.time
: This function will return the current time since epoch as an integer.to_bytes
: Converts the argument into bytes, for example 4 kB becomes 4096.to_json
: Convert a data structure and output to JSONto_json_pretty
: Convert data structure and output to pretty JSONto_python
: Convert an object into a String containing its Python representationto_ruby
: Convert an object into a String containing its Ruby representationto_toml
: Convert a data structure and output to TOML.to_yaml
: Convert a data structure and output it as YAMLtry_get_value
: DEPRECATED: this function is deprecated, please use dig() instead.type
: DEPRECATED: This function will cease to function on Puppet 4;type3x
: DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system.type_of
: Returns the type of the passed value.union
: This function returns a union of two or more arrays.unique
: This function will remove duplicates from strings and arrays.unix2dos
: Returns the DOS version of the given string.upcase
: Converts a string or an array of strings to uppercase.uriescape
: Urlencodes a string or array of strings. Requires either a single string or an array as an input.validate_absolute_path
: Validate the string represents an absolute path in the filesystem.validate_absolute_path
: Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths.validate_array
: Validate the passed value represents an array.validate_array
: Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check.validate_augeas
: Perform validation of a string using an Augeas lensvalidate_bool
: Validate the passed value represents a boolean.validate_bool
: Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check.validate_cmd
: Perform validation of a string with an external command.validate_domain_name
: Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check.validate_email_address
: Validate that all values passed are valid email addresses. Fail compilation if any value fails this check.validate_hash
: Validate the passed value represents a hash.validate_hash
: Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check.validate_integer
: Validate the passed value represents an integer.validate_integer
: Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail.validate_ip_address
: Validate the passed value represents an ip_address.validate_ip_address
: Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check.validate_ipv4_address
: Validate the passed value represents an ipv4_address.validate_ipv4_address
: Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check.validate_ipv6_address
: Validate the passed value represents an ipv6_address.validate_ipv6_address
: Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check.validate_legacy
: Validate a value against both the target_type (new) and the previous_validation function (old).validate_numeric
: Validate the passed value represents a numeric value.validate_numeric
: Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail.validate_re
: Perform validation of a string against one or more regular expressions.validate_re
: Perform simple validation of a string against one or more regular expressions.validate_slength
: Validate that a passed string has length less/equal with the passed valuevalidate_slength
: Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument.validate_string
: Validate that all passed values are string data structures.validate_string
: Validate that all passed values are string data structuresvalidate_x509_rsa_key_pair
: Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL.values
: When given a hash this function will return the values of that hash.values_at
: Finds value inside an array based on location.zip
: Takes one element from first array and merges corresponding elements from second array.
Stdlib::Absolutepath
: A strict absolutepath typeStdlib::Base32
: Type to match base32 StringStdlib::Base64
: Type to match base64 StringStdlib::Compat::Absolute_path
: Emulate the is_absolute_path and validate_absolute_path functionsStdlib::Compat::Array
: Emulate the is_array and validate_array functionsStdlib::Compat::Bool
: Emulate the is_bool and validate_bool functionsStdlib::Compat::Float
: Emulate the is_float functionStdlib::Compat::Hash
: Emulate the is_hash and validate_hash functionsStdlib::Compat::Integer
: Emulate the is_integer and validate_integer functionsStdlib::Compat::Ip_address
: Validate an IP addressStdlib::Compat::Ipv4
: Emulate the validate_ipv4_address and is_ipv4_address functionsStdlib::Compat::Ipv6
: Validate an IPv6 addressStdlib::Compat::Numeric
: Emulate the is_numeric and validate_numeric functionsStdlib::Compat::String
: Emulate the is_string and validate_string functionsStdlib::CreateResources
: A type description used for the create_resources functionStdlib::Datasize
: Validate the size of dataStdlib::Email
: Validate an e-mail addressStdlib::Ensure::File
: Validate the value of the ensure parameter for a fileStdlib::Ensure::File::Directory
: Validate the ensure parameter of a "directory" file resourceStdlib::Ensure::File::File
: Validate the ensure parameter of a "file" file resourceStdlib::Ensure::File::Link
: Validate the ensure parameter of a "link" file resourceStdlib::Ensure::Service
: Validate the value of the ensure parameter of a service resourceStdlib::Filemode
: Validate a file modeStdlib::Filesource
: Validate the source parameter on file typesStdlib::Fqdn
: Validate a Fully Qualified Domain NameStdlib::HTTPSUrl
: Validate a HTTPS URLStdlib::HTTPUrl
: Validate a HTTP(S) URLStdlib::Host
: Validate a host (FQDN or IP address)Stdlib::HttpStatus
: Validate a HTTP status codeStdlib::IP::Address
: Validate an IP addressStdlib::IP::Address::Nosubnet
: Validate an IP address without subnetStdlib::IP::Address::V4
: Validate an IPv4 addressStdlib::IP::Address::V4::CIDR
: lint:ignore:140charsStdlib::IP::Address::V4::Nosubnet
: lint:ignore:140charsStdlib::IP::Address::V6
: Validate an IPv6 addressStdlib::IP::Address::V6::Alternative
: lint:ignore:140charsStdlib::IP::Address::V6::CIDR
: lint:ignore:140charsStdlib::IP::Address::V6::Compressed
: Validate a compressed IPv6 addressStdlib::IP::Address::V6::Full
: Validate a full IPv6 addressStdlib::IP::Address::V6::Nosubnet
: Validate an IPv6 address without subnetStdlib::IP::Address::V6::Nosubnet::Alternative
: lint:ignore:140charsStdlib::IP::Address::V6::Nosubnet::Compressed
: Validate compressed IPv6 address without subnetStdlib::IP::Address::V6::Nosubnet::Full
: Validate full IPv6 address without subnetStdlib::MAC
: A type for a MAC addressStdlib::ObjectStore
: Validate an ObjectStoreStdlib::ObjectStore::GSUri
: Validate a Google Cloud object store URIStdlib::ObjectStore::S3Uri
: Validate an Amazon Web Services S3 object store URIStdlib::Port
: Validate a port numberStdlib::Port::Dynamic
: Validate a dynamic port numberStdlib::Port::Ephemeral
: Validate an ephemeral port numberStdlib::Port::Privileged
: Validate a priviliged port numberStdlib::Port::Registered
: Validate a registered port numberStdlib::Port::Unprivileged
: Validate an unprivileged port numberStdlib::Port::User
: Validate a port number usable by a userStdlib::Syslogfacility
: Validate a syslog facilityStdlib::Unixpath
: Validate a UNIX pathStdlib::Windowspath
: Validate a Windows pathStdlib::Yes_no
: Validate a yes / no value
Most of stdlib's features are automatically loaded by Puppet, but this class should be declared in order to use the standardized run stages.
Declares all other classes in the stdlib module. Currently, this consists of stdlib::stages and stdlib::manage.
Sometimes your systems require a single simple resource.
It can feel unnecessary to create a module for a single
resource. There are a number of possible patterns to
generate trivial resource definitions. This is an attempt
to create a single clear method for uncomplicated resources.
There is limited support for before
, require
, notify
,
and subscribe
.
class { 'stdlib::manage':
'create_resources' => {
'file' => {
'/etc/motd.d/hello' => {
'content' => 'I say Hi',
'notify' => 'Service[sshd]',
}
},
'package' => {
'example' => {
'ensure' => 'installed',
'subscribe' => ['Service[sshd]', 'Exec[something]'],
}
}
}
stdlib::manage::create_resources:
file:
'/etc/motd.d/hello':
content: I say Hi
notify: 'Service[sshd]'
package:
example:
ensure: installed
subscribe:
- 'Service[sshd]'
- 'Exec[something]'
The following parameters are available in the stdlib::manage
class:
Data type: Hash[String, Hash]
A hash of resources to create
NOTE: functions, such as template
or epp
, are not evaluated.
Default value: {}
Declares various run-stages for deploying infrastructure, language runtimes, and application layers.
The high level stages are (in order):
- setup
- main
- runtime
- setup_infra
- deploy_infra
- setup_app
- deploy_app
- deploy
node default {
include ::stdlib
class { java: stage => 'runtime' }
}
Note: this has been replaced by core puppet
contain()
method. Please see https://puppet.com/docs/puppet/latest/lang_containment.html for more information.
In Puppet 2.6, when a class declares another class, the resources in the interior class are not contained by the exterior class. This interacts badly with the pattern of composing complex modules from smaller classes, as it makes it impossible for end users to specify order relationships between the exterior class and other modules.
The anchor type lets you work around this. By sandwiching any interior classes between two no-op resources that are contained by the exterior class, you can ensure that all resources in the module are contained.
class ntp {
# These classes will have the correct order relationship with each
# other. However, without anchors, they won't have any order
# relationship to Class['ntp'].
class { 'ntp::package': }
-> class { 'ntp::config': }
-> class { 'ntp::service': }
# These two resources "anchor" the composed classes within the ntp
# class.
anchor { 'ntp::begin': } -> Class['ntp::package']
Class['ntp::service'] -> anchor { 'ntp::end': }
}
This allows the end user of the ntp module to establish require and before relationships with Class['ntp']:
class { 'ntp': } -> class { 'mcollective': }
class { 'mcollective': } -> class { 'ntp': }
The following parameters are available in the anchor
type.
namevar
The name of the anchor resource.
The implementation matches the full line, including whitespace at the beginning and end. If the line is not contained in the given file, Puppet will append the line to the end of the file to ensure the desired state. Multiple resources may be declared to manage multiple lines in the same file.
- Ensure Example
file_line { 'sudo_rule':
path => '/etc/sudoers',
line => '%sudo ALL=(ALL) ALL',
}
file_line { 'sudo_rule_nopw':
path => '/etc/sudoers',
line => '%sudonopw ALL=(ALL) NOPASSWD: ALL',
}
In this example, Puppet will ensure both of the specified lines are contained in the file /etc/sudoers.
- Match Example
file_line { 'bashrc_proxy':
ensure => present,
path => '/etc/bashrc',
line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128',
match => '^export\ HTTP_PROXY\=',
}
In this code example match will look for a line beginning with export followed by HTTP_PROXY and replace it with the value in line.
- Examples With
ensure => absent
:
This type has two behaviors when ensure => absent
is set.
One possibility is to set match => ...
and match_for_absence => true
,
as in the following example:
file_line { 'bashrc_proxy':
ensure => absent,
path => '/etc/bashrc',
match => '^export\ HTTP_PROXY\=',
match_for_absence => true,
}
In this code example match will look for a line beginning with export
followed by HTTP_PROXY and delete it. If multiple lines match, an
error will be raised unless the multiple => true
parameter is set.
Note that the line => ...
parameter would be accepted BUT IGNORED in
the above example.
The second way of using ensure => absent
is to specify a line => ...
,
and no match:
file_line { 'bashrc_proxy':
ensure => absent,
path => '/etc/bashrc',
line => 'export HTTP_PROXY=http://squid.puppetlabs.vm:3128',
}
Note: When ensuring lines are absent this way, the default behavior this time is to always remove all lines matching, and this behavior can't be disabled.
- Encoding example:
file_line { "XScreenSaver":
ensure => present,
path => '/root/XScreenSaver',
line => "*lock: 10:00:00",
match => '^*lock:',
encoding => "iso-8859-1",
}
Files with special characters that are not valid UTF-8 will give the error message "invalid byte sequence in UTF-8". In this case, determine the correct file encoding and specify the correct encoding using the encoding attribute, the value of which needs to be a valid Ruby character encoding.
Autorequires: If Puppet is managing the file that will contain the line being managed, the file_line resource will autorequire that file.
The following properties are available in the file_line
type.
Valid values: present
, absent
Manage the state of this type.
Default value: present
The line to be appended to the file or used to replace matches found by the match attribute.
The following parameters are available in the file_line
type.
after
append_on_no_match
encoding
match
match_for_absence
multiple
name
path
provider
replace
replace_all_matches_not_matching_line
An optional value used to specify the line after which we will add any new lines. (Existing lines are added in place) This is also takes a regex.
Valid values: true
, false
If true, append line if match is not found. If false, do not append line if a match is not found
Default value: true
For files that are not UTF-8 encoded, specify encoding such as iso-8859-1
Default value: UTF-8
An optional ruby regular expression to run against existing lines in the file. If a match is found, we replace that line rather than adding a new line. A regex comparison is performed against the line value and if it does not match an exception will be raised.
Valid values: true
, false
An optional value to determine if match should be applied when ensure => absent.
If set to true and match is set, the line that matches match will be deleted.
If set to false (the default), match is ignored when ensure => absent.
When ensure => present
, match_for_absence is ignored.
Default value: false
Valid values: true
, false
An optional value to determine if match can change multiple lines. If set to false, an exception will be raised if more than one line matches
namevar
An arbitrary name used as the identity of the resource.
The file Puppet will ensure contains the line specified by the line parameter.
The specific backend to use for this file_line
resource. You will seldom need to specify this --- Puppet will usually
discover the appropriate provider for your platform.
Valid values: true
, false
If true, replace line that matches. If false, do not write line if a match is found
Default value: true
Valid values: true
, false
Configures the behavior of replacing all lines in a file which match the match
parameter regular expression,
regardless of whether the specified line is already present in the file.
Default value: false
Type: Ruby 3.x API
For example -34.56 becomes 34.56. Takes a single integer or float value as an argument.
Note: Deprected from Puppet 6.0.0, the built-in 'abs'function will be used instead.
For example -34.56 becomes 34.56. Takes a single integer or float value as an argument.
Note: Deprected from Puppet 6.0.0, the built-in 'abs'function will be used instead.
Returns: Any
The absolute value of the given number if it was an Integer
Type: Ruby 3.x API
Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values.
Note: since Puppet 5.0.0 it is possible to create new data types for almost any datatype using the type system and the built-in
Array.new
function is used to create a new Array..
$hsh = {'key' => 42, 'another-key' => 100}
notice(Array($hsh))
Would notice [['key', 42], ['another-key', 100]]
The Array data type also has a special mode to "create an array if not already an array"
notice(Array({'key' => 42, 'another-key' => 100}, true))
Would notice [{'key' => 42, 'another-key' => 100}]
, as the true
flag prevents the hash from being
transformed into an array.
Empty argument lists are converted to an empty array. Arrays are left untouched. Hashes are converted to arrays of alternating keys and values.
Note: since Puppet 5.0.0 it is possible to create new data types for almost any datatype using the type system and the built-in
Array.new
function is used to create a new Array..
$hsh = {'key' => 42, 'another-key' => 100}
notice(Array($hsh))
Would notice [['key', 42], ['another-key', 100]]
The Array data type also has a special mode to "create an array if not already an array"
notice(Array({'key' => 42, 'another-key' => 100}, true))
Would notice [{'key' => 42, 'another-key' => 100}]
, as the true
flag prevents the hash from being
transformed into an array.
Returns: Array
The new array containing the given object
Type: Ruby 3.x API
In practise it does the following:
- Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true
- Strings such as 0,F,f,N,n,FALSE,no,'false' will return false
- Booleans will just return their original value
- Number (or a string representation of a number) > 0 will return true, otherwise false
- undef will return false
- Anything else will return true
Also see the built-in Boolean.new
function.
In practise it does the following:
- Strings such as Y,y,1,T,t,TRUE,yes,'true' will return true
- Strings such as 0,F,f,N,n,FALSE,no,'false' will return false
- Booleans will just return their original value
- Number (or a string representation of a number) > 0 will return true, otherwise false
- undef will return false
- Anything else will return true
Also see the built-in Boolean.new
function.
Returns: Boolean
The boolean value of the object that was given
Type: Ruby 3.x API
Calling the class or definition from outside the current module will fail.
Calling the class or definition from outside the current module will fail.
Returns: Any
set the current class or definition as private.
Type: Ruby 3.x API
*Note: Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. See the
new()
function for the Binary and String types for documentation. Also seebinary_file()
function for reading a file with binary (non UTF-8) content.
Encode and decode a string
$encodestring = base64('encode', 'thestring')
$decodestring = base64('decode', 'dGhlc3RyaW5n')
Explicitly define encode/decode method: default, strict, urlsafe
$method = 'default'
$encodestring = base64('encode', 'thestring', $method)
$decodestring = base64('decode', 'dGhlc3RyaW5n', $method)
Encode a string as if it was binary
$encodestring = String(Binary('thestring', '%s'))
Decode a Binary assuming it is an UTF-8 String
$decodestring = String(Binary("dGhlc3RyaW5n"), "%s")
*Note: Since Puppet 4.8.0, the Binary data type can be used to produce base 64 encoded strings. See the
new()
function for the Binary and String types for documentation. Also seebinary_file()
function for reading a file with binary (non UTF-8) content.
Returns: String
The encoded/decoded va
Encode and decode a string
$encodestring = base64('encode', 'thestring')
$decodestring = base64('decode', 'dGhlc3RyaW5n')
Explicitly define encode/decode method: default, strict, urlsafe
$method = 'default'
$encodestring = base64('encode', 'thestring', $method)
$decodestring = base64('decode', 'dGhlc3RyaW5n', $method)
Encode a string as if it was binary
$encodestring = String(Binary('thestring', '%s'))
Decode a Binary assuming it is an UTF-8 String
$decodestring = String(Binary("dGhlc3RyaW5n"), "%s")
Type: Ruby 3.x API
Strips directory (and optional suffix) from a filename
The basename function.
Returns: String
The stripped filename
Type: Ruby 4.x API
- Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes.
- Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes.
Returns: Any
An escaped string that can be safely used in a batch command line.
Data type: Any
The string to escape
Type: Ruby 3.x API
Converts the values:
false, f, 0, n, and no to 0
true, t, 1, y, and yes to 1
Requires a single boolean or string as an input.
Note: since Puppet 5.0.0 it is possible to create new data types for almost any datatype using the type system and the built-in
Numeric.new
,Integer.new
, andFloat.new
function are used to convert to numeric values.
notice(Integer(false)) # Notices 0
notice(Float(true)) # Notices 1.0
Converts the values:
false, f, 0, n, and no to 0
true, t, 1, y, and yes to 1
Requires a single boolean or string as an input.
Note: since Puppet 5.0.0 it is possible to create new data types for almost any datatype using the type system and the built-in
Numeric.new
,Integer.new
, andFloat.new
function are used to convert to numeric values.
notice(Integer(false)) # Notices 0
notice(Float(true)) # Notices 1.0
Returns: Integer
The converted value as a number
Type: Ruby 3.x API
The optional second and third arguments represent what true and false will be converted to respectively. If only one argument is given, it will be converted from a boolean to a string containing 'true' or 'false'.
Examples of usage
bool2str(true) => 'true'
bool2str(true, 'yes', 'no') => 'yes'
bool2str(false, 't', 'f') => 'f'
Requires a single boolean as an input.
Note: since Puppet 5.0.0 it is possible to create new data types for almost any datatype using the type system and the built-in
String.new
function is used to convert to String with many different format options.
notice(String(false)) # Notices 'false'
notice(String(true)) # Notices 'true'
notice(String(false, '%y')) # Notices 'yes'
notice(String(true, '%y')) # Notices 'no'
The optional second and third arguments represent what true and false will be converted to respectively. If only one argument is given, it will be converted from a boolean to a string containing 'true' or 'false'.
Examples of usage
bool2str(true) => 'true'
bool2str(true, 'yes', 'no') => 'yes'
bool2str(false, 't', 'f') => 'f'
Requires a single boolean as an input.
Note: since Puppet 5.0.0 it is possible to create new data types for almost any datatype using the type system and the built-in
String.new
function is used to convert to String with many different format options.
notice(String(false)) # Notices 'false'
notice(String(true)) # Notices 'true'
notice(String(false, '%y')) # Notices 'yes'
notice(String(true, '%y')) # Notices 'no'
Returns: Any
The converted value to string of the given Boolean
Type: Ruby 3.x API
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
camelcase
function.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
camelcase
function.
Returns: String
The converted String, if it was a String that was given
Type: Ruby 3.x API
Requires either a single string or an array as an input.
Note: Deprecated from Puppet 6.0.0, yhis function has been replaced with a built-in
capitalize
function.
Requires either a single string or an array as an input.
Note: Deprecated from Puppet 6.0.0, yhis function has been replaced with a built-in
capitalize
function.
Returns: String
The converted String, if it was a String that was given
Type: Ruby 3.x API
Takes a single numeric value as an argument.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
ceiling
function.
Takes a single numeric value as an argument.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
ceiling
function.
Returns: Integer
The rounded value
Type: Ruby 3.x API
For example hello\n
becomes hello
.
Requires a single string or array as an input.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
chomp
function.
For example hello\n
becomes hello
.
Requires a single string or array as an input.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
chomp
function.
Returns: String
The converted String, if it was a String that was given
Type: Ruby 3.x API
If the string ends with \r\n
, both characters are removed. Applying
chop to an empty string returns an empty string. If you wish to merely
remove record separators then you should use the chomp
function.
Requires a string or array of strings as input.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
chop
function.
If the string ends with \r\n
, both characters are removed. Applying
chop to an empty string returns an empty string. If you wish to merely
remove record separators then you should use the chomp
function.
Requires a string or array of strings as input.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
chop
function.
Returns: String
The given String, sans the last character.
Type: Ruby 3.x API
Strings are converted and compared numerically. Arrays of values are flattened into a list for further handling.
Note: From Puppet 6.0.0 this can be done with only core Puppet like this:
[$minval, $maxval, $value_to_clamp].sort[1]
clamp('24', [575, 187])` returns 187.
clamp(16, 88, 661)` returns 88.
clamp([4, 3, '99'])` returns 4.
Strings are converted and compared numerically. Arrays of values are flattened into a list for further handling.
Note: From Puppet 6.0.0 this can be done with only core Puppet like this:
[$minval, $maxval, $value_to_clamp].sort[1]
Returns: Array[Integer]
The sorted Array
clamp('24', [575, 187])` returns 187.
clamp(16, 88, 661)` returns 88.
clamp([4, 3, '99'])` returns 4.
Type: Ruby 3.x API
Note: Since Puppet 4.0, you can use the
+`` operator for concatenation of arrays and merge of hashes, and the
<<`` operator for appending:
['1','2','3'] + ['4','5','6'] + ['7','8','9']
returns ['1','2','3','4','5','6','7','8','9']
[1, 2, 3] << 4
returns [1, 2, 3, 4]
[1, 2, 3] << [4, 5]
returns [1, 2, 3, [4, 5]]
concat(['1','2','3'],'4') returns ['1','2','3','4']
concat(['1','2','3'],'4',['5','6','7']) returns ['1','2','3','4','5','6','7']
Note: Since Puppet 4.0, you can use the
+`` operator for concatenation of arrays and merge of hashes, and the
<<`` operator for appending:
['1','2','3'] + ['4','5','6'] + ['7','8','9']
returns ['1','2','3','4','5','6','7','8','9']
[1, 2, 3] << 4
returns [1, 2, 3, 4]
[1, 2, 3] << [4, 5]
returns [1, 2, 3, [4, 5]]
Returns: Array
The single concatenated array
concat(['1','2','3'],'4') returns ['1','2','3','4']
concat(['1','2','3'],'4',['5','6','7']) returns ['1','2','3','4','5','6','7']
Type: Ruby 3.x API
convert_base(5, 2)results in:
'101' convert_base('254', '16')
results in: 'fe'
Note: Since Puppet 4.5.0 this can be done with the built-in
String.new
function and its many formatting options:
$binary_repr = String(5, '%b')
return "101"
$hex_repr = String(254, "%x")
return "fe"
$hex_repr = String(254, "%#x")
return "0xfe"
@return [String] The converted value as a Str
convert_base(5, 2)results in:
'101' convert_base('254', '16')
results in: 'fe'
Note: Since Puppet 4.5.0 this can be done with the built-in
String.new
function and its many formatting options:
$binary_repr = String(5, '%b')
return "101"
$hex_repr = String(254, "%x")
return "fe"
$hex_repr = String(254, "%#x")
return "0xfe"
@return [String] The converted value as a Str
Returns: Any
converted value as a string
Type: Ruby 3.x API
Takes an array as first argument and an optional second argument. Counts the number of elements in array that is equal to the second argument. If called with only an array, it counts the number of elements that are not nil/undef/empty-string.
Note: equality is tested with a Ruby method and it is therefore subject to what Ruby considers to be equal. For strings this means that equality is case sensitive.
In Puppet core, counting can be done in general by using a combination of the core functions filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib).
Example below shows counting values that are not undef.
notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)
Would notice the value 2.
Takes an array as first argument and an optional second argument. Counts the number of elements in array that is equal to the second argument. If called with only an array, it counts the number of elements that are not nil/undef/empty-string.
Note: equality is tested with a Ruby method and it is therefore subject to what Ruby considers to be equal. For strings this means that equality is case sensitive.
In Puppet core, counting can be done in general by using a combination of the core functions filter() (since Puppet 4.0.0) and length() (since Puppet 5.5.0, before that in stdlib).
Example below shows counting values that are not undef.
notice([42, "hello", undef].filter |$x| { $x =~ NotUndef }.length)
Would notice the value 2.
Returns: Integer
The amount of elements counted within the array
Type: Ruby 3.x API
Recursively merges two or more hashes together and returns the resulting hash.
$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
$merged_hash = deep_merge($hash1, $hash2)
The resulting hash is equivalent to:
$merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }
When there is a duplicate key that is a hash, they are recursively merged.
When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
The deep_merge function.
Returns: Hash
The merged h
$hash1 = {'one' => 1, 'two' => 2, 'three' => { 'four' => 4 } }
$hash2 = {'two' => 'dos', 'three' => { 'five' => 5 } }
$merged_hash = deep_merge($hash1, $hash2)
The resulting hash is equivalent to:
$merged_hash = { 'one' => 1, 'two' => 'dos', 'three' => { 'four' => 4, 'five' => 5 } }
When there is a duplicate key that is a hash, they are recursively merged.
When there is a duplicate key that is not a hash, the key in the rightmost hash will "win."
Type: Ruby 3.x API
Returns true
if a resource with the specified attributes has already been added
to the catalog, and false
otherwise.
user { 'dan':
ensure => present,
}
if ! defined_with_params(User[dan], {'ensure' => 'present' }) {
user { 'dan': ensure => present, }
}
Returns true
if a resource with the specified attributes has already been added
to the catalog, and false
otherwise.
user { 'dan':
ensure => present,
}
if ! defined_with_params(User[dan], {'ensure' => 'present' }) {
user { 'dan': ensure => present, }
}
Returns: Boolean
returns true
or false
Type: Ruby 3.x API
Note: From Puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash
{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])
A global delete from a string can be performed with the
regsubst
function:
'abracadabra'.regsubst(/bra/, '', 'G')
In general, the built-in filter
function can filter out entries from arrays and hashes based on keys and/or values.
delete(['a','b','c','b'], 'b')
Would return: ['a','c']
delete({'a'=>1,'b'=>2,'c'=>3}, 'b')
Would return: {'a'=>1,'c'=>3}
delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])
Would return: {'a'=>1}
delete('abracadabra', 'bra')
Would return: 'acada'
['a', 'b', 'c', 'b'] - 'b'
Would return: ['a', 'c']
{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])
Would return: {'a' => '1'}
'abracadabra'.regsubst(/bra/, '', 'G')
Would return: 'acada'
Note: From Puppet 4.0.0 the minus (-) operator deletes values from arrays and keys from a hash
{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])
A global delete from a string can be performed with the
regsubst
function:
'abracadabra'.regsubst(/bra/, '', 'G')
In general, the built-in filter
function can filter out entries from arrays and hashes based on keys and/or values.
Returns: String
The filtered String, if one was given.
delete(['a','b','c','b'], 'b')
Would return: ['a','c']
delete({'a'=>1,'b'=>2,'c'=>3}, 'b')
Would return: {'a'=>1,'c'=>3}
delete({'a'=>1,'b'=>2,'c'=>3}, ['b','c'])
Would return: {'a'=>1}
delete('abracadabra', 'bra')
Would return: 'acada'
['a', 'b', 'c', 'b'] - 'b'
Would return: ['a', 'c']
{'a'=>1,'b'=>2,'c'=>3} - ['b','c'])
Would return: {'a' => '1'}
'abracadabra'.regsubst(/bra/, '', 'G')
Would return: 'acada'
Type: Ruby 3.x API
For example
delete_at(['a','b','c'], 1)
Would return: ['a','c']
Note: Since Puppet 4 this can be done in general with the built-in
filter
function:
['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }
Or if a delete is wanted from the beginning or end of the array, by using the slice operator [ ]:
$array[0, -1] # the same as all the values
$array[2, -1] # all but the first 2 elements
$array[0, -3] # all but the last 2 elements
$array[1, -2] # all but the first and last element
For example
delete_at(['a','b','c'], 1)
Would return: ['a','c']
Note: Since Puppet 4 this can be done in general with the built-in
filter
function:
['a', 'b', 'c'].filter |$pos, $val | { $pos != 1 }
Or if a delete is wanted from the beginning or end of the array, by using the slice operator [ ]:
$array[0, -1] # the same as all the values
$array[2, -1] # all but the first 2 elements
$array[0, -3] # all but the last 2 elements
$array[1, -2] # all but the first and last element
Returns: Array
The given array, now missing the tar
Type: Ruby 3.x API
Multiple regular expressions are assumed to be matched as an OR.
Note: Since Puppet 4 this can be done in general with the built-in
filter
function: ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } Would return: ['aaa', 'aca']
delete_regex(['a','b','c','b'], 'b')
Would return: ['a','c']
delete_regex(['a','b','c','b'], ['b', 'c'])
Would return: ['a']
delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b')
Would return: {'a'=>1,'c'=>3}
delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$')
Would return: {'b'=>2,'c'=>3}
Multiple regular expressions are assumed to be matched as an OR.
Note: Since Puppet 4 this can be done in general with the built-in
filter
function: ["aaa", "aba", "aca"].filter |$val| { $val !~ /b/ } Would return: ['aaa', 'aca']
Returns: Array
The given array now missing all targeted values.
delete_regex(['a','b','c','b'], 'b')
Would return: ['a','c']
delete_regex(['a','b','c','b'], ['b', 'c'])
Would return: ['a']
delete_regex({'a'=>1,'b'=>2,'c'=>3}, 'b')
Would return: {'a'=>1,'c'=>3}
delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$')
Would return: {'b'=>2,'c'=>3}
Type: Ruby 3.x API
Note: Since Puppet 4.0.0 the equivalent can be performed with the built-in
filter
function: $array.filter |$val| { $val =~ NotUndef } $hash.filter |$key, $val| { $val =~ NotUndef }
$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})
Would return: {a => 'A', b => '', d => false}
While:
$array = delete_undef_values(['A','',undef,false])
Would return: ['A','',false]
Note: Since Puppet 4.0.0 the equivalent can be performed with the built-in
filter
function: $array.filter |$val| { $val =~ NotUndef } $hash.filter |$key, $val| { $val =~ NotUndef }
Returns: Array
The given array now issing of undefined values.
$hash = delete_undef_values({a=>'A', b=>'', c=>undef, d => false})
Would return: {a => 'A', b => '', d => false}
While:
$array = delete_undef_values(['A','',undef,false])
Would return: ['A','',false]
Type: Ruby 3.x API
Note: Since Puppet 4.0.0 the equivalent can be performed with the built-in
filter
function: $array.filter |$val| { $val != 'B' } $hash.filter |$key, $val| { $val != 'B' }
delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')
Would return: {'a'=>'A','c'=>'C','B'=>'D'}
Note: Since Puppet 4.0.0 the equivalent can be performed with the built-in
filter
function: $array.filter |$val| { $val != 'B' } $hash.filter |$key, $val| { $val != 'B' }
Returns: Hash
The given hash now missing all instances of the targeted value
delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')
Would return: {'a'=>'A','c'=>'C','B'=>'D'}
Type: Ruby 4.x API
Function to print deprecation warnings, Logs a warning once for a given key.
The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method. It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) Type: String, String.
Function to print deprecation warnings, Logs a warning once for a given key.
The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method. It is affected by the puppet setting 'strict', which can be set to :error (outputs as an error message), :off (no message / error is displayed) and :warning (default, outputs a warning) Type: String, String.
Returns: Any
deprecated warnings
Data type: String
Data type: String
Type: Ruby 3.x API
The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.).
The uniqueness key - can appear once. The msg is the message text including any positional information that is formatted by the user/caller of the method.).
Returns: String
return deprecation warnings
Type: Ruby 3.x API
The returned array is a copy of the original array, removing any items that also appear in the second array.
Note: Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: ['a', 'b', 'c'] - ['b', 'c', 'd'] Would return:
['a']
difference(["a","b","c"],["b","c","d"])
Would return: `["a"]`
The returned array is a copy of the original array, removing any items that also appear in the second array.
Note: Since Puppet 4 the minus (-) operator in the Puppet language does the same thing: ['a', 'b', 'c'] - ['b', 'c', 'd'] Would return:
['a']
Returns: Array
The difference between the two given arrays
difference(["a","b","c"],["b","c","d"])
Would return: `["a"]`
Type: Ruby 3.x API
In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred.
$data = {
'a' => {
'b' => [
'b1',
'b2',
'b3',
]
}
}
$value = dig($data, ['a', 'b', 2])
# $value = 'b3'
# with all possible options
$value = dig($data, ['a', 'b', 2], 'not_found')
# $value = 'b3'
# using the default value
$value = dig($data, ['a', 'b', 'c', 'd'], 'not_found')
# $value = 'not_found'
$data
The data structure we are working with.['a', 'b', 2]
The path array.not_found
The default value. It is returned if nothing is found.
*Note: Deprecated This function has been replaced with a built-in
dig
function as of Puppet 4.5.0. Usedig44()
for backwards compatibility or use the new version.
In addition to the required path argument, the function accepts the default argument. It is returned if the path is not correct, if no value was found, or if any other error has occurred.
$data = {
'a' => {
'b' => [
'b1',
'b2',
'b3',
]
}
}
$value = dig($data, ['a', 'b', 2])
# $value = 'b3'
# with all possible options
$value = dig($data, ['a', 'b', 2], 'not_found')
# $value = 'b3'
# using the default value
$value = dig($data, ['a', 'b', 'c', 'd'], 'not_found')
# $value = 'not_found'
$data
The data structure we are working with.['a', 'b', 2]
The path array.not_found
The default value. It is returned if nothing is found.
*Note: Deprecated This function has been replaced with a built-in
dig
function as of Puppet 4.5.0. Usedig44()
for backwards compatibility or use the new version.
Returns: Any
The function goes through the structure by each path component and tries to return
the value at the end of the path.
Type: Ruby 3.x API
Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value.
$data = {
'a' => {
'b' => [
'b1',
'b2',
'b3',
]
}
}
$value = dig44($data, ['a', 'b', 2])
# $value = 'b3'
# with all possible options
$value = dig44($data, ['a', 'b', 2], 'not_found')
# $value = 'b3'
# using the default value
$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found')
# $value = 'not_found'
*Note: Deprecated This function has been replaced with a built-in
dig
function as of Puppet 4.5.0.
Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value.
$data = {
'a' => {
'b' => [
'b1',
'b2',
'b3',
]
}
}
$value = dig44($data, ['a', 'b', 2])
# $value = 'b3'
# with all possible options
$value = dig44($data, ['a', 'b', 2], 'not_found')
# $value = 'b3'
# using the default value
$value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found')
# $value = 'not_found'
*Note: Deprecated This function has been replaced with a built-in
dig
function as of Puppet 4.5.0.
Returns: String
'not_found' will be returned if nothing is found
Type: Ruby 3.x API
Returns the dirname of a path.
The dirname function.
Returns: String
the given path's dirname
Type: Ruby 3.x API
Takes a single string argument.
Takes a single string argument.
Returns: Any
The retrieved version
Type: Ruby 3.x API
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
downcase
function.
This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
downcase
function.
This function is an implementation of a Ruby class and might not be UTF8 compatible. To ensure compatibility, use this function with Ruby 2.4.0 or greater.
Returns: String
The converted String, if it was a String that was given
Type: Ruby 3.x API
Note: Deprecated from Puppet 5.5.0, the built-in
empty
function will be used instead.
Note: Deprecated from Puppet 5.5.0, the built-in
empty
function will be used instead.
Returns: Any
Returns true
if the argument is an array or hash that contains no elements,
or an empty string. Returns false
when the argument is a numerical value.
Type: Ruby 3.x API
Takes an array of ip addresses and encloses the ipv6 addresses with square brackets.
The enclose_ipv6 function.
Returns: Any
encloses the ipv6 addresses with square brackets.
Type: Ruby 4.x API
It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function.
ensure_packages(Variant[String[1], Array[String[1]], Hash[String[1], Any]] $packages, Optional[Hash] $default_attributes)
It optionally takes a hash as a second parameter that will be passed as the third argument to the ensure_resource() function.
Returns: Undef
Returns nothing.
Data type: Variant[String[1], Array[String[1]], Hash[String[1], Any]]
The packages to ensure are installed. If it's a Hash it will be passed to ensure_resource
Data type: Optional[Hash]
Default attributes to be passed to the ensure_resource()
function
Type: Ruby 3.x API
Deprecated 3x version of the ensure_packages
function
The ensure_packages function.
Returns: Any
Type: Ruby 3.x API
user { 'dan': ensure => present, }
Creates the resource if it does not already exist:
ensure_resource('user', 'dan', {'ensure' => 'present' })
If the resource already exists but does not match the specified parameters,
this function will attempt to recreate the resource leading to a duplicate
resource definition error.
An array of resources can also be passed in and each will be created with
the type and parameters specified if it doesn't already exist.
ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})
user { 'dan': ensure => present, }
Returns: Any
created or recreated the passed resource with the passed type and attributes
Creates the resource if it does not already exist:
ensure_resource('user', 'dan', {'ensure' => 'present' })
If the resource already exists but does not match the specified parameters,
this function will attempt to recreate the resource leading to a duplicate
resource definition error.
An array of resources can also be passed in and each will be created with
the type and parameters specified if it doesn't already exist.
ensure_resource('user', ['dan','alex'], {'ensure' => 'present'})
Type: Ruby 3.x API
An hash of resources should be passed in and each will be created with the type and parameters specified if it doesn't already exist.
ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' }, 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'})
From Hiera Backend:
userlist: dan: gid: 'mygroup' uid: '600' alex: gid: 'mygroup'
Call: ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'})
user { 'dan':
gid => 'mygroup',
ensure => present,
}
An hash of resources should be passed in and each will be created with the type and parameters specified if it doesn't already exist.
ensure_resources('user', {'dan' => { gid => 'mygroup', uid => '600' }, 'alex' => { gid => 'mygroup' }}, {'ensure' => 'present'})
From Hiera Backend:
userlist: dan: gid: 'mygroup' uid: '600' alex: gid: 'mygroup'
Call: ensure_resources('user', hiera_hash('userlist'), {'ensure' => 'present'})
Returns: Any
created resources with the passed type and attributes
user { 'dan':
gid => 'mygroup',
ensure => present,
}
Type: Ruby 4.x API
Supports the use of dot-notation for referring to structured facts. If a fact requested does not exist, returns Undef.
fact('osfamily')
fact('os.architecture')
fact('mountpoints."/dev".options.1')
fact('vmware."VRA.version"')
Supports the use of dot-notation for referring to structured facts. If a fact requested does not exist, returns Undef.
Returns: Any
All information retrieved on the given fact_name
fact('osfamily')
fact('os.architecture')
fact('mountpoints."/dev".options.1')
fact('vmware."VRA.version"')
Data type: String
The name of the fact to check
Type: Ruby 3.x API
Note: Deprecated from Puppet 5.5.0, this function has been replaced with a built-in
flatten
function.
flatten(['a', ['b', ['c']]])` returns: `['a','b','c']
Note: Deprecated from Puppet 5.5.0, this function has been replaced with a built-in
flatten
function.
Returns: Any
convert nested arrays into a single flat array
flatten(['a', ['b', ['c']]])` returns: `['a','b','c']
Type: Ruby 3.x API
Takes a single numeric value as an argument.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
floor
function.
Takes a single numeric value as an argument.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
floor
function.
Returns: Any
the largest integer less or equal to the argument.
Type: Ruby 3.x API
Optionally, you can specify a character set for the function (defaults to alphanumeric).
Arguments
- An integer, specifying the length of the resulting string.
- Optionally, a string specifying the character set.
- Optionally, a string specifying the seed for repeatable randomness.
fqdn_rand_string(10)
fqdn_rand_string(10, 'ABCDEF!@$%^')
fqdn_rand_string(10, '', 'custom seed')
Optionally, you can specify a character set for the function (defaults to alphanumeric).
Arguments
- An integer, specifying the length of the resulting string.
- Optionally, a string specifying the character set.
- Optionally, a string specifying the seed for repeatable randomness.
Returns: String
fqdn_rand_string(10)
fqdn_rand_string(10, 'ABCDEF!@$%^')
fqdn_rand_string(10, '', 'custom seed')
Type: Ruby 3.x API
Rotates an array or string a random number of times, combining the $fqdn
fact
and an optional seed for repeatable randomness.
fqdn_rotate(['a', 'b', 'c', 'd'])
fqdn_rotate('abcd')
fqdn_rotate([1, 2, 3], 'custom seed')
The fqdn_rotate function.
Returns: Any
rotated array or string
fqdn_rotate(['a', 'b', 'c', 'd'])
fqdn_rotate('abcd')
fqdn_rotate([1, 2, 3], 'custom seed')
Type: Ruby 3.x API
Returns a RFC 4122 valid version 5 UUID based on an FQDN string under the DNS namespace
fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c'
fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09
The fqdn_uuid function.
Returns: Any
Returns a RFC 4122 valid version 5 UUID
fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c'
fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09
Type: Ruby 3.x API
Note: that since Puppet 5.4.0 the built-in
module_directory
function in Puppet does the same thing and will return the path to the first found module if given multiple values or an array.
$module_path = get_module_path('stdlib')
Note: that since Puppet 5.4.0 the built-in
module_directory
function in Puppet does the same thing and will return the path to the first found module if given multiple values or an array.
Returns: Any
Returns the absolute path of the specified module for the current
environment.
$module_path = get_module_path('stdlib')
Type: Ruby 3.x API
Takes a resource reference and name of the parameter and returns value of resource's parameter. Note that user defined resource types are evaluated lazily.
Would notice: 'the value we are getting in this example'
Note that since Puppet 4.0.0 it is possible to get a parameter value by using its data type and the [ ] operator. The example below is equivalent to a call to getparam(): ```Example_resource['example_resource_instance']['param']``
# define a resource type with a parameter
define example_resource($param) {
}
# declare an instance of that type
example_resource { "example_resource_instance":
param => "'the value we are getting in this example''"
}
# Because of order of evaluation, a second definition is needed
# that will be evaluated after the first resource has been declared
#
define example_get_param {
# This will notice the value of the parameter
notice(getparam(Example_resource["example_resource_instance"], "param"))
}
# Declare an instance of the second resource type - this will call notice
example_get_param { 'show_notify': }
Takes a resource reference and name of the parameter and returns value of resource's parameter. Note that user defined resource types are evaluated lazily.
Would notice: 'the value we are getting in this example'
Note that since Puppet 4.0.0 it is possible to get a parameter value by using its data type and the [ ] operator. The example below is equivalent to a call to getparam(): ```Example_resource['example_resource_instance']['param']``
Returns: Any
value of a resource's parameter.
# define a resource type with a parameter
define example_resource($param) {
}
# declare an instance of that type
example_resource { "example_resource_instance":
param => "'the value we are getting in this example''"
}
# Because of order of evaluation, a second definition is needed
# that will be evaluated after the first resource has been declared
#
define example_get_param {
# This will notice the value of the parameter
notice(getparam(Example_resource["example_resource_instance"], "param"))
}
# Declare an instance of the second resource type - this will call notice
example_get_param { 'show_notify': }
Type: Ruby 3.x API
Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. The new function also has support for digging into a structured value. See the built-in
getvar
funct
$foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo
$datalocation = 'site::data'
$bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar
Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function. The new function also has support for digging into a structured value. See the built-in
getvar
funct
Returns: Any
undef - if variable does not exist
$foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo
$datalocation = 'site::data'
$bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar
Type: Ruby 3.x API
Uses same patterns as Dir#glob.
$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf'])
The glob function.
Returns: Any
Returns an Array of file entries of a directory or an Array of directories.
$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf'])
Type: Ruby 3.x API
Note: that since Puppet 4.0.0, the built-in
filter
function does the "same" - as any logic can be used to filter, as opposed to just regular expressions:['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }
grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd']
Note: that since Puppet 4.0.0, the built-in
filter
function does the "same" - as any logic can be used to filter, as opposed to just regular expressions:['aaa', 'bbb', 'ccc', 'aaaddd']. filter |$x| { $x =~ 'aaa' }
Returns: Any
array of elements that match the provided regular expression.
grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd']
Type: Ruby 3.x API
Valid kinds are macaddress
, netmask
, ipaddress
and network
.
has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false`
has_interface_with("ipaddress", "127.0.0.1") # Returns `true`
has_interface_with("lo") # Returns `true`
Valid kinds are macaddress
, netmask
, ipaddress
and network
.
Returns: Any
boolean values true
or false
has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false`
has_interface_with("ipaddress", "127.0.0.1") # Returns `true`
has_interface_with("lo") # Returns `true`
Type: Ruby 3.x API
This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison.
This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison.
Returns: Boolean
true
or false
Type: Ruby 3.x API
This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision.
This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision.
Returns: Any
Boolean value, true
if the client has an IP address within the requested network.
Type: Ruby 3.x API
Note: Deprecated since Puppet 4.0.0, this can now be achieved in the Puppet language with the following equivalent expression: $my_hash = {'key_one' => 'value_one'} if 'key_one' in $my_hash { notice('this will be printed')
$my_hash = {'key_one' => 'value_one'}
if has_key($my_hash, 'key_two') {
notice('we will not reach here')
}
if has_key($my_hash, 'key_one') {
notice('this will be printed')
}
Note: Deprecated since Puppet 4.0.0, this can now be achieved in the Puppet language with the following equivalent expression: $my_hash = {'key_one' => 'value_one'} if 'key_one' in $my_hash { notice('this will be printed')
Returns: Any
Boolean value
$my_hash = {'key_one' => 'value_one'}
if has_key($my_hash, 'key_two') {
notice('we will not reach here')
}
if has_key($my_hash, 'key_one') {
notice('this will be printed')
}
Type: Ruby 3.x API
Note: This function has been replaced with the built-in ability to create a new value of almost any data type - see the built-in
Hash.new
function in Puppet. This example shows the equivalent expression in the Puppet language:
Hash(['a',1,'b',2,'c',3])
Hash([['a',1],['b',2],['c',3]])
hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3}
Note: This function has been replaced with the built-in ability to create a new value of almost any data type - see the built-in
Hash.new
function in Puppet. This example shows the equivalent expression in the Puppet language:
Hash(['a',1,'b',2,'c',3])
Hash([['a',1],['b',2],['c',3]])
Returns: Any
the converted array as a hash
hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3}
Type: Ruby 3.x API
This function returns an array of the intersection of two.
intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"]
intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean)
The intersection function.
Returns: Any
an array of the intersection of two.
intersection(["a","b","c"],["b","c","d"]) # returns ["b","c"]
intersection(["a","b","c"],[1,2,3,4]) # returns [] (true, when evaluated as a Boolean)
Type: Ruby 4.x API
See the documentation for "The Puppet Type System" for more information about types.
See the assert_type()
function for flexible ways to assert the type of a value.
# check a data type
foo = 3
$bar = [1,2,3]
$baz = 'A string!'
if $foo.is_a(Integer) {
notify { 'foo!': }
}
if $bar.is_a(Array) {
notify { 'bar!': }
}
if $baz.is_a(String) {
notify { 'baz!': }
}
See the documentation for "The Puppet Type System" for more information about types.
See the assert_type()
function for flexible ways to assert the type of a value.
Returns: Boolean
Return's true
or false
.
# check a data type
foo = 3
$bar = [1,2,3]
$baz = 'A string!'
if $foo.is_a(Integer) {
notify { 'foo!': }
}
if $bar.is_a(Array) {
notify { 'bar!': }
}
if $baz.is_a(String) {
notify { 'baz!': }
}
Data type: Any
The value to be checked
Data type: Type
The expected type
Type: Ruby 4.x API
Wrapper that calls the Puppet 3.x function of the same name.
The is_absolute_path function.
Returns: Boolea
A boolean value returned from the called 3.x function.
Data type: Any
The main value that will be passed to the wrapped method
Data type: Any
Any additional values that are to be passed to the wrapped method
Type: Ruby 3.x API
This function works for windows and unix style paths.
*Note: Deprecated Will be removed in a future version of stdlib. See [
validate_legacy
](#validate_leg
$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet'
is_absolute_path($my_path)
$my_path2 = '/var/lib/puppet'
is_absolute_path($my_path2)
$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet']
is_absolute_path($my_path3)
$my_path4 = ['/var/lib/puppet']
is_absolute_path($my_path4)
is_absolute_path(true)
is_absolute_path('../var/lib/puppet')
is_absolute_path('var/lib/puppet')
$undefined = undef
is_absolute_path($undefined)
This function works for windows and unix style paths.
*Note: Deprecated Will be removed in a future version of stdlib. See [
validate_legacy
](#validate_leg
Returns: Boolean
Returns true
or false
$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet'
is_absolute_path($my_path)
$my_path2 = '/var/lib/puppet'
is_absolute_path($my_path2)
$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet']
is_absolute_path($my_path3)
$my_path4 = ['/var/lib/puppet']
is_absolute_path($my_path4)
is_absolute_path(true)
is_absolute_path('../var/lib/puppet')
is_absolute_path('var/lib/puppet')
$undefined = undef
is_absolute_path($undefined)
Type: Ruby 4.x API
Wrapper that calls the Puppet 3.x function of the same name.
The is_array function.
Returns: Boolea
A boolean value returned from the called 3.x function.
Data type: Any
The main value that will be passed to the wrapped method
Data type: Any
Any additional values that are to be passed to the wrapped method
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 4.x API
Wrapper that calls the Puppet 3.x function of the same name.
The is_bool function.
Returns: Boolea
A boolean value returned from the called 3.x function.
Data type: Any
The main value that will be passed to the wrapped method
Data type: Any
Any additional values that are to be passed to the wrapped method
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 4.x API
Wrapper that calls the Puppet 3.x function of the same name.
The is_float function.
Returns: Boolea
A boolean value returned from the called 3.x function.
Data type: Any
The main value that will be passed to the wrapped method
Data type: Any
Any additional values that are to be passed to the wrapped method
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 3.x API
This function accepts a string as an argument.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
This function accepts a string as an argument.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 3.x API
The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not be followed by other digits as this indicates that the value is octal (base 8).
If given any other argument false
is returned.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
The string may start with a '-' (minus). A value of '0' is allowed, but a leading '0' digit may not be followed by other digits as this indicates that the value is octal (base 8).
If given any other argument false
is returned.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 4.x API
Wrapper that calls the Puppet 3.x function of the same name.
The is_ip_address function.
Returns: Boolea
A boolean value returned from the called 3.x function.
Data type: Any
The main value that will be passed to the wrapped method
Data type: Any
Any additional values that are to be passed to the wrapped method
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 4.x API
Wrapper that calls the Puppet 3.x function of the same name.
The is_ipv4_address function.
Returns: Boolea
A boolean value returned from the called 3.x function.
Data type: Any
The main value that will be passed to the wrapped method
Data type: Any
Any additional values that are to be passed to the wrapped method
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 4.x API
Wrapper that calls the Puppet 3.x function of the same name.
The is_ipv6_address function.
Returns: Boolea
A boolean value returned from the called 3.x function.
Data type: Any
The main value that will be passed to the wrapped method
Data type: Any
Any additional values that are to be passed to the wrapped method
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 4.x API
Wrapper that calls the Puppet 3.x function of the same name.
The is_numeric function.
Returns: Boolea
A boolean value returned from the called 3.x function.
Data type: Any
The main value that will be passed to the wrapped method
Data type: Any
Any additional values that are to be passed to the wrapped method
Type: Ruby 3.x API
Returns true if the given argument is a Numeric (Integer or Float), or a String containing either a valid integer in decimal base 10 form, or a valid floating point string representation.
The function recognizes only decimal (base 10) integers and float but not integers in hex (base 16) or octal (base 8) form.
The string representation may start with a '-' (minus). If a decimal '.' is used, it must be followed by at least one digit.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns true if the given argument is a Numeric (Integer or Float), or a String containing either a valid integer in decimal base 10 form, or a valid floating point string representation.
The function recognizes only decimal (base 10) integers and float but not integers in hex (base 16) or octal (base 8) form.
The string representation may start with a '-' (minus). If a decimal '.' is used, it must be followed by at least one digit.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 4.x API
Wrapper that calls the Puppet 3.x function of the same name.
The is_string function.
Returns: Boolean
A boolean value returned from the called 3.x function.
Data type: Any
The main value that will be passed to the wrapped method
Data type: Any
Any additional values that are to be passed to the wrapped method
Type: Ruby 3.x API
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
*Note: Deprecated Will be removed in a future version of stdlib. See
validate_legacy
.
Returns: Boolean
Returns true
or false
Type: Ruby 3.x API
Note: Deprecated from Puppet 5.4.0 this function has been replaced with a built-in
join
function.
join(['a','b','c'], ",") # Results in: "a,b,c"
Note: Deprecated from Puppet 5.4.0 this function has been replaced with a built-in
join
function.
Returns: String
The String containing each of the array values
join(['a','b','c'], ",") # Results in: "a,b,c"
Type: Ruby 3.x API
Keys are cast to strings. If values are arrays, multiple keys are added for each element. The return value is an array in which each element is one joined key/value pair.
Note: Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual formatting of values in the array) - see the
new
function forString
and its formatting options forArray
andHash
.
join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"]
join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"]
Keys are cast to strings. If values are arrays, multiple keys are added for each element. The return value is an array in which each element is one joined key/value pair.
Note: Since Puppet 5.0.0 - for more detailed control over the formatting (including indentations and line breaks, delimiters around arrays and hash entries, between key/values in hash entries, and individual formatting of values in the array) - see the
new
function forString
and its formatting options forArray
andHash
.
Returns: Hash
The joined hash
join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"]
join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"]
Type: Ruby 3.x API
Note: Deprecated from Puppet 5.5.0, the built-in
keys
function will be used instead of this function.
Note: Deprecated from Puppet 5.5.0, the built-in
keys
function will be used instead of this function.
Returns: Array
An array containing each of the hashes key values.
Type: Ruby 4.x API
The original size() function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
length
function.
The original size() function did not handle Puppets new type capabilities, so this function is a Puppet 4 compatible solution.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
length
function.
Returns: Integer
The length of the given object
Data type: Variant[String,Array,Hash]
The value whose length is to be found
Type: Ruby 3.x API
This function loads the metadata of a given module.
$metadata = load_module_metadata('archive')
notify { $metadata['author']: }
The load_module_metadata function.
Returns: Any
The modules metadata
$metadata = load_module_metadata('archive')
notify { $metadata['author']: }
Type: Ruby 3.x API
The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed.
$myhash = loadjson('/etc/puppet/data/myhash.json')
$myhash = loadjson('https://example.local/my_hash.json')
$myhash = loadjson('https://username:password@example.local/my_hash.json')
$myhash = loadjson('no-file.json', {'default' => 'val
The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed.
Returns: Array|String|Hash
The data stored in the JSON file, the type depending on the type of data that was stored.
$myhash = loadjson('/etc/puppet/data/myhash.json')
$myhash = loadjson('https://example.local/my_hash.json')
$myhash = loadjson('https://username:password@example.local/my_hash.json')
$myhash = loadjson('no-file.json', {'default' => 'val
Type: Ruby 3.x API
The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed.
$myhash = loadyaml('/etc/puppet/data/myhash.yaml')
$myhash = loadyaml('https://example.local/my_hash.yaml')
$myhash = loadyaml('https://username:password@example.local/my_hash.yaml')
$myhash = loadyaml('no-file.yaml', {'default' => 'val
The first parameter can be a file path or a URL. The second parameter is the default value. It will be returned if the file was not found or could not be parsed.
Returns: Array|String|Hash
The data stored in the YAML file, the type depending on the type of data that was stored.
$myhash = loadyaml('/etc/puppet/data/myhash.yaml')
$myhash = loadyaml('https://example.local/my_hash.yaml')
$myhash = loadyaml('https://username:password@example.local/my_hash.yaml')
$myhash = loadyaml('no-file.yaml', {'default' => 'val
Type: Ruby 3.x API
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
lstrip
function.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
lstrip
function.
Returns: String
The stripped string
Type: Ruby 3.x API
Requires at least one argument.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
max
function.
Requires at least one argument.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
max
function.
Returns: Any
The highest value among those passed in
Type: Ruby 3.x API
The variable can be a string, fixnum, or array.
Note: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them.
Note: Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values the operator
in
can be used:'a' in ['a', 'b'] # true
For arrays by using operator-
to compute a diff:['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted
['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted
Note that since Puppet 5.2.0, the general form to test the content of an array or hash is to use the built-in
any
andall
functions.
member(['a','b'], 'b') # Returns: true
member(['a', 'b', 'c'], ['a', 'b']) # Returns: true
member(['a','b'], 'c') # Returns: false
member(['a', 'b', 'c'], ['d', 'b']) # Returns: false
The variable can be a string, fixnum, or array.
Note: This function does not support nested arrays. If the first argument contains nested arrays, it will not recurse through them.
Note: Since Puppet 4.0.0 the same can be performed in the Puppet language. For single values the operator
in
can be used:'a' in ['a', 'b'] # true
For arrays by using operator-
to compute a diff:['d', 'b'] - ['a', 'b', 'c'] == [] # false because 'd' is not subtracted
['a', 'b'] - ['a', 'b', 'c'] == [] # true because both 'a' and 'b' are subtracted
Note that since Puppet 5.2.0, the general form to test the content of an array or hash is to use the built-in
any
andall
functions.
Returns: Any
Returns whether the given value was a member of the array
member(['a','b'], 'b') # Returns: true
member(['a', 'b', 'c'], ['a', 'b']) # Returns: true
member(['a','b'], 'c') # Returns: false
member(['a', 'b', 'c'], ['d', 'b']) # Returns: false
Type: Ruby 4.x API
When there is a duplicate key, the key in the rightmost hash will "win."
Note that since Puppet 4.0.0 the same merge can be achieved with the + operator.
$merged_hash = $hash1 + $hash2
If merge is given a single Iterable (Array, Hash, etc.) it will call a given block with up to three parameters, and merge each resulting Hash into the accumulated result. All other types of values returned from the block (typically undef) are skipped (not merged).
The codeblock can take 2 or three parameters:
- with two, it gets the current hash (as built to this point), and each value (for hash the value is a [key, value] tuple)
- with three, it gets the current hash (as built to this point), the key/index of each value, and then the value
If the iterable is empty, or no hash was returned from the given block, an empty hash is returned. In the given block, a call to next()
will skip that entry, and a call to break()
will end the iteration.
The iterative merge()
has an advantage over doing the same with a general reduce()
in that the constructed hash
does not have to be copied in each iteration and thus will perform much better with large inputs.
$hash1 = {'one' => 1, 'two', => 2}
$hash2 = {'two' => 'dos', 'three', => 'tres'}
$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'}
['a', 'b', 'c', 'c', 'd', 'b'].merge | $hsh, $v | { { $v => $hsh[$v].lest || { 0 } + 1 } } # results in { a => 1, b => 2, c => 2, d => 1 }
['a', 'b', 'c', 'c', 'd', 'b', 'blah', 'blah'].merge | $hsh, $v | { if $v =~ String[1,1] { { $v => $hsh[$v].lest || { 0 } + 1 } } } # results in { a => 1, b => 2, c => 2, d => 1 }
The merge function.
Returns: Hash[Scalar,Any]
The merged hash
Data type: Variant[Hash[Scalar,Any], Undef, String[0,0]]
Repeated Param - The hashes that are to be merged
The merge function.
Returns: Hash
The merged hash
Data type: Iterable
Repeated Param - The hashes that are to be merged
Data type: Callable[3,3]
A block placed on the repeatable param args
The merge function.
Returns: Hash
The merged hash
Data type: Iterable
Repeated Param - The hashes that are to be merged
Data type: Callable[2,2]
A block placed on the repeatable param args
Type: Ruby 3.x API
When there is a duplicate key, the key in the rightmost hash will "win."
Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. `$merged_hash = $hash1 + $has
$hash1 = {'one' => 1, 'two', => 2}
$hash2 = {'two' => 'dos', 'three', => 'tres'}
$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'}
When there is a duplicate key, the key in the rightmost hash will "win."
Note that since Puppet 4.0.0 the same merge can be achieved with the + operator. `$merged_hash = $hash1 + $has
Returns: Hash
The merged hash
$hash1 = {'one' => 1, 'two', => 2}
$hash2 = {'two' => 'dos', 'three', => 'tres'}
$merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'}
Type: Ruby 3.x API
Requires at least one argument.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
min
function.
Requires at least one argument.
Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in
min
function.
Returns: Any
The lowest value among the given arguments
Type: Ruby 3.x API
Note: that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. See the new() function in Puppet for the many available type conversions.
Note: that since Puppet 5.0.0 the same can be achieved with the Puppet Type System. See the new() function in Puppet for the many available type conversions.
Returns: Boolean
Boolean(0) # false for any zero or negative number
Boolean(1) # true for any positive number
Type: Ruby 4.x API
Note: Only the major version is taken into account.
if os_version_gte('Debian', '9') { }
if os_version_gte('Ubuntu', '18.04') { }
Note: Only the major version is taken into account.
Returns: Boolean
true
or `false
if os_version_gte('Debian', '9') { }
if os_version_gte('Ubuntu', '18.04') { }
Data type: String[1]
operating system
Data type: String[1]
Type: Ruby 4.x API
This function accepts HOCON as a string and converts it into the correct Puppet structure
$data = parsehocon("{any valid hocon: string}")
The parsehocon function.
Returns: Data
$data = parsehocon("{any valid hocon: string}")
Data type: String
A valid HOCON string
Data type: Optional[Any]
An optional default to return if parsing hocon_string fails
Type: Ruby 3.x API
Note: The optional second argument can be used to pass a default value that will be returned if the parsing of the JSON string failed or if the JSON parse evaluated to nil.
Note: The optional second argument can be used to pass a default value that will be returned if the parsing of the JSON string failed or if the JSON parse evaluated to nil.
Returns: Any
convert JSON into Puppet structure
Type: Ruby 4.x API
For more information on PSON please see the following link: https://puppet.com/docs/puppet/7/http_api/pson.html
$data = parsepson('{"a":"1","b":"2"}')
For more information on PSON please see the following link: https://puppet.com/docs/puppet/7/http_api/pson.html
Returns: Data
$data = parsepson('{"a":"1","b":"2"}')
Data type: String[1]
A valid PSON string
Data type: Optional[Any]
An optional default to return if parsing the pson_string fails
Type: Ruby 3.x API
Note: The optional second argument can be used to pass a default value that will be returned if the parsing of YAML string have failed.
Note: The optional second argument can be used to pass a default value that will be returned if the parsing of YAML string have failed.
Returns: Any
converted YAML into Puppet structure
Type: Ruby 3.x API
This function is similar to a coalesce function in SQL.
Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following:
$real_jenkins_version = pick($::jenkins_version, '1.449')
Note: The value of $real_jenkins_version will first look for a top-scope variable called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ Enterprise Console are brought into Puppet as top-scope variables), and, failing that, will use a default value of 1.449.
This function is similar to a coalesce function in SQL.
Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following:
$real_jenkins_version = pick($::jenkins_version, '1.449')
Note: The value of $real_jenkins_version will first look for a top-scope variable called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ Enterprise Console are brought into Puppet as top-scope variables), and, failing that, will use a default value of 1.449.
Returns: Any
the first value in a list of values that is not undefined or an empty string.
Type: Ruby 3.x API
Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following:
Note: The value of $real_jenkins_version will first look for a top-scope variable called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ Enterprise Console are brought into Puppet as top-scope variables), and, failing that, will use a default value of 1.449.
Contrary to the pick() function, the pick_default does not fail if all arguments are empty. This allows pick_default to use an empty value as default.
Typically, this function is used to check for a value in the Puppet Dashboard/Enterprise Console, and failover to a default value like the following:
Note: The value of $real_jenkins_version will first look for a top-scope variable called 'jenkins_version' (note that parameters set in the Puppet Dashboard/ Enterprise Console are brought into Puppet as top-scope variables), and, failing that, will use a default value of 1.449.
Contrary to the pick() function, the pick_default does not fail if all arguments are empty. This allows pick_default to use an empty value as default.
Returns: Any
This function is similar to a coalesce function in SQL in that it will return
the first value in a list of values that is not undefined or an empty string
If no value is found, it will return the last argument.
Type: Ruby 4.x API
- Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes.
- Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes.
Returns: Any
An escaped string that can be safely used in a PowerShell command line.
Data type: Any
The string to escape
Type: Ruby 3.x API
Note: since Puppet 4.0.0 the general way to modify values is in array is by using the map function in Puppet. This example does the same as the example above: ['a', 'b', 'c'].map |$x| { "p${x}" }
prefix(['a','b','c'], 'p')
Will return: ['pa','pb','pc']
Note: since Puppet 4.0.0 the general way to modify values is in array is by using the map function in Puppet. This example does the same as the example above: ['a', 'b', 'c'].map |$x| { "p${x}" }
Returns: Hash
or [Array] The passed values now contains the passed prefix
prefix(['a','b','c'], 'p')
Will return: ['pa','pb','pc']
Type: Ruby 3.x API
Deprecated: Sets the current class or definition as private. Calling the class or definition from outside the current module will fail.
The private function.
Returns: Any
Sets the current class or definition as private
Type: Ruby 3.x API
This is useful for debugging manifest code at specific points during a compilation.
`pry()`
This is useful for debugging manifest code at specific points during a compilation.
Returns: Any
debugging information
`pry()`
Type: Ruby 3.x API
The first argument to this function is the password to hash. If it is undef or an empty string, this function returns undef.
The second argument to this function is which hash algorithm to use. It will be converted into the appropriate crypt(3) hash specifier. Valid hash types are:
Hash type | Prefix | Note |
---|---|---|
MD5 | 1 | |
SHA-256 | 5 | |
SHA-512 | 6 | Recommended |
bcrypt | 2b | |
bcrypt-a | 2a | bug compatible |
bcrypt-x | 2x | bug compatible |
bcrypt-y | 2y | historic alias for 2b |
The third argument to this function is the salt to use. For bcrypt-type hashes, the first two characters of the salt represent a strength parameter, with a value between 4 and 31 inclusive.
Note:: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function.
The first argument to this function is the password to hash. If it is undef or an empty string, this function returns undef.
The second argument to this function is which hash algorithm to use. It will be converted into the appropriate crypt(3) hash specifier. Valid hash types are:
Hash type | Prefix | Note |
---|---|---|
MD5 | 1 | |
SHA-256 | 5 | |
SHA-512 | 6 | Recommended |
bcrypt | 2b | |
bcrypt-a | 2a | bug compatible |
bcrypt-x | 2x | bug compatible |
bcrypt-y | 2y | historic alias for 2b |
The third argument to this function is the salt to use. For bcrypt-type hashes, the first two characters of the salt represent a strength parameter, with a value between 4 and 31 inclusive.
Note:: this uses the Puppet Server's implementation of crypt(3). If your environment contains several different operating systems, ensure that they are compatible before using this function.
Returns: String
Provides a crypt hash usable on most POSIX systems.
Type: Ruby 3.x API
NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail.
Note: Passing a third argument will cause the generated range to step by that interval, e.g.
The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for iterating a given number of times.
Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9
range("0", "9")
Will return: [0,1,2,3,4,5,6,7,8,9]
range("00", "09")
Will return: [0,1,2,3,4,5,6,7,8,9]
(Zero padded strings are converted to integers automatically)
range("a", "c")
Will return: ["a","b","c"]
range("host01", "host10")
Will return: ["host01", "host02", ..., "host09", "host10"]
range("0", "9", "2")
Will return: [0,2,4,6,8]
NB Be explicit in including trailing zeros. Otherwise the underlying ruby function will fail.
Note: Passing a third argument will cause the generated range to step by that interval, e.g.
The Puppet Language support Integer and Float ranges by using the type system. Those are suitable for iterating a given number of times.
Integer[0, 9].each |$x| { notice($x) } # notices 0, 1, 2, ... 9
Returns: Any
the range is extrapolated as an array
range("0", "9")
Will return: [0,1,2,3,4,5,6,7,8,9]
range("00", "09")
Will return: [0,1,2,3,4,5,6,7,8,9]
(Zero padded strings are converted to integers automatically)
range("a", "c")
Will return: ["a","b","c"]
range("host01", "host10")
Will return: ["host01", "host02", ..., "host09", "host10"]
range("0", "9", "2")
Will return: [0,2,4,6,8]
Type: Ruby 3.x API
Regexp escape a string or array of strings. Requires either a single string or an array as an input.
The regexpescape function.
Returns: String
A string of characters with metacharacters converted to their escaped form.
Type: Ruby 3.x API
Note: Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~
reject(['aaa','bbb','ccc','aaaddd'], 'aaa')
Would return: ['bbb','ccc']
Note: Since Puppet 4.0.0 the same is in general done with the filter function. Here is the equivalence of the reject() function: ['aaa','bbb','ccc','aaaddd'].filter |$x| { $x !~
Returns: Any
an array containing all the elements which doesn'' match the provided regular expression
reject(['aaa','bbb','ccc','aaaddd'], 'aaa')
Would return: ['bbb','ccc']
Type: Ruby 3.x API
Note: that the same can be done with the reverse_each() function in Puppet.
Note: that the same can be done with the reverse_each() function in Puppet.
Returns: Any
reversed string or array
Type: Ruby 3.x API
Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.
round(2.9) #=> 3
round(2.4) #=> 2
Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.
Returns: Any
the rounded value as integer
round(2.9) #=> 3
round(2.4) #=> 2
Type: Ruby 3.x API
Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.
Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.
Returns: Any
the string with leading spaces removed
Type: Ruby 3.x API
Generates a random whole number greater than or equal to 0 and less
than MAX, using the value of SEED for repeatable randomness. If SEED
starts with "$fqdn:", this is behaves the same as fqdn_rand
.
seeded_rand(MAX, SEED).
MAX must be a positive integer; SEED is any string.
Generates a random whole number greater than or equal to 0 and less
than MAX, using the value of SEED for repeatable randomness. If SEED
starts with "$fqdn:", this is behaves the same as fqdn_rand
.
Returns: Any
random number greater than or equal to 0 and less than MAX
seeded_rand(MAX, SEED).
MAX must be a positive integer; SEED is any string.
Type: Ruby 4.x API
Generates a consistent random string of specific length based on provided seed.
seeded_rand_string(8, "${module_name}::redis_password")
seeded_rand_string(5, '', 'abcdef')
The seeded_rand_string function.
Returns: String
Random string.
seeded_rand_string(8, "${module_name}::redis_password")
seeded_rand_string(5, '', 'abcdef')
Data type: Integer[1]
Length of string to be generated.
Data type: String
Seed string.
Data type: Optional[String[2]]
String that contains characters to use for the random string.
Type: Ruby 4.x API
- Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes.
This function behaves the same as ruby's Shellwords.shellescape() function.
- Note:* that the resulting string should be used unquoted and is not intended for use in double quotes nor in single quotes.
This function behaves the same as ruby's Shellwords.shellescape() function.
Returns: Any
An escaped string that can be safely used in a Bourne shell command line.
Data type: Any
The string to escape
Type: Ruby 3.x API
Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as ruby's Shellwords.shelljoin() function
Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined together, with a single space in between. This function behaves the same as ruby's Shellwords.shelljoin() function
Returns: Any
a command line string
Type: Ruby 3.x API
This function behaves the same as ruby's Shellwords.shellsplit() function
This function behaves the same as ruby's Shellwords.shellsplit() function
Returns: Any
array of tokens
Type: Ruby 3.x API
@summary Randomizes the order of a string or array elements.
@summary Randomizes the order of a string or array elements.
Returns: Any
randomized string or array
Type: Ruby 3.x API
Note: that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions of Puppet < 5.4.0 use the stdlib length() function.
Note: that since Puppet 5.4.0, the length() function in Puppet is preferred over this. For versions of Puppet < 5.4.0 use the stdlib length() function.
Returns: Any
the number of elements in a string, an array or a hash
Type: Ruby 3.x API
Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this.
Note that from Puppet 6.0.0 the same function in Puppet will be used instead of this.
Returns: Any
sorted string or array
Type: Ruby 4.x API
The first parameter is format string describing how the rest of the parameters in the hash
should be formatted. See the documentation for the Kernel::sprintf
function in Ruby for
all the details.
In the given argument hash with parameters, all keys are converted to symbols so they work
with the sprintf
function.
Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the
sprintf
function in puppet core.
$output = sprintf_hash('String: %<foo>s / number converted to binary: %<number>b',
{ 'foo' => 'a string', 'number' => 5 })
# $output = 'String: a string / number converted to binary: 101'
The first parameter is format string describing how the rest of the parameters in the hash
should be formatted. See the documentation for the Kernel::sprintf
function in Ruby for
all the details.
In the given argument hash with parameters, all keys are converted to symbols so they work
with the sprintf
function.
Note that since Puppet 4.10.10, and 5.3.4 this functionality is supported by the
sprintf
function in puppet core.
Returns: Any
The formatted string.
$output = sprintf_hash('String: %<foo>s / number converted to binary: %<number>b',
{ 'foo' => 'a string', 'number' => 5 })
# $output = 'String: a string / number converted to binary: 101'
Data type: String
The format to use.
Data type: Hash
Hash with parameters.
Type: Ruby 3.x API
Returns a new string where runs of the same character that occur in this set are replaced by a single character.
The squeeze function.
Returns: Any
a new string where runs of the same character that occur in this set are replaced by a single character.
Type: Ruby 4.x API
Run a CRC32 calculation against a given value.
stdlib::crc32('my string') == '18fbd270'
stdlib::crc32(sensitive('my string')) == '18fbd270'
stdlib::crc32(100.0) == 'a3fd429a'
stdlib::crc32(100.00000) == 'a3fd429a'
Run a CRC32 calculation against a given value.
Returns: String
String
stdlib::crc32('my string') == '18fbd270'
stdlib::crc32(sensitive('my string')) == '18fbd270'
stdlib::crc32(100.0) == 'a3fd429a'
stdlib::crc32(100.00000) == 'a3fd429a'
Data type: Variant[ScalarData, Sensitive[ScalarData], Binary, Sensitive[Binary]]
The ScalarData to evaluate
Type: Puppet Language
This function returns either a rendered template or a deferred function to render at runtime. If any of the values in the variables hash are deferred, then the template will be deferred.
Note: this function requires all parameters to be explicitly passed in. It cannot expect to use facts, class variables, and other variables in scope. This is because when deferred, we have to explicitly pass the entire scope to the client.
This function returns either a rendered template or a deferred function to render at runtime. If any of the values in the variables hash are deferred, then the template will be deferred.
Note: this function requires all parameters to be explicitly passed in. It cannot expect to use facts, class variables, and other variables in scope. This is because when deferred, we have to explicitly pass the entire scope to the client.
Returns: Variant[String, Deferred]
Data type: String
Data type: Hash
Type: Ruby 4.x API
Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String.
'foobar'.stdlib::end_with('bar') => true
'foobar'.stdlib::end_with('foo') => false
'foobar'.stdlib::end_with(['foo', 'baz']) => false
The stdlib::end_with function.
Returns: Boolean
True or False
'foobar'.stdlib::end_with('bar') => true
'foobar'.stdlib::end_with('foo') => false
'foobar'.stdlib::end_with(['foo', 'baz']) => false
Data type: String
The string to check
Data type: Variant[String[1],Array[String[1], 1]]
The suffixes to check
Type: Puppet Language
function to cast ensure parameter to resource specific value
stdlib::ensure(Variant[Boolean, Enum['present', 'absent']] $ensure, Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']] $resource = undef)
The stdlib::ensure function.
Returns: String
Data type: Variant[Boolean, Enum['present', 'absent']]
Data type: Optional[Enum['directory', 'link', 'mounted', 'service', 'file', 'package']]
Type: Ruby 4.x API
If Path is a Dotfile, or starts with a Period, then the starting Dot is not dealt with the Start of the Extension.
An empty String will also be returned, when the Period is the last Character in Path.
stdlib::extname('test.rb') => '.rb'
stdlib::extname('a/b/d/test.rb') => '.rb'
stdlib::extname('test') => ''
stdlib::extname('.profile') => ''
If Path is a Dotfile, or starts with a Period, then the starting Dot is not dealt with the Start of the Extension.
An empty String will also be returned, when the Period is the last Character in Path.
Returns: String
The Extension starting from the last Period
stdlib::extname('test.rb') => '.rb'
stdlib::extname('a/b/d/test.rb') => '.rb'
stdlib::extname('test') => ''
stdlib::extname('.profile') => ''
Data type: String
The Filename
Type: Ruby 4.x API
Returns true if the ipaddress is within the given CIDRs
stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true
The stdlib::ip_in_range function.
Returns: Boolean
True or False
stdlib::ip_in_range('10.10.10.53', '10.10.10.0/24') => true
Data type: String
The IP address to check
Data type: Variant[String, Array]
One CIDR or an array of CIDRs defining the range(s) to check against
Type: Ruby 4.x API
Returns true if str starts with one of the prefixes given. Each of the prefixes should be a String.
'foobar'.stdlib::start_with('foo') => true
'foobar'.stdlib::start_with('bar') => false
'foObar'.stdlib::start_with(['bar', 'baz']) => false
The stdlib::start_with function.
Returns: Boolean
True or False
'foobar'.stdlib::start_with('foo') => true
'foobar'.stdlib::start_with('bar') => false
'foObar'.stdlib::start_with(['bar', 'baz']) => false
Data type: String
The string to check
Data type: Variant[String[1],Array[String[1], 1]]
The prefixes to check.
Type: Ruby 4.x API
This attempts to convert a string like 'File[/foo]' into the
puppet resource File['/foo']
as detected by the catalog.
Things like 'File[/foo, /bar]' are not supported as a title might contain things like ',' or ' '. There is no clear value seperator to use.
This function can depend on the parse order of your manifests/modules as it inspects the catalog thus far.
stdlib::str2resource('File[/foo]') => File[/foo]
This attempts to convert a string like 'File[/foo]' into the
puppet resource File['/foo']
as detected by the catalog.
Things like 'File[/foo, /bar]' are not supported as a title might contain things like ',' or ' '. There is no clear value seperator to use.
This function can depend on the parse order of your manifests/modules as it inspects the catalog thus far.
Returns: Any
Puppet::Resource
stdlib::str2resource('File[/foo]') => File[/foo]
Data type: String
The string to lookup as a resource
Type: Ruby 4.x API
This function can encode strings such that they can be used directly in XML files. It supports encoding for both XML text (CharData) or attribute values (AttValue).
file { '/path/to/config.xml':
ensure => file,
content => epp(
'mymodule/config.xml.epp',
{
password => $password.stdlib::xml_encode,
},
),
}
This function can encode strings such that they can be used directly in XML files. It supports encoding for both XML text (CharData) or attribute values (AttValue).
Returns: String
Returns the encoded CharData or AttValue string suitable for use in XML
file { '/path/to/config.xml':
ensure => file,
content => epp(
'mymodule/config.xml.epp',
{
password => $password.stdlib::xml_encode,
},
),
}
Data type: String
The string to encode
Data type: Optional[Enum['text','attr']]
Whether to encode for text or an attribute
Type: Ruby 3.x API
Note: that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. See the function new() in Puppet for details what the Boolean data type supports.
Note: that since Puppet 5.0.0 the Boolean data type can convert strings to a Boolean value. See the function new() in Puppet for details what the Boolean data type supports.
Returns: Any
This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things
like: 0, F,f, N,n, false, FALSE, no to 'false'.
Type: Ruby 3.x API
Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. Note, however, that Apple changes what's required periodically and this may not work for the latest version of macOS. If that is the case you should get a helpful error message when Puppet tries to set the pasword using the parameters you provide to the user resource.
$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Use a s@lt h3r3 th@t is 32 byt3s', 50000)
user { 'jdoe':
ensure => present,
iterations => $pw_info['interations'],
password => $pw_info['password_hex'],
salt => $pw_info['salt_hex'],
}
$pw = Sensitive.new('Pa55w0rd')
$salt = Sensitive.new('Use a s@lt h3r3 th@t is 32 byt3s')
$pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000))
user { 'jdoe':
ensure => present,
iterations => unwrap($pw_info)['interations'],
password => unwrap($pw_info)['password_hex'],
salt => unwrap($pw_info)['salt_hex'],
}
Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+. Note, however, that Apple changes what's required periodically and this may not work for the latest version of macOS. If that is the case you should get a helpful error message when Puppet tries to set the pasword using the parameters you provide to the user resource.
Returns: Hash
Provides a hash containing the hex version of the password, the hex version of the salt, and iterations.
$pw_info = str2saltedpbkdf2('Pa55w0rd', 'Use a s@lt h3r3 th@t is 32 byt3s', 50000)
user { 'jdoe':
ensure => present,
iterations => $pw_info['interations'],
password => $pw_info['password_hex'],
salt => $pw_info['salt_hex'],
}
$pw = Sensitive.new('Pa55w0rd')
$salt = Sensitive.new('Use a s@lt h3r3 th@t is 32 byt3s')
$pw_info = Sensitive.new(str2saltedpbkdf2($pw, $salt, 50000))
user { 'jdoe':
ensure => present,
iterations => unwrap($pw_info)['interations'],
password => unwrap($pw_info)['password_hex'],
salt => unwrap($pw_info)['salt_hex'],
}
Type: Ruby 3.x API
Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute.
Given any simple string, you will get a hex version of a salted-SHA512 password hash that can be inserted into your Puppet manifests as a valid password attribute.
Returns: Any
converted string as a hex version of a salted-SHA512 password hash
Type: Ruby 3.x API
Note:: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.
strip(" aaa ")
Would result in: "aaa"
Note:: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.
Returns: Any
String or Array converted
strip(" aaa ")
Would result in: "aaa"
Type: Ruby 3.x API
Note: that since Puppet 4.0.0 the general way to modify values is in array is by using the map function in Puppet. This example does the same as the example above:
['a', 'b', 'c'].map |$x| { "${x}p" }
suffix(['a','b','c'], 'p')
Will return: ['ap','bp','cp']
Note: that since Puppet 4.0.0 the general way to modify values is in array is by using the map function in Puppet. This example does the same as the example above:
['a', 'b', 'c'].map |$x| { "${x}p" }
Returns: Any
Array or Hash with updated elements containing the passed suffix
suffix(['a','b','c'], 'p')
Will return: ['ap','bp','cp']
Type: Ruby 3.x API
This function will swap the existing case of a string.
swapcase("aBcD")
Would result in: "AbCd"
The swapcase function.
Returns: Any
string with uppercase alphabetic characters converted to lowercase and lowercase characters converted to uppercase
swapcase("aBcD")
Would result in: "AbCd"
Type: Ruby 3.x API
Note: that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and Timespan (a duration). The following example is equivalent to calling time() without any arguments:
Timestamp()
time()
Will return something like: 1311972653
Note: that since Puppet 4.8.0 the Puppet language has the data types Timestamp (a point in time) and Timespan (a duration). The following example is equivalent to calling time() without any arguments:
Timestamp()
Returns: Any
the current time since epoch as an integer.
time()
Will return something like: 1311972653
Type: Ruby 3.x API
Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB.
Takes a single string value as an argument. These conversions reflect a layperson's understanding of 1 MB = 1024 KB, when in fact 1 MB = 1000 KB, and 1 MiB = 1024 KiB.
Returns: Any
converted value into bytes
Type: Ruby 4.x API
Convert a data structure and output to JSON
file { '/tmp/my.json':
ensure => file,
content => to_json($myhash),
}
Convert a data structure and output to JSON
Returns: String
Converted data to JSON
file { '/tmp/my.json':
ensure => file,
content => to_json($myhash),
}
Data type: Any
Data structure which needs to be converted into JSON
Type: Ruby 4.x API
Convert data structure and output to pretty JSON
* how to output pretty JSON to file
file { '/tmp/my.json':
ensure => file,
content => to_json_pretty($myhash),
}
* how to output pretty JSON skipping over keys with undef values
file { '/tmp/my.json':
ensure => file,
content => to_json_pretty({
param_one => 'value',
param_two => undef,
}, true),
}
* how to output pretty JSON using tabs for indentation
file { '/tmp/my.json':
ensure => file,
content => to_json_pretty({
param_one => 'value',
param_two => {
param_more => 42,
},
}, nil, {indent => ' '}),
}
`to_json_pretty(Variant[Hash, Array] $data, Optional[Optional[Boolean]] $skip_undef, Optional[Struct[{
indent => Optional[String], space => Optional[String], space_before => Optional[String], object_nl => Optional[String], array_nl => Optional[String], allow_nan => Optional[Boolean], max_nesting => Optional[Integer[-1,default]], }]] $opts)`
The to_json_pretty function.
Returns: Any
converted data to pretty json
* how to output pretty JSON to file
file { '/tmp/my.json':
ensure => file,
content => to_json_pretty($myhash),
}
* how to output pretty JSON skipping over keys with undef values
file { '/tmp/my.json':
ensure => file,
content => to_json_pretty({
param_one => 'value',
param_two => undef,
}, true),
}
* how to output pretty JSON using tabs for indentation
file { '/tmp/my.json':
ensure => file,
content => to_json_pretty({
param_one => 'value',
param_two => {
param_more => 42,
},
}, nil, {indent => ' '}),
}
Data type: Variant[Hash, Array]
data structure which needs to be converted to pretty json
Data type: Optional[Optional[Boolean]]
value true
or false
Data type: Optional[Struct[{ indent => Optional[String], space => Optional[String], space_before => Optional[String], object_nl => Optional[String], array_nl => Optional[String], allow_nan => Optional[Boolean], max_nesting => Optional[Integer[-1,default]], }]]
hash-map of settings passed to JSON.pretty_generate, see
https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate.
Note that max_nesting
doesn't take the value false
; use -1
instead.
Type: Ruby 4.x API
Convert an object into a String containing its Python representation
# output Python to a file
$listen = '0.0.0.0'
$port = 8000
file { '/opt/acme/etc/settings.py':
content => inline_epp(@("SETTINGS")),
LISTEN = <%= $listen.to_python %>
PORT = <%= $mailserver.to_python %>
| SETTINGS
}
The to_python function.
Returns: String
The String representation of the object
# output Python to a file
$listen = '0.0.0.0'
$port = 8000
file { '/opt/acme/etc/settings.py':
content => inline_epp(@("SETTINGS")),
LISTEN = <%= $listen.to_python %>
PORT = <%= $mailserver.to_python %>
| SETTINGS
}
Data type: Any
The object to be converted
Type: Ruby 4.x API
Convert an object into a String containing its Ruby representation
# output Ruby to a file
$listen = '0.0.0.0'
$port = 8000
file { '/opt/acme/etc/settings.rb':
content => inline_epp(@("SETTINGS")),
LISTEN = <%= $listen.to_ruby %>
PORT = <%= $mailserver.to_ruby %>
| SETTINGS
}
The to_ruby function.
Returns: String
The String representation of the object
# output Ruby to a file
$listen = '0.0.0.0'
$port = 8000
file { '/opt/acme/etc/settings.rb':
content => inline_epp(@("SETTINGS")),
LISTEN = <%= $listen.to_ruby %>
PORT = <%= $mailserver.to_ruby %>
| SETTINGS
}
Data type: Any
The object to be converted
Type: Ruby 4.x API
Convert a data structure and output to TOML.
file { '/tmp/config.toml':
ensure => file,
content => to_toml($myhash),
}
The to_toml function.
Returns: String
Converted data as TOML string
file { '/tmp/config.toml':
ensure => file,
content => to_toml($myhash),
}
Data type: Hash
Data structure which needs to be converted into TOML
Type: Ruby 4.x API
Convert a data structure and output it as YAML
file { '/tmp/my.yaml':
ensure => file,
content => to_yaml($myhash),
}
file { '/tmp/my.yaml':
ensure => file,
content => to_yaml($myhash, {indentation => 4})
}
Convert a data structure and output it as YAML
Returns: String
The YAML document
file { '/tmp/my.yaml':
ensure => file,
content => to_yaml($myhash),
}
file { '/tmp/my.yaml':
ensure => file,
content => to_yaml($myhash, {indentation => 4})
}
Data type: Any
The data you want to convert to YAML
Data type: Optional[Hash]
A hash of options that will be passed to Ruby's Psych library. Note, this could change between Puppet versions, but at time of writing these are line_width
, indentation
, and canonical
.
Type: Ruby 3.x API
Key can contain slashes to describe path components. The function will go down the structure and try to extract the required value. `` $data = { 'a' => { 'b' => [ 'b1', 'b2', 'b3', ] } }
$value = try_get_value($data, 'a/b/2', 'not_found', '/') => $value = 'b3'
a -> first hash key b -> second hash key 2 -> array index starting with 0
not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil. / -> (optional) path delimiter. Defaults to '/'.
In addition to the required "key" argument, "try_get_value" accepts default
argument. It will be returned if no value was found or a path component is
missing. And the fourth argument can set a variable path separator.
#### `try_get_value()`
Key can contain slashes to describe path components. The function will go down
the structure and try to extract the required value.
``
$data = {
'a' => {
'b' => [
'b1',
'b2',
'b3',
]
}
}
$value = try_get_value($data, 'a/b/2', 'not_found', '/')
=> $value = 'b3'
a -> first hash key
b -> second hash key
2 -> array index starting with 0
not_found -> (optional) will be returned if there is no value or the path did not match. Defaults to nil.
/ -> (optional) path delimiter. Defaults to '/'.
In addition to the required "key" argument, "try_get_value" accepts default argument. It will be returned if no value was found or a path component is missing. And the fourth argument can set a variable path separator.
Returns: Any
Looks up into a complex structure of arrays and hashes and returns a value
or the default value if nothing was found.
Type: Ruby 3.x API
please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.
- string
- array
- hash
- float
- integer
- boolean
please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or migrate to the new parser's typing system.
- string
- array
- hash
- float
- integer
- boolean
Returns: Any
the type when passed a value. Type can be one of:
Type: Ruby 3.x API
- string
- array
- hash
- float
- integer
- boolean
- string
- array
- hash
- float
- integer
- boolean
Returns: Any
the type when passed a value. Type can be one of:
Type: Ruby 4.x API
See the documentation for "The Puppet Type System" for more information about types.
See the assert_type()
function for flexible ways to assert the type of a value.
The built-in type() function in puppet is generally preferred over this function this function is provided for backwards compatibility.
# compare the types of two values
if type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") }
unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") }
unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") }
See the documentation for "The Puppet Type System" for more information about types.
See the assert_type()
function for flexible ways to assert the type of a value.
The built-in type() function in puppet is generally preferred over this function this function is provided for backwards compatibility.
Returns: String
the type of the passed value
# compare the types of two values
if type_of($first_value) != type_of($second_value) { fail("first_value and second_value are different types") }
unless type_of($first_value) <= Numeric { fail("first_value must be Numeric") }
unless type_of{$first_value) <= Collection[1] { fail("first_value must be an Array or Hash, and contain at least one element") }
Data type: Any
Type: Ruby 3.x API
This function returns a union of two or more arrays.
union(["a","b","c"],["b","c","d"])
Would return: ["a","b","c","d"]
The union function.
Returns: Any
a unionized array of two or more arrays
union(["a","b","c"],["b","c","d"])
Would return: ["a","b","c","d"]
Type: Ruby 3.x API
This function will remove duplicates from strings and arrays.
unique("aabbcc")
Will return: abc
You can also use this with arrays:
unique(["a","a","b","b","c","c"])
This returns: ["a","b","c"]
The unique function.
Returns: Any
String or array with duplicates removed
unique("aabbcc")
Will return: abc
You can also use this with arrays:
unique(["a","a","b","b","c","c"])
This returns: ["a","b","c"]
Type: Ruby 3.x API
Takes a single string argument.
Takes a single string argument.
Returns: Any
the DOS version of the given string.
Type: Ruby 3.x API
Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.
upcase("abcd")
Will return ABCD
Note: from Puppet 6.0.0, the compatible function with the same name in Puppet core will be used instead of this function.
Returns: Any
converted string ot array of strings to uppercase
upcase("abcd")
Will return ABCD
Type: Ruby 3.x API
Urlencodes a string or array of strings. Requires either a single string or an array as an input.
The uriescape function.
Returns: String
a string that contains the converted value
Type: Ruby 4.x API
Validate the string represents an absolute path in the filesystem.
The validate_absolute_path function.
Returns: Boolean
A boolean value returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths.
The following values will pass:
$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet'
validate_absolute_path($my_path)
$my_path2 = '/var/lib/puppet'
validate_absolute_path($my_path2)
$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet']
validate_absolute_path($my_path3)
$my_path4 = ['/var/lib/puppet','/usr/share/puppet']
validate_absolute_path($my_path4)
The following values will fail, causing compilation to abort:
validate_absolute_path(true)
validate_absolute_path('../var/lib/puppet')
validate_absolute_path('var/lib/puppet')
validate_absolute_path([ 'var/lib/puppet', '/var/foo' ])
validate_absolute_path([ '/var/lib/puppet', 'var/foo' ])
$undefined = undef
validate_absolute_path($undefin
The validate_absolute_path function.
Returns: Any
passes when the string is an absolute path or raise an error when it is not and fails compilation
The following values will pass:
$my_path = 'C:/Program Files (x86)/Puppet Labs/Puppet'
validate_absolute_path($my_path)
$my_path2 = '/var/lib/puppet'
validate_absolute_path($my_path2)
$my_path3 = ['C:/Program Files (x86)/Puppet Labs/Puppet','C:/Program Files/Puppet Labs/Puppet']
validate_absolute_path($my_path3)
$my_path4 = ['/var/lib/puppet','/usr/share/puppet']
validate_absolute_path($my_path4)
The following values will fail, causing compilation to abort:
validate_absolute_path(true)
validate_absolute_path('../var/lib/puppet')
validate_absolute_path('var/lib/puppet')
validate_absolute_path([ 'var/lib/puppet', '/var/foo' ])
validate_absolute_path([ '/var/lib/puppet', 'var/foo' ])
$undefined = undef
validate_absolute_path($undefin
Type: Ruby 4.x API
Validate the passed value represents an array.
The validate_array function.
Returns: Any
A boolean value (true
or false
) returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check.
The following values will pass:
$my_array = [ 'one', 'two' ]
validate_array($my_array)
The following values will fail, causing compilation to abort:
validate_array(true)
validate_array('some_string')
$undefined = undef
validate_array($undefined
The validate_array function.
Returns: Any
validate array
The following values will pass:
$my_array = [ 'one', 'two' ]
validate_array($my_array)
The following values will fail, causing compilation to abort:
validate_array(true)
validate_array('some_string')
$undefined = undef
validate_array($undefined
Type: Ruby 3.x API
The first argument of this function should be a string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation will abort with a parse error.
A third argument can be specified, listing paths which should
not be found in the file. The $file
variable points to the location
of the temporary file being tested in the Augeas tree.
If you want to make sure your passwd content never contains
a user `foo`, you could write:
validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo'])
If you wanted to ensure that no users used the '/bin/barsh' shell,
you could use:
validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]']
If a fourth argument is specified, this will be the error message raised and
seen by the user.
A helpful error message can be returned like this:
validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas')
The first argument of this function should be a string to test, and the second argument should be the name of the Augeas lens to use. If Augeas fails to parse the string with the lens, the compilation will abort with a parse error.
A third argument can be specified, listing paths which should
not be found in the file. The $file
variable points to the location
of the temporary file being tested in the Augeas tree.
Returns: Any
validate string using an Augeas lens
If you want to make sure your passwd content never contains
a user `foo`, you could write:
validate_augeas($passwdcontent, 'Passwd.lns', ['$file/foo'])
If you wanted to ensure that no users used the '/bin/barsh' shell,
you could use:
validate_augeas($passwdcontent, 'Passwd.lns', ['$file/*[shell="/bin/barsh"]']
If a fourth argument is specified, this will be the error message raised and
seen by the user.
A helpful error message can be returned like this:
validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas')
Type: Ruby 4.x API
Validate the passed value represents a boolean.
The validate_bool function.
Returns: Boolean
true
or false
A boolean value returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check.
The following values will pass:
$iamtrue = true
validate_bool(true)
validate_bool(true, true, false, $iamtrue)
The following values will fail, causing compilation to abort:
$some_array = [ true ]
validate_bool("false")
validate_bool("true")
validate_bool($some_array)
The validate_bool function.
Returns: Any
validate boolean
The following values will pass:
$iamtrue = true
validate_bool(true)
validate_bool(true, true, false, $iamtrue)
The following values will fail, causing compilation to abort:
$some_array = [ true ]
validate_bool("false")
validate_bool("true")
validate_bool($some_array)
Type: Ruby 3.x API
The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user.
A helpful error message can be returned like this:
Defaults to end of path
validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content')
% as file location
validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content')
The first argument of this function should be a string to test, and the second argument should be a path to a test command taking a % as a placeholder for the file path (will default to the end). If the command, launched against a tempfile containing the passed string, returns a non-null value, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user.
A helpful error message can be returned like this:
Returns: Any
validate of a string with an external command
Defaults to end of path
validate_cmd($sudoerscontent, '/usr/sbin/visudo -c -f', 'Visudo failed to validate sudoers content')
% as file location
validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content')
Type: Ruby 3.x API
Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check.
The following values will pass:
$my_domain_name = 'server.domain.tld'
validate_domain_name($my_domain_name)
validate_domain_name('domain.tld', 'puppet.com', $my_domain_name)
The following values will fail, causing compilation to abort:
validate_domain_name(1)
validate_domain_name(true)
validate_domain_name('invalid domain')
validate_domain_name('-foo.example.com')
validate_domain_name('www.example.2com')
The validate_domain_name function.
Returns: Any
passes when the given values are syntactically correct domain names or raise an error when they are not and fails compilation
The following values will pass:
$my_domain_name = 'server.domain.tld'
validate_domain_name($my_domain_name)
validate_domain_name('domain.tld', 'puppet.com', $my_domain_name)
The following values will fail, causing compilation to abort:
validate_domain_name(1)
validate_domain_name(true)
validate_domain_name('invalid domain')
validate_domain_name('-foo.example.com')
validate_domain_name('www.example.2com')
Type: Ruby 3.x API
Validate that all values passed are valid email addresses. Fail compilation if any value fails this check.
The following values will pass:
$my_email = "waldo@gmail.com"
validate_email_address($my_email)
validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email)
The following values will fail, causing compilation to abort:
$some_array = [ 'bad_email@/d/efdf.com' ]
validate_email_address($some_array)
The validate_email_address function.
Returns: Any
Fail compilation if any value fails this check.
The following values will pass:
$my_email = "waldo@gmail.com"
validate_email_address($my_email)
validate_email_address("bob@gmail.com", "alice@gmail.com", $my_email)
The following values will fail, causing compilation to abort:
$some_array = [ 'bad_email@/d/efdf.com' ]
validate_email_address($some_array)
Type: Ruby 4.x API
Validate the passed value represents a hash.
The validate_hash function.
Returns: Any
A boolean value (true
or false
) returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check.
The following values will pass:
$my_hash = { 'one' => 'two' }
validate_hash($my_hash)
The following values will fail, causing compilation to abort:
validate_hash(true)
validate_hash('some_string')
$undefined = undef
validate_hash($undefined)
The validate_hash function.
Returns: Any
validate hash
The following values will pass:
$my_hash = { 'one' => 'two' }
validate_hash($my_hash)
The following values will fail, causing compilation to abort:
validate_hash(true)
validate_hash('some_string')
$undefined = undef
validate_hash($undefined)
Type: Ruby 4.x API
Validate the passed value represents an integer.
The validate_integer function.
Returns: Boolean
true
or false
A boolean value returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer.
The following values will pass:
validate_integer(1)
validate_integer(1, 2)
validate_integer(1, 1)
validate_integer(1, 2, 0)
validate_integer(2, 2, 2)
validate_integer(2, '', 0)
validate_integer(2, undef, 0)
$foo = undef
validate_integer(2, $foo, 0)
validate_integer([1,2,3,4,5], 6)
validate_integer([1,2,3,4,5], 6, 0)
Plus all of the above, but any combination of values passed as strings ('1' or "1").
Plus all of the above, but with (correct) combinations of negative integer values.
The following values will not:
validate_integer(true)
validate_integer(false)
validate_integer(7.0)
validate_integer({ 1 => 2 })
$foo = undef
validate_integer($foo)
validate_integer($foobaridontexist)
validate_integer(1, 0)
validate_integer(1, true)
validate_integer(1, '')
validate_integer(1, undef)
validate_integer(1, , 0)
validate_integer(1, 2, 3)
validate_integer(1, 3, 2)
validate_integer(1, 3, true)
Plus all of the above, but any combination of values passed as strings ('false' or "false").
Plus all of the above, but with incorrect combinations of negative integer values.
Plus all of the above, but with non-integer items in arrays or maximum / minimum argument.
The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. It will fail if the first argument is not an integer or array of integers, and if arg 2 and arg 3 are not convertable to an integer.
Returns: Any
Validate that the first argument is an integer (or an array of integers). Fail compilation if any of the checks fail.
The following values will pass:
validate_integer(1)
validate_integer(1, 2)
validate_integer(1, 1)
validate_integer(1, 2, 0)
validate_integer(2, 2, 2)
validate_integer(2, '', 0)
validate_integer(2, undef, 0)
$foo = undef
validate_integer(2, $foo, 0)
validate_integer([1,2,3,4,5], 6)
validate_integer([1,2,3,4,5], 6, 0)
Plus all of the above, but any combination of values passed as strings ('1' or "1").
Plus all of the above, but with (correct) combinations of negative integer values.
The following values will not:
validate_integer(true)
validate_integer(false)
validate_integer(7.0)
validate_integer({ 1 => 2 })
$foo = undef
validate_integer($foo)
validate_integer($foobaridontexist)
validate_integer(1, 0)
validate_integer(1, true)
validate_integer(1, '')
validate_integer(1, undef)
validate_integer(1, , 0)
validate_integer(1, 2, 3)
validate_integer(1, 3, 2)
validate_integer(1, 3, true)
Plus all of the above, but any combination of values passed as strings ('false' or "false").
Plus all of the above, but with incorrect combinations of negative integer values.
Plus all of the above, but with non-integer items in arrays or maximum / minimum argument.
Type: Ruby 4.x API
Validate the passed value represents an ip_address.
The validate_ip_address function.
Returns: Boolean
true
or false
A boolean value returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check.
The following values will pass:
$my_ip = "1.2.3.4"
validate_ip_address($my_ip)
validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip)
$my_ip = "3ffe:505:2"
validate_ip_address(1)
validate_ip_address($my_ip)
validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip)
The following values will fail, causing compilation to abort:
$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ]
validate_ip_address($some_array)
The validate_ip_address function.
Returns: Any
passes when the given values are valid IP addresses or raise an error when they are not and fails compilation
The following values will pass:
$my_ip = "1.2.3.4"
validate_ip_address($my_ip)
validate_ip_address("8.8.8.8", "172.16.0.1", $my_ip)
$my_ip = "3ffe:505:2"
validate_ip_address(1)
validate_ip_address($my_ip)
validate_ip_address("fe80::baf6:b1ff:fe19:7507", $my_ip)
The following values will fail, causing compilation to abort:
$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ]
validate_ip_address($some_array)
Type: Ruby 4.x API
Validate the passed value represents an ipv4_address.
The validate_ipv4_address function.
Returns: Boolean
true
or false
A boolean value returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check.
The following values will pass:
$my_ip = "1.2.3.4"
validate_ipv4_address($my_ip)
validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip)
The following values will fail, causing compilation to abort:
$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ]
validate_ipv4_address($some_array)
The validate_ipv4_address function.
Returns: Any
passes when the given values are valid IPv4 addresses or raise an error when they are not and fails compilation
The following values will pass:
$my_ip = "1.2.3.4"
validate_ipv4_address($my_ip)
validate_ipv4_address("8.8.8.8", "172.16.0.1", $my_ip)
The following values will fail, causing compilation to abort:
$some_array = [ 1, true, false, "garbage string", "3ffe:505:2" ]
validate_ipv4_address($some_array)
Type: Ruby 4.x API
Validate the passed value represents an ipv6_address.
The validate_ipv6_address function.
Returns: Boolean
true
or false
A boolean value returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check.
The following values will pass:
$my_ip = "3ffe:505:2"
validate_ipv6_address(1)
validate_ipv6_address($my_ip)
validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip)
The following values will fail, causing compilation to abort:
$some_array = [ true, false, "garbage string", "1.2.3.4" ]
validate_ipv6_address($some_array)
The validate_ipv6_address function.
Returns: Any
passes when the given values are valid IPv6 addresses or raise an error when they are not and fails compilation
The following values will pass:
$my_ip = "3ffe:505:2"
validate_ipv6_address(1)
validate_ipv6_address($my_ip)
validate_bool("fe80::baf6:b1ff:fe19:7507", $my_ip)
The following values will fail, causing compilation to abort:
$some_array = [ true, false, "garbage string", "1.2.3.4" ]
validate_ipv6_address($some_array)
Type: Ruby 4.x API
Validate a value against both the target_type (new) and the previous_validation function (old).
The function checks a value against both the target_type (new) and the previous_validation function (old).
Returns: Any
A boolean value (true
or false
) returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Type
Data type: String
Data type: Any
Data type: Any
Any additional values that are to be passed to the method
The validate_legacy function.
Returns: Any
Legacy validation method
Data type: Any
The main value that will be passed to the method
Data type: String
Data type: String
Data type: Any
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 4.x API
Validate the passed value represents a numeric value.
The validate_numeric function.
Returns: Boolean
true
or false
A boolean value returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric.
For passing and failing usage, see validate_integer()
. It is all the same for validate_numeric, yet now floating point values are allowed, too.
The second argument is optional and passes a maximum. (All elements of) the first argument has to be less or equal to this max. The third argument is optional and passes a minimum. (All elements of) the first argument has to be greater or equal to this min. If, and only if, a minimum is given, the second argument may be an empty string or undef, which will be handled to just check if (all elements of) the first argument are greater or equal to the given minimum. It will fail if the first argument is not a numeric (Integer or Float) or array of numerics, and if arg 2 and arg 3 are not convertable to a numeric.
For passing and failing usage, see validate_integer()
. It is all the same for validate_numeric, yet now floating point values are allowed, too.
Returns: Any
Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail.
Type: Ruby 4.x API
Perform validation of a string against one or more regular expressions.
The validate_re function.
Returns: Boolean
true
or false
returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions
Type: Ruby 3.x API
The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user.
Note: Compilation will also abort, if the first argument is not a String. Always use quotes to force stringification: validate_re("${::operatingsystemmajrelease}", '^[57]$')
The following strings will validate against the regular expressions:
validate_re('one', '^one$')
validate_re('one', [ '^one', '^two' ])
The following strings will fail to validate, causing compilation to abort:
validate_re('one', [ '^two', '^three' ])
A helpful error message can be returned like this:
validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7')
The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions. If none of the regular expressions match the string passed in, compilation will abort with a parse error. If a third argument is specified, this will be the error message raised and seen by the user.
Note: Compilation will also abort, if the first argument is not a String. Always use quotes to force stringification: validate_re("${::operatingsystemmajrelease}", '^[57]$')
Returns: Any
validation of a string against one or more regular expressions.
The following strings will validate against the regular expressions:
validate_re('one', '^one$')
validate_re('one', [ '^one', '^two' ])
The following strings will fail to validate, causing compilation to abort:
validate_re('one', [ '^two', '^three' ])
A helpful error message can be returned like this:
validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7')
Type: Ruby 4.x API
Validate that a passed string has length less/equal with the passed value
Validate that a passed string has length less/equal with the passed value
Returns: Boolean
true
or false
A boolean value returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, and if arg 2 and arg 3 are not convertable to a number.
The following values will pass:
validate_slength("discombobulate",17)
validate_slength(["discombobulate","moo"],17)
validate_slength(["discombobulate","moo"],17,3)
The following valueis will not:
validate_slength("discombobulate",1)
validate_slength(["discombobulate","thermometer"],5)
validate_slength(["discombobulate","moo"],17,10)
An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, and if arg 2 and arg 3 are not convertable to a number.
Returns: Any
validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. Fail compilation if any of the checks fail.
The following values will pass:
validate_slength("discombobulate",17)
validate_slength(["discombobulate","moo"],17)
validate_slength(["discombobulate","moo"],17,3)
The following valueis will not:
validate_slength("discombobulate",1)
validate_slength(["discombobulate","thermometer"],5)
validate_slength(["discombobulate","moo"],17,10)
Type: Ruby 4.x API
Validate that all passed values are string data structures.
The validate_string function.
Returns: Boolean
true
or false
A boolean value returned from the called function.
Data type: Any
The main value that will be passed to the method
Data type: Any
Any additional values that are to be passed to the method
Type: Ruby 3.x API
Note: Validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). Instead, use:
if $var == undef {
fail('...')
}
The following values will pass:
$my_string = "one two"
validate_string($my_string, 'three')
The following values will fail, causing compilation to abort:
validate_string(true)
validate_string([ 'some', 'array' ])
Note: Validate_string(undef) will not fail in this version of the functions API (incl. current and future parser). Instead, use:
if $var == undef {
fail('...')
}
Returns: Any
Validate that all passed values are string data structures. Failed
compilation if any value fails this check.
The following values will pass:
$my_string = "one two"
validate_string($my_string, 'three')
The following values will fail, causing compilation to abort:
validate_string(true)
validate_string([ 'some', 'array' ])
Type: Ruby 3.x API
Verifies that the certficate's signature was created from the supplied key.
validate_x509_rsa_key_pair($cert, $key)
Verifies that the certficate's signature was created from the supplied key.
validate_x509_rsa_key_pair($cert, $key)
Returns: Any
Fail compilation if any value fails this check.
Type: Ruby 3.x API
Note: From Puppet 5.5.0, the compatible function with the same name in Puppet core will be used instead of this function.
$hash = {
'a' => 1,
'b' => 2,
'c' => 3,
}
values($hash)
This example would return: ```[1,2,3]```
Note: From Puppet 5.5.0, the compatible function with the same name in Puppet core will be used instead of this function.
Returns: Any
array of values
$hash = {
'a' => 1,
'b' => 2,
'c' => 3,
}
values($hash)
This example would return: ```[1,2,3]```
Type: Ruby 3.x API
The first argument is the array you want to analyze, and the second element can be a combination of:
- A single numeric index
- A range in the form of 'start-stop' (eg. 4-9)
- An array combining the above
Note: Since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. A negative value is taken to be "from the end" of the array:
['a', 'b', 'c', 'd'][1, 2]
results in ['b', 'c']
['a', 'b', 'c', 'd'][2, -1]
results in ['c', 'd']
['a', 'b', 'c', 'd'][1, -2]
results in ['b', 'c']
values_at(['a','b','c'], 2)
Would return ['c']
values_at(['a','b','c'], ["0-1"])
Would return ['a','b']
values_at(['a','b','c','d','e'], [0, "2-3"])
Would return ['a','c','d']
The first argument is the array you want to analyze, and the second element can be a combination of:
- A single numeric index
- A range in the form of 'start-stop' (eg. 4-9)
- An array combining the above
Note: Since Puppet 4.0.0 it is possible to slice an array with index and count directly in the language. A negative value is taken to be "from the end" of the array:
['a', 'b', 'c', 'd'][1, 2]
results in ['b', 'c']
['a', 'b', 'c', 'd'][2, -1]
results in ['c', 'd']
['a', 'b', 'c', 'd'][1, -2]
results in ['b', 'c']
Returns: Any
an array of values identified by location
values_at(['a','b','c'], 2)
Would return ['c']
values_at(['a','b','c'], ["0-1"])
Would return ['a','b']
values_at(['a','b','c','d','e'], [0, "2-3"])
Would return ['a','c','d']
Type: Ruby 3.x API
Takes one element from first array and merges corresponding elements from second array.
zip(['1','2','3'],['4','5','6'])
Would result in: ["1", "4"], ["2", "5"], ["3", "6"]
The zip function.
Returns: Any
This generates a sequence of n-element arrays, where n is one more than the count of arguments.
zip(['1','2','3'],['4','5','6'])
Would result in: ["1", "4"], ["2", "5"], ["3", "6"]
A strict absolutepath type
Alias of
Variant[Stdlib::Windowspath, Stdlib::Unixpath]
Type to match base32 String
Alias of
Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/]
Type to match base64 String
Alias of
Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/]
The first pattern is originally from is_absolute_path, which had it from 2.7.x's lib/puppet/util.rb Puppet::Util.absolute_path? slash = '[\\/]' name = '[^\\\\/]+' %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}?#{slash}#{name}))!i,
Alias of
Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]]
Emulate the is_array and validate_array functions
Alias of
Array[Any]
Emulate the is_bool and validate_bool functions
Alias of
Boolean
The regex is what's currently used in is_float To keep your development moving forward, you can also add a deprecation warning using the Integer type:
class example($value) { validate_float($value,) }
would turn into
class example(Stdlib::Compat::Float $value) {
validate_float($value, 10, 0)
assert_type(Integer[0, 10], $value) |$expected, $actual| {
warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.")
}
}
This allows you to find all places where a consumers of your code call it with unexpected values.
Alias of
Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]]
Emulate the is_hash and validate_hash functions
Alias of
Hash[Any, Any]
The regex is what's currently used in is_integer validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. To keep your development moving forward, you can also add a deprecation warning using the Integer type:
class example($value) { validate_integer($value, 10, 0) }
would turn into
class example(Stdlib::Compat::Integer $value) {
validate_numeric($value, 10, 0)
assert_type(Integer[0, 10], $value) |$expected, $actual| {
warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.")
}
}
Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers.
This allows you to find all places where a consumers of your code call it with unexpected values.
Alias of
Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]]
Validate an IP address
Alias of
Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]
Emulate the validate_ipv4_address and is_ipv4_address functions
Alias of
Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/]
Validate an IPv6 address
Alias of
Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/]
The regex is what's currently used in is_numeric validate_numeric also allows range checking, which cannot be mapped to the string parsing inside the function. For full backwards compatibility, you will need to keep the validate_numeric call around to catch everything. To keep your development moving forward, you can also add a deprecation warning using the Integer type:
class example($value) { validate_numeric($value, 10, 0) }
would turn into
class example(Stdlib::Compat::Numeric $value) {
validate_numeric($value, 10, 0)
assert_type(Integer[0, 10], $value) |$expected, $actual| {
warning("The 'value' parameter for the 'ntp' class has type ${actual}, but should be ${expected}.")
}
}
Note that you need to use Variant[Integer[0, 10], Float[0, 10]] if you want to match both integers and floating point numbers.
This allows you to find all places where a consumers of your code call it with unexpected values.
Alias of
Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]]
Emulate the is_string and validate_string functions
Alias of
Optional[String]
A type description used for the create_resources function
class myclass (
Stdlib::CreateResources $myresources = {},
) {
# Using create_resources
create_resources('myresource', $myresources)
# Using iteration
$myresources.each |$myresource_name, $myresource_attrs| {
myresource { $myresource_name:
* => $myresource_attrs,
}
}
}
Alias of
Hash[String[1], Hash[String[1], Any]]
Validate the size of data
Alias of
Pattern[/^\d+(?i:[kmgt]b?|b)$/]
https://html.spec.whatwg.org/multipage/input.html#valid-e-mail-address lint:ignore:140chars
Alias of
Pattern[/\A[a-zA-Z0-9.!#$%&'*+\/=?^_`{|}~-]+@[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?(?:\.[a-zA-Z0-9](?:[a-zA-Z0-9-]{0,61}[a-zA-Z0-9])?)*\z/]
Validate the value of the ensure parameter for a file
Alias of
Enum['present', 'file', 'directory', 'link', 'absent']
Validate the ensure parameter of a "directory" file resource
Alias of
Enum['directory', 'absent']
Validate the ensure parameter of a "file" file resource
Alias of
Enum['file', 'absent']
Validate the ensure parameter of a "link" file resource
Alias of
Enum['link', 'absent']
Validate the value of the ensure parameter of a service resource
Alias of
Enum['stopped', 'running']
See man chmod.1
for the regular expression for symbolic mode
lint:ignore:140chars
Alias of
Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/]
Validate the source parameter on file types
Alias of
Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[
/\Afile:\/\/\/([^\n\/\0]+(\/)?)+\z/,
/\Apuppet:\/\/(([\w-]+\.?)+)?\/([^\n\/\0]+(\/)?)+\z/,
]]
Validate a Fully Qualified Domain Name
Alias of
Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/]
Validate a HTTPS URL
Alias of
Pattern[/(?i:\Ahttps:\/\/.*\z)/]
Validate a HTTP(S) URL
Alias of
Pattern[/(?i:\Ahttps?:\/\/.*\z)/]
Validate a host (FQDN or IP address)
Alias of
Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]
Validate a HTTP status code
Alias of
Integer[100, 599]
Validate an IP address
Alias of
Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6]
Validate an IP address without subnet
Alias of
Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet]
Validate an IPv4 address
Alias of
Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet]
lint:ignore:140chars
Alias of
Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/]
lint:ignore:140chars
Alias of
Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]
Validate an IPv6 address
Alias of
Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet]
lint:ignore:140chars
Alias of
Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]
lint:ignore:140chars
Alias of
Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/]
Validate a compressed IPv6 address
Alias of
Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]
Validate a full IPv6 address
Alias of
Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]
Validate an IPv6 address without subnet
Alias of
Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative]
lint:ignore:140chars
Alias of
Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]
Validate compressed IPv6 address without subnet
Alias of
Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/]
Validate full IPv6 address without subnet
Alias of
Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]
A type for a MAC address
Alias of
Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/]
Validate an ObjectStore
Alias of
Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri]
Validate a Google Cloud object store URI
Alias of
Pattern[/\Ags:\/\/.*\z/]
Validate an Amazon Web Services S3 object store URI
Alias of
Pattern[/\As3:\/\/.*\z/]
Validate a port number
Alias of
Integer[0, 65535]
Validate a dynamic port number
Alias of
Integer[49152, 65535]
Validate an ephemeral port number
Alias of
Stdlib::Port::Dynamic
Validate a priviliged port number
Alias of
Integer[1, 1023]
Validate a registered port number
Alias of
Stdlib::Port::User
Validate an unprivileged port number
Alias of
Integer[1024, 65535]
Validate a port number usable by a user
Alias of
Integer[1024, 49151]
Validate a syslog facility
Alias of
Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7']
this regex rejects any path component that does not start with "/" or is NUL
Alias of
Pattern[/\A\/([^\n\/\0]+\/*)*\z/]
Validate a Windows path
Alias of
Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/]
Validate a yes / no value
Alias of
Pattern[/\A(?i:(yes|no))\z/]