Reference

Table of Contents

Classes

• stdlib: This module manages stdlib.
• stdlib::manage: A simple place to define trivial resources
• stdlib::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.

Resource types

• 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.

Functions

• abs: Deprecated: Returns the absolute value of a number
• any2array: 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 submitted
• basename: Strips directory (and optional suffix) from a filename
• batch_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 te
• deprecation: 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 the ensure_packages function
• ensure_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-notation
• flatten: 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 namespace
• get_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: DEPRECATED. Use the namespaced function stdlib::has_interface_with instead.
• 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 stdlib
• load_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 structure
• parsejson: 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 structure
• parseyaml: 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 integer
• rstrip: 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 together
• shell_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 hash
• sort: 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 are
• stdlib::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 value
• stdlib::extname: Returns the Extension (the Portion of Filename in Path starting from the last Period).
• stdlib::has_interface_with: Returns boolean based on network interfaces present and their attribute values.
• stdlib::ip_in_range: Returns true if the ipaddress is within the given CIDRs
• stdlib::sha256: Run a SHA256 calculation against a given value.
• stdlib::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 files
• str2bool: 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 JSON
• to_json_pretty: Convert data structure and output to pretty JSON
• to_python: Convert an object into a String containing its Python representation
• to_ruby: Convert an object into a String containing its Ruby representation
• to_toml: Convert a data structure and output to TOML.
• to_yaml: Convert a data structure and output it as YAML
• try_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 lens
• validate_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 value
• validate_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 structures
• validate_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.

Data types

• Stdlib::Absolutepath: A strict absolutepath type
• Stdlib::Base32: Type to match base32 String
• Stdlib::Base64: Type to match base64 String
• Stdlib::Compat::Absolute_path: Emulate the is_absolute_path and validate_absolute_path functions
• Stdlib::Compat::Array: Emulate the is_array and validate_array functions
• Stdlib::Compat::Bool: Emulate the is_bool and validate_bool functions
• Stdlib::Compat::Float: Emulate the is_float function
• Stdlib::Compat::Hash: Emulate the is_hash and validate_hash functions
• Stdlib::Compat::Integer: Emulate the is_integer and validate_integer functions
• Stdlib::Compat::Ip_address: Validate an IP address
• Stdlib::Compat::Ipv4: Emulate the validate_ipv4_address and is_ipv4_address functions
• Stdlib::Compat::Ipv6: Validate an IPv6 address
• Stdlib::Compat::Numeric: Emulate the is_numeric and validate_numeric functions
• Stdlib::Compat::String: Emulate the is_string and validate_string functions
• Stdlib::CreateResources: A type description used for the create_resources function
• Stdlib::Datasize: Validate the size of data
• Stdlib::Email: Validate an e-mail address
• Stdlib::Ensure::File: Validate the value of the ensure parameter for a file
• Stdlib::Ensure::File::Directory: Validate the ensure parameter of a "directory" file resource
• Stdlib::Ensure::File::File: Validate the ensure parameter of a "file" file resource
• Stdlib::Ensure::File::Link: Validate the ensure parameter of a "link" file resource
• Stdlib::Ensure::Package: Validate the value of the ensure parameter for a package
• Stdlib::Ensure::Service: Validate the value of the ensure parameter of a service resource
• Stdlib::Filemode: Validate a file mode
• Stdlib::Filesource: Validate the source parameter on file types
• Stdlib::Fqdn: Validate a Fully Qualified Domain Name
• Stdlib::HTTPSUrl: Validate a HTTPS URL
• Stdlib::HTTPUrl: Validate a HTTP(S) URL
• Stdlib::Host: Validate a host (FQDN or IP address)
• Stdlib::Http::Method: Valid HTTP method verbs
• Stdlib::Http::Status: A valid HTTP status code per RFC9110
• Stdlib::HttpStatus: Validate a HTTP status code
• Stdlib::IP::Address: Validate an IP address
• Stdlib::IP::Address::Nosubnet: Validate an IP address without subnet
• Stdlib::IP::Address::V4: Validate an IPv4 address
• Stdlib::IP::Address::V4::CIDR: lint:ignore:140chars
• Stdlib::IP::Address::V4::Nosubnet: lint:ignore:140chars
• Stdlib::IP::Address::V6: Validate an IPv6 address
• Stdlib::IP::Address::V6::Alternative: lint:ignore:140chars
• Stdlib::IP::Address::V6::CIDR: lint:ignore:140chars
• Stdlib::IP::Address::V6::Compressed: Validate a compressed IPv6 address
• Stdlib::IP::Address::V6::Full: Validate a full IPv6 address
• Stdlib::IP::Address::V6::Nosubnet: Validate an IPv6 address without subnet
• Stdlib::IP::Address::V6::Nosubnet::Alternative: lint:ignore:140chars
• Stdlib::IP::Address::V6::Nosubnet::Compressed: Validate compressed IPv6 address without subnet
• Stdlib::IP::Address::V6::Nosubnet::Full: Validate full IPv6 address without subnet
• Stdlib::MAC: A type for a MAC address
• Stdlib::ObjectStore: Validate an ObjectStore
• Stdlib::ObjectStore::GSUri: Validate a Google Cloud object store URI
• Stdlib::ObjectStore::S3Uri: Validate an Amazon Web Services S3 object store URI
• Stdlib::Port: Validate a port number
• Stdlib::Port::Dynamic: Validate a dynamic port number
• Stdlib::Port::Ephemeral: Validate an ephemeral port number
• Stdlib::Port::Privileged: Validate a priviliged port number
• Stdlib::Port::Registered: Validate a registered port number
• Stdlib::Port::Unprivileged: Validate an unprivileged port number
• Stdlib::Port::User: Validate a port number usable by a user
• Stdlib::Syslogfacility: Validate a syslog facility
• Stdlib::Unixpath: Validate a UNIX path
• Stdlib::Windowspath: Validate a Windows path
• Stdlib::Yes_no: Validate a yes / no value

Classes

stdlib

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.

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.

Examples

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]'

Parameters

The following parameters are available in the stdlib::manage class:

• create_resources

create_resources

Data type: Hash[String, Hash]

A hash of resources to create NOTE: functions, such as template or epp, are not evaluated.

Default value: {}

stdlib::stages

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

Examples

node default {
  include ::stdlib
  class { java: stage => 'runtime' }
}

Resource types

anchor

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': }

Parameters

The following parameters are available in the anchor type.

• name

name

namevar

The name of the anchor resource.

file_line

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.

Properties

The following properties are available in the file_line type.

ensure

Valid values: present, absent

Manage the state of this type.

Default value: present

line

The line to be appended to the file or used to replace matches found by the match attribute.

Parameters

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

after

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.

append_on_no_match

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

encoding

For files that are not UTF-8 encoded, specify encoding such as iso-8859-1

Default value: UTF-8

match

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.

match_for_absence

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

multiple

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

name

namevar

An arbitrary name used as the identity of the resource.

path

The file Puppet will ensure contains the line specified by the line parameter.

provider

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.

replace

Valid values: true, false

If true, replace line that matches. If false, do not write line if a match is found

Default value: true

replace_all_matches_not_matching_line

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

Functions

abs

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.

abs()

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

any2array

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.

any2array()

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

any2bool

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.

any2bool()

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

assert_private

Type: Ruby 3.x API

Calling the class or definition from outside the current module will fail.

assert_private()

Calling the class or definition from outside the current module will fail.

Returns: Any set the current class or definition as private.

base64

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 see binary_file() function for reading a file with binary (non UTF-8) content.

Examples

Example usage

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")

base64()

*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 see binary_file() function for reading a file with binary (non UTF-8) content.

Returns: String The encoded/decoded va

Examples

Example usage

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")

basename

Type: Ruby 3.x API

Strips directory (and optional suffix) from a filename

basename()

The basename function.

Returns: String The stripped filename

batch_escape

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.

batch_escape(Any $string)

• 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.

string

Data type: Any

The string to escape

bool2num

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, and Float.new function are used to convert to numeric values.

notice(Integer(false)) # Notices 0
notice(Float(true))    # Notices 1.0

bool2num()

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, and Float.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

bool2str

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'

bool2str()

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

camelcase

Type: Ruby 3.x API

Note: Deprecated from Puppet 6.0.0, this function has been replaced with a built-in camelcase function.

camelcase()

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

capitalize

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.

capitalize()

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

ceiling

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.

ceiling()

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

chomp

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.

chomp()

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

chop

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.

chop()

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.

clamp

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]

Examples

Example usage

clamp('24', [575, 187])` returns 187.
clamp(16, 88, 661)` returns 88.
clamp([4, 3, '99'])` returns 4.

clamp()

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

Examples

Example usage

clamp('24', [575, 187])` returns 187.
clamp(16, 88, 661)` returns 88.
clamp([4, 3, '99'])` returns 4.

concat

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]]

Examples

Example usage

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']

concat()

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

Examples

Example usage

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']

convert_base

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

Examples

Example usage

convert_base()

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

Examples

Example usage

count

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.

count()

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

deep_merge

Type: Ruby 3.x API

Recursively merges two or more hashes together and returns the resulting hash.

Examples

Example usage

$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."

deep_merge()

The deep_merge function.

Returns: Hash The merged h

Examples

Example usage

$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."

defined_with_params

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, }
}

defined_with_params()

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

delete

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.

Examples

Example usage

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'

delete()

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.

Examples

Example usage

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'

delete_at

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

delete_at()

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

delete_regex

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']

Examples

Example usage

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}

delete_regex()

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.

Examples

Example usage

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}

delete_undef_values

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 }

Examples

Example usage

$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]

delete_undef_values()

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.

Examples

Example usage

$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]

delete_values

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' }

Examples

Example usage

delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')
Would return: {'a'=>'A','c'=>'C','B'=>'D'}

delete_values()

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

Examples

Example usage

delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B')
Would return: {'a'=>'A','c'=>'C','B'=>'D'}

deprecation

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.

deprecation(String $key, String $message)

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

key

Data type: String

message

Data type: String

deprecation

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.).

deprecation()

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

difference

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']

Examples

Example usage

difference(["a","b","c"],["b","c","d"])
Would return: `["a"]`

difference()

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

Examples

Example usage

difference(["a","b","c"],["b","c","d"])
Would return: `["a"]`

dig

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'

1. $data The data structure we are working with.
2. ['a', 'b', 2] The path array.
3. 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. Use dig44() for backwards compatibility or use the new version.

dig()

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'

1. $data The data structure we are working with.
2. ['a', 'b', 2] The path array.
3. 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. Use dig44() 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.

dig44

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.

dig44()

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

dirname

Type: Ruby 3.x API

Returns the dirname of a path.

dirname()

The dirname function.

Returns: String the given path's dirname

dos2unix

Type: Ruby 3.x API

Takes a single string argument.

dos2unix()

Takes a single string argument.

Returns: Any The retrieved version

downcase

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.

downcase()

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

empty

Type: Ruby 3.x API

Note: Deprecated from Puppet 5.5.0, the built-in empty function will be used instead.

empty()

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.

enclose_ipv6

Type: Ruby 3.x API

Takes an array of ip addresses and encloses the ipv6 addresses with square brackets.

enclose_ipv6()

The enclose_ipv6 function.

Returns: Any encloses the ipv6 addresses with square brackets.

ensure_packages

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.

packages

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

default_attributes

Data type: Optional[Hash]

Default attributes to be passed to the ensure_resource() function

ensure_packages

Type: Ruby 3.x API

Deprecated 3x version of the ensure_packages function

ensure_packages()

The ensure_packages function.

Returns: Any

ensure_resource

Type: Ruby 3.x API

user { 'dan': ensure => present, }

Examples

Example usage

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'})

ensure_resource()

user { 'dan': ensure => present, }

Returns: Any created or recreated the passed resource with the passed type and attributes

Examples

Example usage

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'})

ensure_resources

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'})

Examples

Example usage

user { 'dan':
  gid => 'mygroup',
  ensure => present,
}

ensure_resources()

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

Examples

Example usage

user { 'dan':
  gid => 'mygroup',
  ensure => present,
}

fact

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.

Examples

Example usage:

fact('osfamily')
fact('os.architecture')

Array indexing:

fact('mountpoints."/dev".options.1')

Fact containing a "." in the name:

fact('vmware."VRA.version"')

fact(String $fact_name)

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

Examples

Example usage:

fact('osfamily')
fact('os.architecture')

Array indexing:

fact('mountpoints."/dev".options.1')

Fact containing a "." in the name:

fact('vmware."VRA.version"')

fact_name

Data type: String

The name of the fact to check

flatten

Type: Ruby 3.x API

Note: Deprecated from Puppet 5.5.0, this function has been replaced with a built-in flatten function.

Examples

Example usage

flatten(['a', ['b', ['c']]])` returns: `['a','b','c']

flatten()

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

Examples

Example usage

flatten(['a', ['b', ['c']]])` returns: `['a','b','c']

floor

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.

floor()

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.

fqdn_rand_string

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.

Examples

Example Usage:

fqdn_rand_string(10)
fqdn_rand_string(10, 'ABCDEF!@$%^')
fqdn_rand_string(10, '', 'custom seed')

fqdn_rand_string()

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

Examples

Example Usage:

fqdn_rand_string(10)
fqdn_rand_string(10, 'ABCDEF!@$%^')
fqdn_rand_string(10, '', 'custom seed')

fqdn_rotate

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.

Examples

Example Usage:

fqdn_rotate(['a', 'b', 'c', 'd'])
fqdn_rotate('abcd')
fqdn_rotate([1, 2, 3], 'custom seed')

fqdn_rotate()

The fqdn_rotate function.

Returns: Any rotated array or string

Examples

Example Usage:

fqdn_rotate(['a', 'b', 'c', 'd'])
fqdn_rotate('abcd')
fqdn_rotate([1, 2, 3], 'custom seed')

fqdn_uuid

Type: Ruby 3.x API

Returns a RFC 4122 valid version 5 UUID based on an FQDN string under the DNS namespace

Examples

Example Usage:

fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c'
fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09

fqdn_uuid()

The fqdn_uuid function.

Returns: Any Returns a RFC 4122 valid version 5 UUID

Examples

Example Usage:

fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c'
fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09

get_module_path

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.

Examples

Example Usage:

$module_path = get_module_path('stdlib')

get_module_path()

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.

Examples

Example Usage:

$module_path = get_module_path('stdlib')

getparam

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']

Examples

Example Usage:

# 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': }

getparam()

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.

Examples

Example Usage:

# 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': }

getvar

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

Examples

Example usage

$foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo

Where namespace is stored in a string

$datalocation = 'site::data'
$bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar

getvar()

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

Examples

Example usage

$foo = getvar('site::data::foo') # Equivalent to $foo = $site::data::foo

Where namespace is stored in a string

$datalocation = 'site::data'
$bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar

glob

Type: Ruby 3.x API

Uses same patterns as Dir#glob.

Examples

Example Usage:

$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf'])

glob()

The glob function.

Returns: Any Returns an Array of file entries of a directory or an Array of directories.

Examples

Example Usage:

$confs = glob(['/etc/**/*.conf', '/opt/**/*.conf'])

grep

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' }

Examples

Example Usage:

grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd']

grep()

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.

Examples

Example Usage:

grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd']

has_interface_with

Type: Ruby 4.x API

DEPRECATED. Use the namespaced function stdlib::has_interface_with instead.

has_interface_with(Any *$args)

The has_interface_with function.

Returns: Any

*args

Data type: Any

has_interface_with

Type: Ruby 3.x API

Valid kinds are macaddress, netmask, ipaddress and network.

Examples

Usage

has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false`
has_interface_with("ipaddress", "127.0.0.1") # Returns `true`

If no "kind" is given, then the presence of the interface is checked:

has_interface_with("lo") # Returns `true`

has_interface_with()

Valid kinds are macaddress, netmask, ipaddress and network.

Returns: Any boolean values true or false

Examples

Usage

has_interface_with("macaddress", "x:x:x:x:x:x") # Returns `false`
has_interface_with("ipaddress", "127.0.0.1") # Returns `true`

If no "kind" is given, then the presence of the interface is checked:

has_interface_with("lo") # Returns `true`

has_ip_address

Type: Ruby 3.x API

This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison.

has_ip_address()

This function iterates through the 'interfaces' fact and checks the 'ipaddress_IFACE' facts, performing a simple string comparison.

Returns: Boolean true or false

has_ip_network

Type: Ruby 3.x API

This function iterates through the 'interfaces' fact and checks the 'network_IFACE' facts, performing a simple string comparision.

has_ip_network()

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.

has_key

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')

Examples

Example Usage:

$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')
}

has_key()

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

Examples

Example Usage:

$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')
}

hash

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]])

Examples

Example Usage:

hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3}

hash()

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

Examples

Example Usage:

hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3}

intersection

Type: Ruby 3.x API

This function returns an array of the intersection of two.

Examples

Example Usage:

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)

intersection()

The intersection function.

Returns: Any an array of the intersection of two.

Examples

Example Usage:

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)

is_a

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.

Examples

Example Usage:

# 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!': }
  }

is_a(Any $value, Type $type)

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.

Examples

Example Usage:

# 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!': }
  }

value

Data type: Any

The value to be checked

type

Data type: Type

The expected type

is_absolute_path

Type: Ruby 4.x API

Wrapper that calls the Puppet 3.x function of the same name.

is_absolute_path(Any $scope, Any *$args)

The is_absolute_path function.

Returns: Boolea A boolean value returned from the called 3.x function.

scope

Data type: Any

The main value that will be passed to the wrapped method

*args

Data type: Any

Any additional values that are to be passed to the wrapped method

is_absolute_path

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

Examples

The following values will return true:

$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)

The following values will return false:

is_absolute_path(true)
is_absolute_path('../var/lib/puppet')
is_absolute_path('var/lib/puppet')
$undefined = undef
is_absolute_path($undefined)

is_absolute_path()

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

Examples

The following values will return true:

$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)

The following values will return false:

is_absolute_path(true)
is_absolute_path('../var/lib/puppet')
is_absolute_path('var/lib/puppet')
$undefined = undef
is_absolute_path($undefined)

is_array

Type: Ruby 4.x API

Wrapper that calls the Puppet 3.x function of the same name.

is_array(Any $scope, Any *$args)

The is_array function.

Returns: Boolea A boolean value returned from the called 3.x function.

scope

Data type: Any

The main value that will be passed to the wrapped method

*args

Data type: Any

Any additional values that are to be passed to the wrapped method

is_array

Type: Ruby 3.x API

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

is_array()

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

Returns: Boolean Returns true or false

is_bool

Type: Ruby 4.x API

Wrapper that calls the Puppet 3.x function of the same name.

is_bool(Any $scope, Any *$args)

The is_bool function.

Returns: Boolea A boolean value returned from the called 3.x function.

scope

Data type: Any

The main value that will be passed to the wrapped method

*args

Data type: Any

Any additional values that are to be passed to the wrapped method

is_bool

Type: Ruby 3.x API

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

is_bool()

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

Returns: Boolean Returns true or false

is_domain_name

Type: Ruby 3.x API

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

is_domain_name()

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

Returns: Boolean Returns true or false

is_email_address

Type: Ruby 3.x API

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

is_email_address()

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

Returns: Boolean Returns true or false

is_float

Type: Ruby 4.x API

Wrapper that calls the Puppet 3.x function of the same name.

is_float(Any $scope, Any *$args)

The is_float function.

Returns: Boolea A boolean value returned from the called 3.x function.

scope

Data type: Any

The main value that will be passed to the wrapped method

*args

Data type: Any

Any additional values that are to be passed to the wrapped method

is_float

Type: Ruby 3.x API

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

is_float()

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

Returns: Boolean Returns true or false

is_function_available

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.

is_function_available()

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

is_hash

Type: Ruby 3.x API

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

is_hash()

Note:* Deprecated** Will be removed in a future version of stdlib. See validate_legacy.

Returns: Boolean Returns true or false

is_integer

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.

is_integer()

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

is_ip_address

Type: Ruby 4.x API

Wrapper that calls the Puppet 3.x function of the same name.

is_ip_address(Any $scope, Any *$args)

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog and this project adheres to Semantic Versioning.

v9.0.0 - 2023-05-30

Full Changelog

Added

• Namespace Puppet 4.x functions #1356 (smortex)
• Add a function to update / regenerate deprecated shims #1349 (smortex)

Changed

• Deprecate the validate_legacy() function #1353 (smortex)
• Remove deprecated functions #1352 (smortex)
• Rewrite validate_email_address() as a Puppet 4.x function #1350 (smortex)
• Rewrite validate_domain_name() as a Puppet 4.x function #1345 (smortex)
• Rewrite seeded_rand() as a Puppet 4.x function #1344 (smortex)
• Rewrite fqdn_rand_string() as a Puppet 4.x function #1343 (smortex)
• Remove deprecated strip function #1338 (smortex)
• Remove deprecated rstrip function #1337 (smortex)
• Remove deprecated getvar function #1336 (smortex)
• Remove deprecated sort function #1335 (smortex)
• Remove deprecated upcase function #1334 (smortex)
• Remove deprecated round function #1333 (smortex)
• Remove deprecated chop function #1331 (smortex)
• Remove deprecated chomp function #1330 (smortex)
• Remove deprecated ceiling function #1329 (smortex)
• Remove deprecated capitalize functions #1328 (smortex)
• Remove deprecated camelcase function #1327 (smortex)
• Modernise has_interface_with function #1326 (alexjfisher)
• Remove deprecated is_array function #1325 (MartyEwings)
• Remove deprecated is_absolute_path function #1324 (MartyEwings)
• Remove deprecated min function #1323 (MartyEwings)
• Remove deprecated max function #1322 (MartyEwings)
• Remove deprecated lstrip function #1321 (MartyEwings)
• Remove deprecated hash function #1320 (MartyEwings)
• Remove deprecated has_key function #1319 (MartyEwings)
• Remove deprecated downcase function #1318 (MartyEwings)
• Remove deprecated abs function #1317 (MartyEwings)
• Remove dig and dig44 functions #1316 (MartyEwings)
• Remove Puppet 5.5 deprecations #1314 (MartyEwings)
• Remove deprecated unique function #1311 (MartyEwings)
• Remove deprecated Private function #1310 (MartyEwings)
• Remove deprecated type and type3x functions #1309 (MartyEwings)
• (CONT-801) Puppet 8 support / Drop Puppet 6 support #1307 (LukasAud)

Fixed

• Remove deprecated File.exists? #1357 (ekohl)
• Fix validate_domain_name called without parameters #1351 (smortex)
• Add Stdlib::IP::Address::CIDR #1348 (Geod24)
• Allow deferrable_epp to return a Sensitive[String] #1342 (alexjfisher)

v8.6.0 - 2023-04-24

Full Changelog

Added

• Stdlib::Http::Method: Add new type for http methods #1299 (b4ldr)
• Add stdlib::sha256 #1289 (jcpunk)
• Add stdlib::crc32 #1288 (jcpunk)
• Add Stdlib::Ensure::Package type #1281 (arjenz)

Fixed

• (PUP-11752) Fix fqdn_rand_string_spec.rb test #1308 (alexjfisher)
• Make ensure_packages work with ensure => present #1300 (alexjfisher)
• Safely handle a missing root user #1295 (ekohl)
• stdlib::ensure: update function to support the generic case #1286 (b4ldr)
• Drop Puppet < 3.6 support in package_provider fact #1280 (ekohl)
• Correct bcrypt salt regex #1279 (sabo)
• Determine root_home without shelling out #1278 (ekohl)
• (CONT-173) - Updating deprecated facter instances #1277 (jordanbreen28)

v8.5.0 - 2022-10-13

Full Changelog

Added

• Add a Stdlib::CreateResources type #1267 (ekohl)
• pdksync - (GH-cat-11) Certify Support for Ubuntu 22.04 #1261 (david22swan)
• (FEAT) Add function parsepson #1259 (david22swan)

Fixed

• (CONT-200) Fix require relative paths #1275 (chelnak)
• pdksync - (CONT-189) Remove support for RedHat6 / OracleLinux6 / Scientific6 #1272 (david22swan)
• pdksync - (CONT-130) - Dropping Support for Debian 9 #1269 (jordanbreen28)
• (MAINT) Drop support for AIX + Windows EOL OSs #1265 (jordanbreen28)
• (GH-1262) Use 'require_relative' to load stdlib due to lookup errors #1264 (david22swan)
• Switch parsejson() from PSON to JSON parsing #1240 (seanmil)

v8.4.0 - 2022-07-21

Full Changelog

Added

• deferrable epp function simplifying deferred templates #1253 (binford2k)

v8.3.0 - 2022-07-11

Full Changelog

Added

• pdksync - (GH-cat-12) Add Support for Redhat 9 #1247 (david22swan)
• Convert ensure_packages to new API and refactor #1244 (alexjfisher)

Fixed

• (MODULES-2892) Handle missing file in file_line #1251 (silug)
• Simplify stdlib::manage #1250 (jcpunk)
• Unbreak rake strings:generate:reference #1239 (smortex)
• loadjson: do not send http_basic_authentication if not needed #1208 (chaen)

v8.2.0 - 2022-05-16

Full Changelog

Added

• Add xml_encode function #1236 (alexjfisher)
• (MODULES-4976) Add windows escaping functions #1235 (smortex)
• MODULES-11309 : convert a string to a resource #1233 (jcpunk)
• pdksync - (FM-8922) - Add Support for Windows 2022 #1222 (david22swan)
• (MODULES-11196) Add support for AIX 7.2 #1220 (david22swan)
• pdksync - (IAC-1753) - Add Support for AlmaLinux 8 #1216 (david22swan)

Fixed

• Update load_module_metadata.rb to correct capitalisation in strings documentartion #1241 (davidsandilands)
• Modernize escape functions #1238 (smortex)
• Convert data to Pcore before serialisation in to_ruby/to_python #1237 (smortex)
• (maint) Update str2saltedpbkdf2.rb to use the correct salt length #1232 (AriaXLi)
• Fix to_yaml options parameter #1231 (alexjfisher)
• pdksync - (GH-iac-334) Remove Support for Ubuntu 14.04/16.04 #1224 (david22swan)
• pdksync - (IAC-1787) Remove Support for CentOS 6 #1219 (david22swan)
• Fix serialization of undef in to_python() #1205 (smortex)

v8.1.0 - 2021-10-04

Full Changelog

Added

• pdksync - (IAC-1751) - Add Support for Rocky 8 #1214 (david22swan)
• stdlib::ensure: Add support for package resource #1213 (david-caro)
• Added to_toml function #1209 (nmaludy)

Fixed

• [MODULES-11195] Add lint-ignore for pattern length #1212 (carabasdaniel)
• pdksync - (IAC-1598) - Remove Support for Debian 8 #1210 (david22swan)
• os_version_gte: fix version comparison logic #1207 (kenyon)
• max, lstrip: fix deprecated message #1204 (b4ldr)
• (MODULES-11126) Replacing URI.escape with URI::DEFAULT_PARSER #1195 (valleedelisle)

v8.0.0 - 2021-08-24

Full Changelog

Added

• New function to_python() / to_ruby() #1200 (smortex)
• pdksync - (IAC-1709) - Add Support for Debian 11 #1199 (david22swan)
• Stdlib::Http::Method: Add new type for http methods #1192 (b4ldr)

Changed

• Flip installed and present in Function ensure_packages #1196 (cocker-cc)

Fixed

• (MODULES-11099) Make merge parameter data types actually backwards compatible #1191 (SimonPe)

v7.1.0 - 2021-05-17

Full Changelog

Added

• pw_hash: add support for bcrypt variants #1173 (kjetilho)

v7.0.1 - 2021-04-12

Full Changelog

Fixed

• Fix typo in validate_ipv6_address function #1176 (nbarrientos)

v7.0.0 - 2021-03-01

Full Changelog

Added

• Stdlib::Email type #1160 (b4ldr)

Changed

• pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 #1164 (carabasdaniel)

Fixed

• (bugfix) Setting stricter email validation #1163 (pmcmaw)
• (IAC-1414) Throw error in range() function when step size invalid #1161 (sanfrancrisko)

v6.6.0 - 2021-02-02

Full Changelog

Added

• stdlib::ensure: new fuction to cast ensure values #1150 (b4ldr)
• (feat) Add support for Puppet 7 #1144 (daianamezdrea)
• Allow options injection for to_yaml #1137 (baurmatt)
• Allow start/end checks on empty strings #1135 (jvrsantacruz)
• Stdlib::HttpStatus: add type for HTTP status codes as per rfc2616 #1132 (b4ldr)

Fixed

• (IAC-1375) fix unit tests for pe_version fact, when using later facte… #1155 (tphoney)
• seeded_rand: update funtion to ensure it returns an int not String #1139 (b4ldr)

v6.5.0 - 2020-09-30

Full Changelog

Added

• Add parsehocon() function #1130 (reidmv)
• Add new types for Stdlib::Ensure::File #1129 (b4ldr)
• Add additional types Stdlib::Port::Dynamic,Ephemeral,Registered,User} #1128 (b4ldr)
• Stdlib::Datasize: This CR adds a new data size type alias #1126 (b4ldr)

v6.4.0 - 2020-08-21

Full Changelog

Added

• pdksync - (IAC-973) - Update travis/appveyor to run on new default branch main #1117 (david22swan)
• (IAC-746) - Add ubuntu 20.04 support #1110 (david22swan)

Fixed

• [MODULES-10781] Fix defined type defined_with_params() #1122 (trevor-vaughan)
• [MODULES-10729] defined_with_params - unnamed type #1115 (trevor-vaughan)

v6.3.0 - 2020-04-16

Full Changelog

Added

• Add start_with function #1086 (baurmatt)
• stdlib::end_with: create String.end_with function #1084 (b4ldr)
• Adding str2saltedpbkdf2 function #1040 (genebean)

Fixed

• (MODULES-10623) explicitly top-scope calls to JSON methods #1101 (tkishel)
• [IAC-547] Remove strftime from stdlib as it has already been replaced by the puppet agent since 4.8.0 #1097 (carabasdaniel)
• Add correct namespace for start_with function #1095 (baurmatt)
• intersection: show types in exception due to invalid arguments #1077 (runejuhl)
• Make type aliases stricter #1066 (pegasd)

v6.2.0 - 2019-12-10

Full Changelog

Added

• (FM-8696) - Addition of Support for CentOS 8 #1065 (david22swan)
• Add support for additional options to to_json_pretty #1055 (runejuhl)

Fixed

• Fix PE detection (for the moment) #1049 (trevor-vaughan)

v6.1.0 - 2019-09-20

Full Changelog

Added

• (MODULES-9915) Add type aliases for cloud object store uris #1048 (hooten)
• FM-8411 - add support for debian10 #1045 (lionce)
• (FM-8230) Convert testing to litmus #1031 (eimlav)
• (FM-8160) Add Windows Server 2019 support #1025 (eimlav)
• (FM-8048) Add RedHat 8 support #1022 (eimlav)
• (MODULES-9049) Add type alias for 'yes' and 'no'. #1017 (ghoneycutt)
• add Stdlib::Syslogfacility type #1005 (bastelfreak)

Fixed

• fix lib/puppet/parser/functions/fqdn_rand_string.rb:21: syntax error #1029 (pulecp)
• Limit the maximum array size produced by range(). #1023 (mbaynton)

v6.0.0 - 2019-05-22

Full Changelog

Added

• (MODULES-8760) Add iterative feature to merge() function #1008 (hlindberg)
• Add a stdlib::ip_in_range() function #1003 (iglov)

Changed

• pdksync - (MODULES-8444) - Raise lower Puppet bound #1011 (david22swan)

Other

• (MODULES-8992)- Supported Release (puppetlabs-stdlib) #1015 (lionce)

5.2.0 - 2019-01-18

Full Changelog

Added

• (MODULES-8404) - Relax Stdlib::Filesource type #981 (alexjfisher)
• Creates new type Stdlib::IP::Address::V6::CIDR #980 (timhughes)
• (MODULES-8137) - Addition of support for SLES 15 #978 (david22swan)
• (MODULES-8322) Consider IPs with /0 as valid #975 (simondeziel)
• Add a function to compare the OS version #972 (ekohl)
• (MODULES-8273) - Make unquoted classes useable #971 (baurmatt)
• add Function extname() #949 (cocker-cc)
• (MODULES-7024) Add 20-octet MAC addresses #905 (ananace)

Fixed

• pdksync - (FM-7655) Fix rubygems-update for ruby < 2.3 #979 (tphoney)
• fix ensure_packages duplicate checking #969 (netzvieh)

5.1.0 - 2018-10-01

Full Changelog

Added

• pdksync - (MODULES-6805) metadata.json shows support for puppet 6 #958 (tphoney)
• (maint) Convert from mocking with mocha to rspec-mocks #948 (rodjek)

Fixed

• (FM-7388) - Fixing unit tests for puppet 4, 5 and 6 #962 (tphoney)
• Fix pick function docs #955 (alexjfisher)
• (MODULES-7768) Handle nil in delete_undef_values() function #954 (hlindberg)
• Update docs for 'concat' to be correct #950 (rhowe-gds)

5.0.0 - 2018-08-22

Full Changelog

Added

• (MODULES-7541) http type checks case insensitive #934 (tphoney)
• (MODULES-7440) Update Stdlib to support Ubuntu 18.04 #932 (david22swan)
• Allow loadyaml() and loadjason() to accept URLs with HTTP basic auth #923 (jonnytdevops)
• Load https file into loadjson() and loadyaml() #918 (jonnytdevops)
• Add support for symbolic file modes #915 (runejuhl)
• (MODULES-7181) Remove Stdlib::(Ipv4|IPv6|Ip_address) #909 (baurmatt)
• Allow pick() to work with strict variables #890 (binford2k)
• seeded_rand_string() function #877 (pegasd)

Fixed

• Make any2array return empty array on empty string #930 (jbro)
• Revert "Allow pick() to work with strict variables" #927 (mwhahaha)
• (docs) update documentation wrt functions moved to puppet #922 (hlindberg)

Other

• (MODULES-6881) - Removing duplication in .sync.yml #904 (pmcmaw)
• Release Mergeback 4.25.1 #901 (HelenCampbell)

4.25.1 - 2018-04-04

Full Changelog

Other

• (MODULES-6951) Updating translations for readmes/README_ja_JP.md #900 (ehom)
• Remove unneeded execute permission #880 (smortex)

4.25.0 - 2018-03-13

Full Changelog

Added

• (MODULES-6366) Add data types for IP validation #872 (ghoneycutt)

Fixed

• Handle join_keys_to_values() with undef values. #874 (BobVanB)

Other

• (MODULES-6782) - Disable rockethash for spec_helper.rb #886 (pmcmaw)
• (MODULES-6771) - Updates to README. #885 (pmcmaw)
• (MODULES-6771) - Release Prep 4.25.0 #884 (pmcmaw)
• (maint) - Adding full stops in the README.md #883 (pmcmaw)
• (MODULES-6332) - PDK convert #881 (pmcmaw)
• (maint) fixed typos, formatting issues #879 (ehom)
• fix formating of Stdlib::Port examples in README.md #878 (SimonPe)
• get rid of fixnum|bignum deprecation warning #875 (tuxmea)
• (maint) Add modern Windows OS to metadata #873 (glennsarti)
• (maint) modulesync 65530a4 Update Travis #871 (michaeltlombardi)
• (maint) modulesync cd884db Remove AppVeyor OpenSSL update on Ruby 2.4 #868 (michaeltlombardi)
• FixToAccountForVersionChange #867 (david22swan)
• (maint) - modulesync 384f4c1 #866 (tphoney)
• Release mergeback #865 (willmeek)
• fixed wrong comment in unixpath.pp #862 (c33s)
• update Stdlib::::ip types #843 (b4ldr)
• add Stdlib::Fqdn and Stdlib::Host #842 (b4ldr)
• add Stdlib::Filesource #841 (b4ldr)
• add Stdlib::base64 and Stdlib::Base32 types #840 (b4ldr)
• add Stdlib::Port, Stdlib::Privilegedport & Stdlib::Unprivilegedport #839 (b4ldr)

4.24.0 - 2017-12-08

Full Changelog

Other

• Release Prep 4.24.0 #864 (pmcmaw)
• (FM-6634) - Addressing rubocop errors #863 (pmcmaw)
• (MODULES-6216) - Fix type3x function in stdlib #861 (pmcmaw)
• MODULES-6201 .rubocop.yml not managed by msync #859 (tphoney)
• MODULES-6139 Revert to old ruby 1.X style of hash #858 (tphoney)
• Lint style/syntax #857 (AlexanderSalmin)
• Updated type alias tests and dropped superfluous wrapper classes #856 (pegasd)
• Ability to skip undef values in to_json_pretty() #855 (pegasd)
• MODULES-6106: Fix broken .sync.yml #854 ()
• Release mergeback 4.23.0 #853 (tphoney)

4.23.0 - 2017-11-24

Full Changelog

Other

• Min function correction #852 (pmcmaw)
• Add test for https://github.com/puppetlabs/puppetlabs-stdlib/pull/850 #851 (sean797)
• Adding in else additional else statement #850 (pmcmaw)
• PreRelease-4.23.0 #849 (david22swan)
• Updating translations for readmes/README_ja_JP.md #848 (david22swan)
• (maint) - modulesync 1d81b6a #847 (pmcmaw)
• Release mergeback 4.22.0 #846 (pmcmaw)
• Rubocop Implementation #838 (david22swan)

4.22.0 - 2017-11-15

Full Changelog

Other

• Fixes a minor typo #845 (jbondpdx)
• Pre release #844 (david22swan)
• fixups on stdlib README #837 (jbondpdx)
• (FM-6572) PreRelease #836 (david22swan)
• 4.21.0 release merge back #835 (HAIL9000)

4.21.0 - 2017-11-03

Full Changelog

Added

• Add a type for ensure on service resources #750 (npwalker)

Fixed

• Fix filenames of two function spec tests #777 (alexjfisher)

Other

• Add Stdlib::Mode type #834 (ghoneycutt)
• (MODULES-5814) - Removing Windows 8 #833 (pmcmaw)
• Revert "(MODULES-5679) Add a new function ifelse to match ruby's tenary operator" #832 (david22swan)
• Updates to metadata.json #830 (pmcmaw)
• (maint) Fix example syntax #829 (binford2k)
• README fixups for 4.21.0 release #828 (jbondpdx)
• (MODULES-5806) release prep for version 4.21.0 #827 (eputnam)
• correct test cases to properly check result #826 (felixdoerre)
• (MODULES-5651) Do not append infinitely #825 (hunner)
• (MODULES-5680) Added new function sprintf_hash to allow using named references #824 (vStone)
• (MODULES-5679) Add a new function ifelse to match ruby's tenary operator #823 (vStone)
• (maint) Clarify docs and add new tests #820 (alexharv074)
• removing duplicate test absolute_path test #818 (tphoney)
• (maint) modulesync 892c4cf #817 (HAIL9000)
• use single quotes in validate_legacy example code #816 (mutante)
• version 4.20.0 mergeback #815 (eputnam)
• Allow root as valid UNIX path #811 (kofrezo)

4.20.0 - 2017-09-11

Full Changelog

Added

• Added to_json, to_json_pretty, and to_yaml functions #809 (WhatsARanjit)

Other

• (maint) re-send push action to transifex #814 (eputnam)
• (MODULES-5508) release prep for 4.20.0 #812 (eputnam)
• (MODULES-5546) add check for pw_hash #810 (eputnam)
• release 4.19.0 mergeback #808 (eputnam)

4.19.0 - 2017-08-21

Full Changelog

Other

• 4.19.0 prep #807 (tphoney)
• (MODULES-5501) - Remove unsupported Ubuntu #806 (pmcmaw)
• Release mergeback 4.18.0 #805 (tphoney)

4.18.0 - 2017-08-11

Full Changelog

Added

• add type for MAC address #796 (bastelfreak)

Other

• (MODULES-5436) release prep for 4.18.0 #804 (eputnam)
• MODULES-5440 fix upper bound for puppet #803 (tphoney)
• (MODULES-5436) release prep for 4.17.2 #802 (eputnam)
• (maint) revert puppet version requirement #801 (eputnam)
• MODULES-5382 Add documentation for email functions #800 (tphoney)
• (maint) modulesync 915cde70e20 #799 (glennsarti)
• (maint) move/rewrite round() as ruby function #798 (eputnam)
• Update README for fact() function #797 (reidmv)
• (MODULES-5003) file_line does not change multiple lines when one matches #794 (tkishel)
• (FM-6239) rewrite of test following std patterns #793 (tphoney)
• (MODULES-4908) adds support for sensitive data type to pw_hash #791 (eputnam)
• (MODULES-5187) mysnc puppet 5 and ruby 2.4 #790 (eputnam)
• (MODULES-5186) - do not run file_line unit tests on windows. #789 (tphoney)
• (MODULES-5003) file_line fix all broken lines #788 (tphoney)
• (FACT-932) Add new function, fact() #787 (reidmv)
• (MODULES-5113) Make line support Sensitive #786 (reidmv)
• (MODULES-5144) Prep for puppet 5 #784 (hunner)
• Fix headers in CHANGELOG.md so that headers render correctly #783 (davewongillies)
• 4.17.1 Release Mergeback #782 (HelenCampbell)
• (maint) Stdlib::Compat::Integer accepts numbers with newlines apparently #756 (hunner)
• Add validate_domain_name function #753 (frapex)
• Add a round function to complement ceiling and floor #748 (npwalker)
• Add new file_line option append_on_no_match #717 (ripclawffb)
• (Modules 4377) Causes ensure_packages to accept concurrent declarations with ensure => 'present' and 'installed' #716 (EmersonPrado)

4.17.1 - 2017-06-16

Full Changelog

Other

• Release prep for 4.17.1 #781 (HelenCampbell)
• (MODULES-5095) Workaround for PUP-7650 #780 (thallgren)
• (FM-6197) formatting fixes for file_line resource #779 (jbondpdx)
• MODULES-4821 puppetlabs-stdlib: Update the version compatibility to >= 4.7.0 < 5.0.0 #778 (marsmensch)
• Merge back 4.17.0 #776 (tphoney)

4.17.0 - 2017-05-10

Full Changelog

Other

• (WIP) Release Branch Update Merge #774 (HelenCampbell)
• (maint) rename main readme #772 (eputnam)
• (MODULES-4706) prerelease fixes #771 (eputnam)
• (MODULES-4706) prerelease fixes #770 (jbondpdx)
• Release prep #769 (tphoney)
• Removing italics for 'undef' value #768 (pmcmaw)
• (PE-20308) Fix defined_with_params() for defined type strings & references #765 (hunner)
• (PE-20308) Correct boundary for 4.5 vs 4.6 #763 (hunner)
• (PE-20308) Pass a literal type and not a string to findresource #761 (hunner)
• Release mergeback #760 (HelenCampbell)
• Ruby 1.8 doesn't support open_args #758 (sathieu)
• TOC updates #755 (rnelson0)
• [msync] 786266 Implement puppet-module-gems, a45803 Remove metadata.json from locales config #754 (wilson208)
• (MODULES-4322) pre-loc edit on stdlib README #747 (jbondpdx)
• (FM-6116) - Adding POT file for metadata.json #746 (pmcmaw)
• [MODULES-4528] Replace Puppet.version.to_f version comparison from spec_helper.rb #745 (wilson208)
• Release Mergeback 4.16.0 #744 (HelenCampbell)
• Update alias spec error message expectation for PUP-7371 #743 (domcleal)
• Add glob function #718 (sspreitzer)

4.16.0 - 2017-03-21

Full Changelog

Other

• Release prep for 4.16.0 #742 (HelenCampbell)
• (FM-6051) Adds comments to warn for UTF8 incompatibility #741 (HelenCampbell)
• Permit double slash in absolute/Unix path types #740 (domcleal)
• Release mergeback for 4.15.0 #739 (HelenCampbell)
• (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat #737 (domcleal)
• Addition of new length function #736 (HelenCampbell)
• Should only try to apply the resource if it not defined #735 (elmobp)
• (FM-6086) - Unit tests for Resource Types #734 (pmcmaw)
• (FM-6085) - Unit tests for Data Types #733 (pmcmaw)
• (FM-6063) - Unit tests for high effort functions #732 (pmcmaw)
• (MODULES-4485) Improve ipv6 support for type #731 (petems)
• (MODULES-4473) join strings for i18n parser #729 (eputnam)
• loosen the regex for tuple checking #728 (tphoney)
• (FM-6058) - Unit tests for med effort functions #727 (pmcmaw)
• (#FM-6068) allow file encoding to be specified #726 (GeoffWilliams)
• (FM-6054) - Unit tests for low effort functions #725 (pmcmaw)
• Modules 4429 unit tests #724 (pmcmaw)
• remove unsupported platforms and future parser #723 (tphoney)
• Fix acceptance test failure "Hiera is not a class" #720 (DavidS)
• Allow test module metadata.json to be read #719 (domcleal)
• Fix unsupported data type error with rspec-puppet master #715 (domcleal)
• (FM-6019) - i18N tests for Spike #714 (pmcmaw)
• (MODULES-4098) Sync the rest of the files #712 (hunner)

4.15.0 - 2017-01-20

Full Changelog

Added

• (MODULES-4188) Add UUID generation function #700 (petems)

Other

• Implement beaker-module_install_helper #713 (wilson208)
• Release Prep for 4.15.0 #711 (HelenCampbell)
• Release mergeback - second attempt #710 (HelenCampbell)
• Release Mergeback #709 (HelenCampbell)
• Addition of compat hash type for deprecation #708 (HelenCampbell)
• (MODULES-4097) Sync travis.yml #706 (hunner)
• add ubuntu xenial to metadata #705 (eputnam)
• Change - Update str2bool documentation #703 (blackknight36)
• (FM-5972) gettext and spec.opts #702 (eputnam)
• Add pry() function from hunner-pry #640 (hunner)
• Add puppet_server fact to return agent's server #613 (reidmv)

4.14.0 - 2016-12-12

Full Changelog

Other

• Release prep for 4.14.0 #699 (HelenCampbell)
• Release prep for 4.13.2 #698 (HelenCampbell)
• (MODULES-3829) Add tests for ensure_resources #697 (HAIL9000)
• (MODULES-3631) msync Gemfile for 1.9 frozen strings #696 (hunner)
• Indicate that the type function is preferred #695 (npwalker)
• Remove rvalue declaration from v3 deprecation() function #694 (DavidS)
• (MODULES-3393) Deprecation - Use puppet stacktrace if available #693 (HelenCampbell)
• Revert "Call site output for deprecation warnings" #692 (bmjen)
• Fixing broken link to #validate_legacy docs #691 (idnorton)
• MODULES-4008: clarify deprecation language #690 (jbondpdx)
• Fix spec failures on puppet 4.8 #689 (DavidS)
• (MODULES-3704) Update gemfile template to be identical #688 (hunner)
• (MODULES-3829) Use .dup to duplicate classes for modification. #687 (MG2R)
• Addition of 4.6 and 4.7 travis cells #686 (HelenCampbell)
• Call site output for deprecation warnings #685 (HelenCampbell)
• This is to pin ruby version to parallel_tests #682 (pmcmaw)
• Remove leading spaces #681 (cacack)
• (MODULES-3980) Fix ipv4 regex validator #680 (DavidS)
• Fix incorrect environment variable name in README #675 (smoeding)
• Handle array values in join_keys_to_values function #632 (edestecd)

4.13.1 - 2016-10-13

Full Changelog

Other

• (MODULES-3969) Update getvar to work on ruby 1.8.7 #674 (DavidS)
• (MODULES-3962) Rework v4 function shims to work on puppet 3.7 and 4.0.0 #673 (DavidS)
• (MODULES-3961) emit more deprecation warnings #672 (DavidS)
• Mergeback #671 (DavidS)

4.13.0 - 2016-10-11

Full Changelog

Other

• Release prep for 4.13.0 #670 (DavidS)
• Final cleanups #668 (DavidS)
• (FM-5703, PUP-6717) Remove the dynamic deprecation_gen function #667 (DavidS)
• (MODULES-3590) Fix match_for_absence parameter #666 (HAIL9000)
• Ignore :undefined_variable "reason" in getvar #665 (mks-m)
• Type updates #664 (HelenCampbell)
• (MODULES-3933) Fix getparam for 'false' values #663 (DavidS)
• Permit undef passed as nil to validate_string #662 (domcleal)
• Ensure validate functions use Puppet 4 deprecation #659 (HelenCampbell)
• MODULES-3774: stdlib validate_legacy review #658 (jbondpdx)
• Remove duplicate deprecation warnings #657 (HelenCampbell)
• Add deprecation warnings to remaining validates #656 (HelenCampbell)
• Revert "Ensure validate functions use Puppet 4 deprecation" #655 (HelenCampbell)
• Ensure validate functions use Puppet 4 deprecation #654 (HelenCampbell)
• Fix whitespace #653 (hunner)
• Change in readme for numerical string #652 (pmcmaw)
• Addition of logging with file and line numbers #651 (HelenCampbell)
• Deprecation function README update #650 (HelenCampbell)
• (MODULES-3737) refactor validate_legacy and tests #649 (DavidS)
• Add facter fact for puppet_environmentpath #648 (stbenjam)
• Fix validate_legacy docs table formatting #647 (domcleal)
• MODULES-3699 Deprecation spec fix 2 #646 (eputnam)
• Update documentation for validate_legacy #645 (DavidS)
• Refactor dig44 function #644 (dmitryilyin)
• Update modulesync_config [a3fe424][#642](https://github.com/puppetlabs/puppetlabs-stdlib/pull/642) (DavidS)
• Deprecation function to be mutable in all cases #641 (HelenCampbell)
• (MODULES-3534) Deprecation of ip functions #637 (HelenCampbell)
• (maint) Switch 3.x deprecation() to use Puppet warning logger #636 (domcleal)
• (MAINT) Update ensure_resource specs #635 (DavidS)
• (modules-3532) deprecate string type checks #633 (tphoney)
• Fix markdown indentation #631 (smortex)
• (MODULES-3540) Addition of validate legacy function #630 (HelenCampbell)
• (modules-3533) deprecation for 3.x number function #629 (tphoney)
• (MAINT) Update for modulesync_config 72d19f184 #627 (DavidS)
• Fix str2bool error message #626 (LoicGombeaud)
• Added documentation for regexpescape function. #625 (mooresm1)
• Added the regexpescape function. #624 (mooresm1)
• (modules-3407) documenting after can take a regex #623 (tphoney)
• (MODULES-3306) document deep_merge #622 (tphoney)
• (MODULES-2143) document edge behaviour of range. #621 (tphoney)
• (MAINT) modulesync [067d08a][#619](https://github.com/puppetlabs/puppetlabs-stdlib/pull/619) (DavidS)
• (MODULES-3568) Move dig to dig44 and deprecate dig #618 (ntpttr)
• (MODULES-3529) add deprecation function #617 (tphoney)
• (MODULES-3435) remove symlinks #616 (DavidS)
• (MODULES-3543) Fixup defined_with_params to work on all puppet versions #615 (DavidS)
• (MODULES-3543) Fix define_with_params to handle undef properly #614 (DavidS)
• {maint} modulesync 0794b2c #612 (tphoney)
• (MODULES-3407) Clarify that 'after' in file_line accepts regex. #611 (ntpttr)
• (MODULES-3507) Updates file_line path validation #610 (bmjen)
• (MODULES-3354) Use 1.8.7 hash in validate_email_address function #606 (stbenjam)
• Add delete_regex #605 (jyaworski)
• Add a missing s in the ensure_packages hash example #604 (rjw1)
• Mergeback 4.12.x #603 (hunner)
• (MODULES-1439) Adds any2bool function #601 (petems)
• Add the default value to the "loadyaml" function #600 (dmitryilyin)
• Use reject instead of delete_if #592 (jyaworski)

4.12.0 - 2016-05-03

Full Changelog

Other

• Remove hard linebreaks #602 (hunner)
• Undo changing delete() to delete regex matches #599 (hunner)
• (MODULES-3271) Ensure that is_email_address works on unsupported rubies #598 (DavidS)
• 4.12.0 release prep #596 (tphoney)
• master to 4.12.x #595 (tphoney)
• Update to newest modulesync_configs [9ca280f][#593](https://github.com/puppetlabs/puppetlabs-stdlib/pull/593) (DavidS)
• Add support for regular expressions to delete #591 (jyaworski)
• (MODULES-3246) Fix concat with Hash arguments. #590 (alext)
• Multiple updates to stdlib and its testsuite #589 (DavidS)
• (FM-5000) Release prep for 4.12.0. #587 (bmjen)
• catch StandardError rather than the gratuitous Exception #586 (ffrank)
• [MODULES-2370] file_line.rb: Fix line attribute validation #585 ()
• Add validate_email_address function #583 (jyaworski)
• MODULES-3201 - Fixed typo 'absense' to 'absence' #582 (derekmceachern)
• improve suffix function to support the same feature set as prefix #581 (vicinus)
• Expose the functions of ruby's built-in Shellwords module #580 (Joris-van-der-Wel)
• Add check if Gem is defined #579 (sulaweyo)
• (maint) Fixes fqdn_rand_string tests #578 (bmjen)
• Add enclose_ipv6 function #577 (EmilienM)
• ensure_packages.rb: Modifed to pass hiera parameters (as hash,array) as first argument #576 (yadavnikhil)
• Extend Base64() function support #575 (guessi)
• (FM-4046) Update to current msync configs [006831f][#574](https://github.com/puppetlabs/puppetlabs-stdlib/pull/574) (DavidS)
• Add dig function #573 (mks-m)
• Add is_ipv4_address and is_ipv6_address functions #570 (gfidente)
• (FM-4049) update to modulesync_configs #569 (DavidS)
• Fix reference to validate_bool in function #568 (mattbostock)
• Add test for basename on path with scheme #567 (alechenninger)
• 4.11.0 merge back #566 (tphoney)

4.11.0 - 2016-01-11

Full Changelog

Added

• Add a function to validate an x509 RSA key pair #552 (mattbostock)
• Add clamp function #545 (mpolenchuk)

Other

• minor tweak to 4.11.0 adding debian 8 to metadata #565 (tphoney)
• 4.11.0 prep #564 (tphoney)
• Allow package_provider fact to resolve on PE 3.x #561 (DavidS)
• (FM-3802) make ensure_resource test of packages #559 (DavidS)
• 4.10.x mergeback #558 (bmjen)
• adds new parser called is_absolute_path #553 (logicminds)

4.10.0 - 2015-12-15

Full Changelog

Other

• edits to README #557 (jbondpdx)
• Changelog and versionbump for 4.10.0 #556 (HelenCampbell)
• 4.9.x Mergeback #555 (HelenCampbell)
• (#2886) seeded_rand: new function #554 (kjetilho)

4.9.1 - 2015-12-04

Full Changelog

Other

• Fix reference to validate_bool in IP4 function #551 (mattbostock)
• 4.9.1 release prep #550 (tphoney)
• Fix Gemfile to work with ruby 1.8.7 #548 (bmjen)
• (FM-3773) Fix root_home fact on AIX 5.x #547 (reidmv)
• Add validator for any IP address #546 (devvesa)
• pick_default addition to readme #544 (HelenCampbell)
• Use absolute class name in example #543 (ghoneycutt)
• use properly encoded characters #542 (greg0ire)
• Fix capitalize docs #541 (mattflaschen)
• (#2183) updated str2bool readme wording #540 (marrero984)
• Add check to ensure regex does not throw for none type. #539 (mentat)
• add functionality to bool2str function #538 (mmckinst)
• Fix load module metadata #537 (cmurphy)
• (MODULES-2421) improve description of file_line #536 (DavidS)
• prevent deprecation warning about the allow_virtual parameter #535 (martinpfeifer)
• Add package_provider fact #534 (asasfu)
• Modules 2614 improved numeric value handling on empty function #533 (HelenCampbell)
• (FM-3701) Update README for is_a #532 (DavidS)
• fixup-PR#506 Speed improvements in facter resolution #531 (asasfu)
• Adding update to empty function readme #530 (HelenCampbell)
• Update is_a acceptance tests to only run on puppet4 #528 (underscorgan)
• Fix backwards compatibility from #511 #527 (underscorgan)
• (MAINT) validate_re: Clarify docs and error message #526 (DavidS)
• Clarify what an empty intersection looks like. #524 (binford2k)
• (MODULES-2561) add is_a function #523 (DavidS)
• accept any case of boolean strings #518 (logicminds)
• [MODULES-2462] Improve parseyaml function #511 (dmitryilyin)
• Add a service_provider fact #506 (binford2k)

4.9.0 - 2015-09-08

Full Changelog

Other

• [MAINT] Improve 'try_get_value' readme #519 (dmitryilyin)
• (MAINT) fix up try_get_value acceptance test #517 (DavidS)
• Ticket/MODULES-2478 Make root_home fact work on AIX using native lsuser command #515 (jfautley)
• Adds a convert_base function, which can convert numbers between bases #514 (DavidS)
• Add a new function "try_get_value" #513 (dmitryilyin)
• Consistent Readme #512 (Jetroid)
• (MAINT) improve base64 unit tests #510 (DavidS)
• (MODULES-2456) Modify union to accept more than two arrays #507 (Jetroid)
• (MODULES-2410) Add new functions dos2unix and unix2dos #505 (gibbsoft)
• Mergeback 4.8.x #503 (hunner)
• [MODULES-2370] allow match parameter to influence ensure => absent behavior. #499 ()

4.8.0 - 2015-08-12

Full Changelog

Added

• Add load_metadata_json function #483 (nibalizer)

Other

• Sometimes this exits 1 #502 (hunner)
• Fix extraneous end #501 (hunner)
• Prep 4.8.0 #500 (hunner)
• (MODULES-2316) Change file_type boolean parameter to symbols #497 (domcleal)
• Remove colorful language from module. #496 (big-samantha)
• 4.7.x #495 (hunner)
• [#puppethack] Adding replace attribute to file_line #494 (rmaika)
• (maint) use puppet's utility function instead of API that's not avail… #493 (DavidS)
• Fixup acceptance testing #492 (DavidS)
• Style fixes #491 (ekohl)

4.7.0 - 2015-07-23

Full Changelog

Fixed

• Check if file exists before loading with loadyaml. If not, return nil #314 (amateo)

Other

• disable pw_hash test on sles, as it only supports md5 #490 (hunner)
• adding support for hash in the size function #489 (gcmalloc)
• (maint) Fix test to not assume is_pe fact on > 4.0.0 puppet #488 (cyberious)
• Fix documentation error in upcase #487 (liv3d)
• Clarify that third argument to ensure_resource() is a hash #485 (ghoneycutt)
• Use puppet_install_helper #484 (underscorgan)
• Add validate_slength's optional 3rd arg to README #482 (DavidS)
• prep work for 4.7.0 #481 (tphoney)
• catch and rescue from looking up non-existent facts #479 (mklette)
• Add support for Solaris 12 #478 (drewfisher314)
• AIO uses puppet 4 so should return true for is_future_parser_enabled #477 (underscorgan)
• Document puppet 4 compatability in 4.6 #475 (DavidS)
• (maint) getvar: update spec to match implementation #474 (DavidS)
• (maint) update PUPPET_VERSION default to be 3.8.1 #472 (justinstoller)
• Updated travisci file to remove allow_failures on Puppet4 #471 (jonnytdevops)
• Also catch :undefined_variable as thrown by future parser #470 (bobtfish)
• Fix time() on 1.8.7 #469 (hunner)
• Fix spelling of camelcase #468 (kylog)
• Gemfile: specify minimum rspec-puppet version #467 (DavidS)
• Improve fqdn_rotate/fqdn_rand_string acceptance tests #466 (elyscape)
• simplify mac address regex #465 (igalic)
• (MODULES-1882) convert function tests to rspec-puppet #464 (DavidS)
• (MODULES-2071) Patch file_line provider to use multiple with after #463 (rmaika)
• fqdn_rotate: Don't use the value itself as part of the random seed #462 (elyscape)
• validate_integer, validate_numeric: explicitely reject hashes in arrays #461 (DavidS)
• fqdn_rotate: reset srand seed correctly on old ruby versions #460 (DavidS)
• Update CHANGELOG.md #458 (ghoneycutt)
• DOC-1504: Readme edits #456 (jtappa)
• Remove all the pops stuff #455 (hunner)
• (FM-2130) Document new location of facts.d cache #454 (elyscape)
• sync via modulesync #449 (underscorgan)
• range(): fix TypeError(can't convert nil into Integer) when using range ... #448 (DavidS)
• Restore removed functionality to range() #447 (elyscape)
• Fix pw_hash() on JRuby < 1.7.17 #446 (elyscape)
• Prep work for new specs #443 (DavidS)
• uses include type class declaration #441 (mrzarquon)
• fqdn_rand_string: fix argument error message #440 (DavidS)
• 4.6.x #439 (hunner)

4.6.0 - 2015-04-15

Full Changelog

Added

• Add Hash to upcase #417 (cyberious)
• (MODULES-560) Add new functions validate_numeric() and validate_integer(). #375 (poikilotherm)

Fixed

• (MODULES-1670) Do not match dotted-quad IP address as domain name #404 (roderickm)

Other

• Fix the 4.6.0 release date #438 (hunner)
• Prep for 4.6.0 #437 (hunner)
• Modules-2474: Only runs enhanced salts functions test on systems that ... #434 (bmjen)
• Fix acceptance tests for #405 #433 (cmurphy)
• Fix unsupported platforms variable name in tests #432 (cmurphy)
• File_line checks provided after param if no match is found #431 (bmjen)
• Clarifying behaviour of attributes and adding an extra example. #430 (underscorgan)
• Update Travis CI job from current modulesync_configs #429 (DavidS)
• Make each function a link in the readme #428 (nibalizer)
• (BKR-147) add Gemfile setting for BEAKER_VERSION for puppet... #426 (anodelman)
• Fix off-by-one error in validate_augeas_spec.rb that was causing rspec failure #425 (jeffcoat)
• Add ability to pin beaker versions #423 (cyberious)
• Assert private #422 (cyberious)
• Add support for hashes in the prefix function #420 (underscorgan)
• Loosen the restrictions of upcase and allow for recursion of the objects... #419 (cyberious)
• Fix issue with 1.8.7 and upcase #418 (cyberious)
• Remove travis badge #415 (nibalizer)
• Check for string before copying #413 (underscorgan)
• (MODULES-1771) Don't modify input to is_domain_name() #412 (seanmil)
• Fix Travis builds #411 (elyscape)
• Adding markdown for the range() function's 3rd argument #410 (robruma)
• (MODULES-1737) Add pw_hash() function #408 (elyscape)
• Add a ceiling function to complement the floor function. #407 (adamcrews)
• (MODULES-1738) Don't modify the global seed in fqdn_rotate() #406 (elyscape)
• (MODULES-1715) Add FQDN-based random string generator #405 (elyscape)
• Merge 4.6.x back to master #403 (cyberious)
• Merge 4.5.x into 4.6.x #402 (cyberious)
• Dirname typecheck #369 (rfugina)

4.5.1 - 2015-01-14

Full Changelog

Other

• FM-2131 Move to non temp directory for factor_dot_d #401 (cyberious)
• Pull in RSpec 3.0 fixes. #398 (cyberious)
• 4.6.x #397 (cyberious)
• Change all to each #396 (hunner)
• FM-2130 Move cache file to non temp directory #395 (cyberious)
• Add IntelliJ files to the ignore list #394 (cmurphy)
• Update docs to reflect new behavior of delete function taking array in second argument #393 (cyberious)
• MODULES-1606 add ability to pass array to delete for items to delete #392 (cyberious)
• Update README #391 (petems)
• Fix bad check in test #389 (underscorgan)
• Merge 4.5.x into master #388 (underscorgan)
• (MODULES-1473) Deprecate type() function for new parser #382 (hunner)
• (MODULES-1582) File location placeholder #377 (petems)
• MODULES-444-Add concat multiple #374 (petems)
• Allow array of pathes in validate_absolute_path #372 (poikilotherm)
• Basename implementation #368 (rfugina)
• ensure_resource: be more verbose in debug mode #336 (mklette)
• Correct function name in changelog #301 (3flex)

4.5.0 - 2014-12-16

Full Changelog

Other