Version information
This version is compatible with:
- Puppet Enterprise 2023.2.x, 2023.1.x, 2023.0.x, 2021.7.x, 2021.6.x, 2021.5.x, 2021.4.x, 2021.3.x, 2021.2.x, 2021.1.x, 2021.0.x, 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x
- Puppet >= 6.0.0 < 8.0.0
- , , , , , , , , , , ,
Start using this module
Add this module to your Puppetfile:
mod 'puppetlabs-stdlib', '8.6.0'
Learn more about managing modules with a PuppetfileDocumentation
stdlib
Table of Contents
Overview
This module provides a standard library of resources for Puppet modules.
Module Description
Puppet modules make heavy use of this standard library. The stdlib module adds the following resources to Puppet:
- Stages
- Facts
- Functions
- Defined types
- Data types
- Providers
Note: As of version 3.7, Puppet Enterprise no longer includes the stdlib module. If you're running Puppet Enterprise, you should install the most recent release of stdlib for compatibility with Puppet modules.
Setup
Install the stdlib module to add the functions, facts, and resources of this standard library to Puppet.
If you are authoring a module that depends on stdlib, be sure to specify dependencies in your metadata.json.
Usage
Most of stdlib's features are automatically loaded by Puppet. To use standardized run stages in Puppet, declare this class in your manifest with include stdlib
.
When declared, stdlib declares all other classes in the module. This currently consists of stdlib::manage
and stdlib::stages
.
The stdlib::stages
class 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
Sample usage:
node default {
include stdlib
class { java: stage => 'runtime' }
}
The stdlib::manage
class provides an interface for generating trivial resource declarations via the create_resources
parameter. Depending on your usage, you may want to set hiera
's lookup_options
for the stdlib::manage::create_resources:
element.
---
stdlib::manage::create_resources:
file:
/etc/somefile:
ensure: file
owner: root
group: root
package:
badpackage:
ensure: absent
Reference
For information on the classes and types, see the REFERENCE.md.
Data types
Stdlib::Absolutepath
A strict absolute path type. Uses a variant of Unixpath and Windowspath types.
Acceptable input examples:
/var/log
/usr2/username/bin:/usr/local/bin:/usr/bin:.
C:\\WINDOWS\\System32
Unacceptable input example:
../relative_path
Stdlib::Ensure::Service
Matches acceptable ensure values for service resources.
Acceptable input examples:
stopped
running
Unacceptable input example:
true
false
Stdlib::HTTPSUrl
Matches HTTPS URLs. It is a case insensitive match.
Acceptable input example:
https://hello.com
HTTPS://HELLO.COM
Unacceptable input example:
httds://notquiteright.org`
Stdlib::HTTPUrl
Matches both HTTPS and HTTP URLs. It is a case insensitive match.
Acceptable input example:
https://hello.com
http://hello.com
HTTP://HELLO.COM
Unacceptable input example:
httds://notquiteright.org
Stdlib::MAC
Matches MAC addresses defined in RFC5342.
Stdlib::Unixpath
Matches absolute paths on Unix operating systems.
Acceptable input example:
/usr2/username/bin:/usr/local/bin:/usr/bin:
/var/tmp
Unacceptable input example:
C:/whatever
some/path
../some/other/path
Stdlib::Filemode
Matches octal file modes consisting of one to four numbers and symbolic file modes.
Acceptable input examples:
0644
1777
a=Xr,g=w
Unacceptable input examples:
x=r,a=wx
0999
Stdlib::Windowspath
Matches paths on Windows operating systems.
Acceptable input example:
C:\\WINDOWS\\System32
C:\\
\\\\host\\windows
Valid values: A windows filepath.
Stdlib::Filesource
Matches paths valid values for the source parameter of the Puppet file type.
Acceptable input example:
http://example.com
https://example.com
file:///hello/bla
Valid values: A filepath.
Stdlib::Fqdn
Matches paths on fully qualified domain name.
Acceptable input example:
localhost
example.com
www.example.com
Valid values: Domain name of a server.
Stdlib::Host
Matches a valid host which could be a valid ipv4, ipv6 or fqdn.
Acceptable input example:
localhost
www.example.com
192.0.2.1
Valid values: An IP address or domain name.
Stdlib::Port
Matches a valid TCP/UDP Port number.
Acceptable input examples:
80
443
65000
Valid values: An Integer.
Stdlib::Port::Privileged
Matches a valid TCP/UDP Privileged port i.e. < 1024.
Acceptable input examples:
80
443
1023
Valid values: A number less than 1024.
Stdlib::Port::Unprivileged
Matches a valid TCP/UDP Privileged port i.e. >= 1024.
Acceptable input examples:
1024
1337
65000
Valid values: A number more than or equal to 1024.
Stdlib::Base32
Matches paths a valid base32 string.
Acceptable input example:
ASDASDDASD3453453
asdasddasd3453453=
ASDASDDASD3453453==
Valid values: A base32 string.
Stdlib::Base64
Matches paths a valid base64 string.
Acceptable input example:
asdasdASDSADA342386832/746+=
asdasdASDSADA34238683274/6+
asdasdASDSADA3423868327/46+==
Valid values: A base64 string.
Stdlib::Ipv4
This type is no longer available. To make use of this functionality, use Stdlib::IP::Address::V4.
Stdlib::Ipv6
This type is no longer available. To make use of this functionality, use Stdlib::IP::Address::V6.
Stdlib::Ip_address
This type is no longer available. To make use of this functionality, use Stdlib::IP::Address
Stdlib::IP::Address
Matches any IP address, including both IPv4 and IPv6 addresses. It will match them either with or without an address prefix as used in CIDR format IPv4 addresses.
Examples:
'127.0.0.1' =~ Stdlib::IP::Address # true
'10.1.240.4/24' =~ Stdlib::IP::Address # true
'52.10.10.141' =~ Stdlib::IP::Address # true
'192.168.1' =~ Stdlib::IP::Address # false
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address # true
'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address # true
Stdlib::IP::Address::V4
Match any string consisting of an IPv4 address in the quad-dotted decimal format, with or without a CIDR prefix. It will not match any abbreviated form (for example, 192.168.1) because these are poorly documented and inconsistently supported.
Examples:
'127.0.0.1' =~ Stdlib::IP::Address::V4 # true
'10.1.240.4/24' =~ Stdlib::IP::Address::V4 # true
'192.168.1' =~ Stdlib::IP::Address::V4 # false
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V4 # false
'12AB::CD30:192.168.0.1' =~ Stdlib::IP::Address::V4 # false
Valid values: An IPv4 address.
Stdlib::IP::Address::V6
Match any string consisting of an IPv6 address in any of the documented formats in RFC 2373, with or without an address prefix.
Examples:
'127.0.0.1' =~ Stdlib::IP::Address::V6 # false
'10.1.240.4/24' =~ Stdlib::IP::Address::V6 # false
'FEDC:BA98:7654:3210:FEDC:BA98:7654:3210' =~ Stdlib::IP::Address::V6 # true
'FF01:0:0:0:0:0:0:101' =~ Stdlib::IP::Address::V6 # true
'FF01::101' =~ Stdlib::IP::Address::V6 # true
Valid values: An IPv6 address.
Stdlib::IP::Address::Nosubnet
Match the same things as the Stdlib::IP::Address
alias, except it will not match an address that includes an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24').
Valid values: An IP address with no subnet.
Stdlib::IP::Address::V4::CIDR
Match an IPv4 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match '192.168.0.6/24' but not '192.168.0.6').
Valid values: An IPv4 address with a CIDR provided eg: '192.186.8.101/105'. This will match anything inclusive of '192.186.8.101' to '192.168.8.105'.
Stdlib::IP::Address::V4::Nosubnet
Match an IPv4 address only if the address does not contain an address prefix (for example, it will match '192.168.0.6' but not '192.168.0.6/24').
Valid values: An IPv4 address with no subnet.
Stdlib::IP::Address::V6::Full
Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of RFC 2373, with or without an address prefix as documented in section 2.3 of RFC 2373.
Stdlib::IP::Address::V6::Alternate
Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will match addresses with or without an address prefix as documented in section 2.3 of RFC 2373.
Stdlib::IP::Address::V6::Compressed
Match an IPv6 address which may contain ::
used to compress zeros as documented in section 2.2.2 of RFC 2373. It will match addresses with or without an address prefix as documented in section 2.3 of RFC 2373.
Stdlib::IP::Address::V6::Nosubnet
Alias to allow Stdlib::IP::Address::V6::Nosubnet::Full
, Stdlib::IP::Address::V6::Nosubnet::Alternate
and Stdlib::IP::Address::V6::Nosubnet::Compressed
.
Stdlib::IP::Address::V6::Nosubnet::Full
Match an IPv6 address formatted in the "preferred form" as documented in section 2.2 of RFC 2373. It will not match addresses with address prefix as documented in section 2.3 of RFC 2373.
Stdlib::IP::Address::V6::Nosubnet::Alternate
Match an IPv6 address formatted in the "alternative form" allowing for representing the last two 16-bit pieces of the address with a quad-dotted decimal, as documented in section 2.2.1 of RFC 2373. It will only match addresses without an address prefix as documented in section 2.3 of RFC 2373.
Stdlib::IP::Address::V6::Nosubnet::Compressed
Match an IPv6 address which may contain ::
used to compress zeros as documented in section 2.2.2 of RFC 2373. It will only match addresses without an address prefix as documented in section 2.3 of RFC 2373.
Stdlib::IP::Address::V6::CIDR
Match an IPv6 address in the CIDR format. It will only match if the address contains an address prefix (for example, it will match 'FF01:0:0:0:0:0:0:101/32', 'FF01::101/60', '::/0', but not 'FF01:0:0:0:0:0:0:101', 'FF01::101', '::').
Stdlib::ObjectStore
Matches cloud object store uris.
Acceptable input example:
s3://mybucket/path/to/file
gs://bucket/file
Valid values: cloud object store uris.
Stdlib::ObjectStore::GSUri
Matches Google Cloud object store uris.
Acceptable input example:
gs://bucket/file
gs://bucket/path/to/file
Valid values: Google Cloud object store uris.
Stdlib::ObjectStore::S3Uri
Matches Amazon Web Services S3 object store uris.
Acceptable input example:
s3://bucket/file
s3://bucket/path/to/file
Valid values: Amazon Web Services S3 object store uris.
Stdlib::Syslogfacility
An enum that defines all syslog facilities defined in RFC5424. This is based on work in the voxpupuli/nrpe module.
Facts
package_provider
Returns the default provider Puppet uses to manage packages on this system.
is_pe
Returns whether Puppet Enterprise is installed. Does not report anything on platforms newer than PE 3.x.
pe_version
Returns the version of Puppet Enterprise installed. Does not report anything on platforms newer than PE 3.x.
pe_major_version
Returns the major version Puppet Enterprise that is installed. Does not report anything on platforms newer than PE 3.x.
pe_minor_version
Returns the minor version of Puppet Enterprise that is installed. Does not report anything on platforms newer than PE 3.x.
pe_patch_version
Returns the patch version of Puppet Enterprise that is installed.
puppet_vardir
Returns the value of the Puppet vardir setting for the node running Puppet or Puppet agent.
puppet_environmentpath
Returns the value of the Puppet environment path settings for the node running Puppet or Puppet agent.
puppet_server
Returns the Puppet agent's server
value, which is the hostname of the Puppet server with which the agent should communicate.
root_home
Determines the root home directory.
Determines the root home directory, which depends on your operating system. Generally this is '/root'.
service_provider
Returns the default provider Puppet uses to manage services on this system
Limitations
As of Puppet Enterprise 3.7, the stdlib module is no longer included in PE. PE users should install the most recent release of stdlib for compatibility with Puppet modules.
For an extensive list of supported operating systems, see metadata.json
Development
Puppet modules on the Puppet Forge are open projects, and community contributions are essential for keeping them great. We can’t access the huge number of platforms and myriad hardware, software, and deployment configurations that Puppet is intended to serve. We want to keep it as easy as possible to contribute changes so that our modules work in your environment. There are a few guidelines that we need contributors to follow so that we can have a chance of keeping on top of things. For more information, see our module contribution guide.
To report or research a bug with any part of this module, please go to http://tickets.puppetlabs.com/browse/MODULES.
Contributors
The list of contributors can be found at: https://github.com/puppetlabs/puppetlabs-stdlib/graphs/contributors.
Reference
Table of Contents
Classes
stdlib
: This module manages stdlib.stdlib::manage
: A simple place to define trivial resourcesstdlib::stages
: This class manages a standard set of run stages for Puppet. It is managed by the stdlib class, and should not be declared independently.
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 numberany2array
: This converts any object to an array containing that object.any2bool
: Converts 'anything' to a boolean.assert_private
: Sets the current class or definition as private.base64
: Base64 encode or decode a string based on the command and the string submittedbasename
: Strips directory (and optional suffix) from a filenamebatch_escape
: Escapes a string so that it can be safely used in a batch shell command line.bool2num
: Converts a boolean to a number.bool2str
: Converts a boolean to a string using optionally supplied arguments.camelcase
: Deprecated Converts the case of a string or all strings in an array to camel case.capitalize
: Deprecated Capitalizes the first letter of a string or array of strings.ceiling
: Deprecated Returns the smallest integer greater or equal to the argument.chomp
: Deprecated Removes the record separator from the end of a string or an array of strings.chop
: Deprecated Returns a new string with the last character removed.clamp
: Keeps value within the range [Min, X, Max] by sort based on integer value (parameter order doesn't matter).concat
: Appends the contents of multiple arrays into array 1.convert_base
: Converts a given integer or base 10 string representing an integer to a specified base, as a string.count
: Counts the number of elements in array.deep_merge
: Recursively merges two or more hashes together and returns the resulting hash.defined_with_params
: Takes a resource reference and an optional hash of attributes.delete
: Deletes all instances of a given element from an array, substring from a string, or key from a hash.delete_at
: Deletes a determined indexed value from an array.delete_regex
: Deletes all instances of a given element that match a regular expression from an array or key from a hash.delete_undef_values
: Returns a copy of input hash or array with all undefs deleted.delete_values
: Deletes all instances of a given value from a hash.deprecation
: Function to print deprecation warnings, Logs a warning once for a given key. The uniqueness key - can appear once. The msg is the message tedeprecation
: Function to print deprecation warnings (this is the 3.X version of it).difference
: This function returns the difference between two arrays.dig
: DEPRECATED Retrieves a value within multiple layers of hashes and arrays via an array of keys containing a path.dig44
: DEPRECATED: Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found.dirname
: Returns the dirname of a path.dos2unix
: Returns the Unix version of the given string.downcase
: Deprecated: Converts the case of a string or all strings in an array to lower case.empty
: Deprecated: Returns true if the variable is empty.enclose_ipv6
: Takes an array of ip addresses and encloses the ipv6 addresses with square brackets.ensure_packages
: Takes a list of packages and only installs them if they don't already exist.ensure_packages
: Deprecated 3x version of theensure_packages
functionensure_resource
: Takes a resource type, title, and a list of attributes that describe a resource.ensure_resources
: Takes a resource type, title (only hash), and a list of attributes that describe a resource.fact
: Digs into the facts hash using dot-notationflatten
: This function flattens any deeply nested arrays and returns a single flat array as a result.floor
: Returns the largest integer less or equal to the argument.fqdn_rand_string
: Generates a random alphanumeric string. Combining the$fqdn
fact and an optional seed for repeatable randomness.fqdn_rotate
: Rotates an array or string a random number of times, combining the$fqdn
fact and an optional seed for repeatable randomness.fqdn_uuid
: Returns a RFC 4122 valid version 5 UUID based on an FQDN string under the DNS namespaceget_module_path
: Returns the absolute path of the specified module for the current environment.getparam
: Returns the value of a resource's parameter.getvar
: Lookup a variable in a given namespace.glob
: Uses same patterns as Dir#glob.grep
: This function searches through an array and returns any elements that match the provided regular expression.has_interface_with
: Returns boolean based on kind and value.has_ip_address
: Returns true if the client has the requested IP address on some interface.has_ip_network
: Returns true if the client has an IP address within the requested network.has_key
: Deprecated: Determine if a hash has a certain key value.hash
: Deprecated: This function converts an array into a hash.intersection
: This function returns an array of the intersection of two.is_a
: Boolean check to determine whether a variable is of a given data type. This is equivalent to the=~
type checks.is_absolute_path
: Wrapper that calls the Puppet 3.x function of the same name.is_absolute_path
: Deprecated: Returns boolean true if the string represents an absolute path in the filesystem.is_array
: Wrapper that calls the Puppet 3.x function of the same name.is_array
: Deprecated: Returns true if the variable passed to this function is an array.is_bool
: Wrapper that calls the Puppet 3.x function of the same name.is_bool
: Deprecated: Returns true if the variable passed to this function is a boolean.is_domain_name
: Deprecated: Returns true if the string passed to this function is a syntactically correct domain name.is_email_address
: Deprecated: Returns true if the string passed to this function is a valid email address.is_float
: Wrapper that calls the Puppet 3.x function of the same name.is_float
: Deprecated: Returns true if the variable passed to this function is a float.is_function_available
: Deprecated: Determines whether the Puppet runtime has access to a function by that name.is_hash
: Deprecated: Returns true if the variable passed to this function is a hash.is_integer
: Deprecated: Returns true if the variable passed to this function is an Integer or a decimal (base 10) integer in String form.is_ip_address
: Wrapper that calls the Puppet 3.x function of the same name.is_ip_address
: Deprecated: Returns true if the string passed to this function is a valid IP address.is_ipv4_address
: Wrapper that calls the Puppet 3.x function of the same name.is_ipv4_address
: Deprecated: Returns true if the string passed to this function is a valid IPv4 address.is_ipv6_address
: Wrapper that calls the Puppet 3.x function of the same name.is_ipv6_address
: Deprecated: Returns true if the string passed to this function is a valid IPv6 address.is_mac_address
: Deprecated: Returns true if the string passed to this function is a valid mac address.is_numeric
: Wrapper that calls the Puppet 3.x function of the same name.is_numeric
: Deprecated: Returns true if the given value is numeric.is_string
: Wrapper that calls the Puppet 3.x function of the same name.is_string
: Deprecated: Returns true if the variable passed to this function is a string.join
: Deprecated: This function joins an array into a string using a separator.join_keys_to_values
: This function joins each key of a hash to that key's corresponding value with a separator.keys
: Deprecated: Returns the keys of a hash as an array.length
: Deprecated: A function to eventually replace the old size() function for stdlibload_module_metadata
: This function loads the metadata of a given module.loadjson
: Load a JSON file containing an array, string, or hash, and return the data in the corresponding native data type.loadyaml
: Load a YAML file containing an array, string, or hash, and return the data in the corresponding native data type.lstrip
: Deprecated: Strips leading spaces to the left of a string.max
: Deprecated: Returns the highest value of all arguments.member
: This function determines if a variable is a member of an array.merge
: Merges two or more hashes together or hashes resulting from iteration, and returns the resulting hash.merge
: Merges two or more hashes together and returns the resulting hash.min
: Deprecated: Returns the lowest value of all arguments.num2bool
: This function converts a number or a string representation of a number into a true boolean.os_version_gte
: Checks if the OS version is at least a certain version.parsehocon
: This function accepts HOCON as a string and converts it into the correct Puppet structureparsejson
: This function accepts JSON as a string and converts it into the correct Puppet structure.parsepson
: This function accepts PSON, a Puppet variant of JSON, as a string and converts it into the correct Puppet structureparseyaml
: This function accepts YAML as a string and converts it into the correct Puppet structure.pick
: This function will return the first value in a list of values that is not undefined or an empty string.pick_default
: This function will return the first value in a list of values that is not undefined or an empty string.powershell_escape
: Escapes a string so that it can be safely used in a PowerShell command line.prefix
: This function applies a prefix to all elements in an array or a hash.private
: Deprecated: Sets the current class or definition as private. Calling the class or definition from outside the current module will fail.pry
: This function invokes a pry debugging session in the current scope object.pw_hash
: Hashes a password using the crypt function. Provides a hash usable on most POSIX systems.range
: When given range in the form of (start, stop) it will extrapolate a range as an array.regexpescape
: Regexp escape a string or array of strings. Requires either a single string or an array as an input.reject
: This function searches through an array and rejects all elements that match the provided regular expression.reverse
: Reverses the order of a string or array.round
: Rounds a number to the nearest integerrstrip
: Strips leading spaces to the right of the string.seeded_rand
: Generates a random whole number greater than or equal to 0 and less than MAX, using the value of SEED for repeatable randomness.seeded_rand_string
: Generates a consistent random string of specific length based on provided seed.shell_escape
: Escapes a string so that it can be safely used in a Bourne shell command line.shell_join
: Builds a command line string from the given array of strings. Each array item is escaped for Bourne shell. All items are then joined togethershell_split
: Splits a string into an array of tokens in the same way the Bourne shell does.shuffle
: @summary Randomizes the order of a string or array elements.size
: Returns the number of elements in a string, an array or a hashsort
: Sorts strings and arrays lexically.sprintf_hash
: Uses sprintf with named references.squeeze
: Returns a new string where runs of the same character that occur in this set are replaced by a single character.stdlib::crc32
: Run a CRC32 calculation against a given value.stdlib::deferrable_epp
: This function returns either a rendered template or a deferred function to render at runtime. If any of the values in the variables hash arestdlib::end_with
: Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String.stdlib::ensure
: function to cast ensure parameter to resource specific valuestdlib::extname
: Returns the Extension (the Portion of Filename in Path starting from the last Period).stdlib::ip_in_range
: Returns true if the ipaddress is within the given CIDRsstdlib::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 filesstr2bool
: This converts a string to a boolean.str2saltedpbkdf2
: Convert a string into a salted SHA512 PBKDF2 password hash like requred for OS X / macOS 10.8+str2saltedsha512
: This converts a string to a salted-SHA512 password hash (which is used for OS X versions >= 10.7).strip
: This function removes leading and trailing whitespace from a string or from every string inside an array.suffix
: This function applies a suffix to all elements in an array, or to the keys in a hash.swapcase
: This function will swap the existing case of a string.time
: This function will return the current time since epoch as an integer.to_bytes
: Converts the argument into bytes, for example 4 kB becomes 4096.to_json
: Convert a data structure and output to JSONto_json_pretty
: Convert data structure and output to pretty JSONto_python
: Convert an object into a String containing its Python representationto_ruby
: Convert an object into a String containing its Ruby representationto_toml
: Convert a data structure and output to TOML.to_yaml
: Convert a data structure and output it as YAMLtry_get_value
: DEPRECATED: this function is deprecated, please use dig() instead.type
: DEPRECATED: This function will cease to function on Puppet 4;type3x
: DEPRECATED: This function will be removed when Puppet 3 support is dropped; please migrate to the new parser's typing system.type_of
: Returns the type of the passed value.union
: This function returns a union of two or more arrays.unique
: This function will remove duplicates from strings and arrays.unix2dos
: Returns the DOS version of the given string.upcase
: Converts a string or an array of strings to uppercase.uriescape
: Urlencodes a string or array of strings. Requires either a single string or an array as an input.validate_absolute_path
: Validate the string represents an absolute path in the filesystem.validate_absolute_path
: Validate the string represents an absolute path in the filesystem. This function works for windows and unix style paths.validate_array
: Validate the passed value represents an array.validate_array
: Validate that all passed values are array data structures. Abort catalog compilation if any value fails this check.validate_augeas
: Perform validation of a string using an Augeas lensvalidate_bool
: Validate the passed value represents a boolean.validate_bool
: Validate that all passed values are either true or false. Abort catalog compilation if any value fails this check.validate_cmd
: Perform validation of a string with an external command.validate_domain_name
: Validate that all values passed are syntactically correct domain names. Fail compilation if any value fails this check.validate_email_address
: Validate that all values passed are valid email addresses. Fail compilation if any value fails this check.validate_hash
: Validate the passed value represents a hash.validate_hash
: Validate that all passed values are hash data structures. Abort catalog compilation if any value fails this check.validate_integer
: Validate the passed value represents an integer.validate_integer
: Validate that the first argument is an integer (or an array of integers). Abort catalog compilation if any of the checks fail.validate_ip_address
: Validate the passed value represents an ip_address.validate_ip_address
: Validate that all values passed are valid IP addresses, regardless they are IPv4 or IPv6 Fail compilation if any value fails this check.validate_ipv4_address
: Validate the passed value represents an ipv4_address.validate_ipv4_address
: Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check.validate_ipv6_address
: Validate the passed value represents an ipv6_address.validate_ipv6_address
: Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check.validate_legacy
: Validate a value against both the target_type (new) and the previous_validation function (old).validate_numeric
: Validate the passed value represents a numeric value.validate_numeric
: Validate that the first argument is a numeric value (or an array of numeric values). Abort catalog compilation if any of the checks fail.validate_re
: Perform validation of a string against one or more regular expressions.validate_re
: Perform simple validation of a string against one or more regular expressions.validate_slength
: Validate that a passed string has length less/equal with the passed valuevalidate_slength
: Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument.validate_string
: Validate that all passed values are string data structures.validate_string
: Validate that all passed values are string data structuresvalidate_x509_rsa_key_pair
: Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL.values
: When given a hash this function will return the values of that hash.values_at
: Finds value inside an array based on location.zip
: Takes one element from first array and merges corresponding elements from second array.
Data types
Stdlib::Absolutepath
: A strict absolutepath typeStdlib::Base32
: Type to match base32 StringStdlib::Base64
: Type to match base64 StringStdlib::Compat::Absolute_path
: Emulate the is_absolute_path and validate_absolute_path functionsStdlib::Compat::Array
: Emulate the is_array and validate_array functionsStdlib::Compat::Bool
: Emulate the is_bool and validate_bool functionsStdlib::Compat::Float
: Emulate the is_float functionStdlib::Compat::Hash
: Emulate the is_hash and validate_hash functionsStdlib::Compat::Integer
: Emulate the is_integer and validate_integer functionsStdlib::Compat::Ip_address
: Validate an IP addressStdlib::Compat::Ipv4
: Emulate the validate_ipv4_address and is_ipv4_address functionsStdlib::Compat::Ipv6
: Validate an IPv6 addressStdlib::Compat::Numeric
: Emulate the is_numeric and validate_numeric functionsStdlib::Compat::String
: Emulate the is_string and validate_string functionsStdlib::CreateResources
: A type description used for the create_resources functionStdlib::Datasize
: Validate the size of dataStdlib::Email
: Validate an e-mail addressStdlib::Ensure::File
: Validate the value of the ensure parameter for a fileStdlib::Ensure::File::Directory
: Validate the ensure parameter of a "directory" file resourceStdlib::Ensure::File::File
: Validate the ensure parameter of a "file" file resourceStdlib::Ensure::File::Link
: Validate the ensure parameter of a "link" file resourceStdlib::Ensure::Package
: Validate the value of the ensure parameter for a packageStdlib::Ensure::Service
: Validate the value of the ensure parameter of a service resourceStdlib::Filemode
: Validate a file modeStdlib::Filesource
: Validate the source parameter on file typesStdlib::Fqdn
: Validate a Fully Qualified Domain NameStdlib::HTTPSUrl
: Validate a HTTPS URLStdlib::HTTPUrl
: Validate a HTTP(S) URLStdlib::Host
: Validate a host (FQDN or IP address)Stdlib::Http::Method
: Valid HTTP method verbsStdlib::Http::Status
: A valid HTTP status code per RFC9110Stdlib::HttpStatus
: Validate a HTTP status codeStdlib::IP::Address
: Validate an IP addressStdlib::IP::Address::Nosubnet
: Validate an IP address without subnetStdlib::IP::Address::V4
: Validate an IPv4 addressStdlib::IP::Address::V4::CIDR
: lint:ignore:140charsStdlib::IP::Address::V4::Nosubnet
: lint:ignore:140charsStdlib::IP::Address::V6
: Validate an IPv6 addressStdlib::IP::Address::V6::Alternative
: lint:ignore:140charsStdlib::IP::Address::V6::CIDR
: lint:ignore:140charsStdlib::IP::Address::V6::Compressed
: Validate a compressed IPv6 addressStdlib::IP::Address::V6::Full
: Validate a full IPv6 addressStdlib::IP::Address::V6::Nosubnet
: Validate an IPv6 address without subnetStdlib::IP::Address::V6::Nosubnet::Alternative
: lint:ignore:140charsStdlib::IP::Address::V6::Nosubnet::Compressed
: Validate compressed IPv6 address without subnetStdlib::IP::Address::V6::Nosubnet::Full
: Validate full IPv6 address without subnetStdlib::MAC
: A type for a MAC addressStdlib::ObjectStore
: Validate an ObjectStoreStdlib::ObjectStore::GSUri
: Validate a Google Cloud object store URIStdlib::ObjectStore::S3Uri
: Validate an Amazon Web Services S3 object store URIStdlib::Port
: Validate a port numberStdlib::Port::Dynamic
: Validate a dynamic port numberStdlib::Port::Ephemeral
: Validate an ephemeral port numberStdlib::Port::Privileged
: Validate a priviliged port numberStdlib::Port::Registered
: Validate a registered port numberStdlib::Port::Unprivileged
: Validate an unprivileged port numberStdlib::Port::User
: Validate a port number usable by a userStdlib::Syslogfacility
: Validate a syslog facilityStdlib::Unixpath
: Validate a UNIX pathStdlib::Windowspath
: Validate a Windows pathStdlib::Yes_no
: Validate a yes / no value
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
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
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 seebinary_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 seebinary_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
, andFloat.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
, andFloat.new
function are used to convert to numeric values.notice(Integer(false)) # Notices 0 notice(Float(true)) # Notices 1.0
Returns: Integer
The converted value as a number
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'
$data
The data structure we are working with.['a', 'b', 2]
The path array.not_found
The default value. It is returned if nothing is found.
Note:* Deprecated** This function has been replaced with a built-in
dig
function as of Puppet 4.5.0. Usedig44()
for backwards compatibility or use the new version.
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'
$data
The data structure we are working with.['a', 'b', 2]
The path array.not_found
The default value. It is returned if nothing is found.
Note:* Deprecated** This function has been replaced with a built-in
dig
function as of Puppet 4.5.0. Usedig44()
for backwards compatibility or use the new version.
Returns: Any
The function goes through the structure by each path component and tries to return
the value at the end of the path.
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 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)
The is_ip_address 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_ip_address
Type: Ruby 3.x API
Note:* Deprecated** Will be removed in a future version of stdlib. See
validate_legacy
.
is_ip_address()
Change log
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.
The format is based on Keep a Changelog and this project adheres to Semantic Versioning.
v8.6.0 - 2023-04-24
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)
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)
Added
v8.3.0 (2022-07-11)
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)
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)
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)
Changed
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)
Fixed
v7.1.0 (2021-05-17)
Added
v7.0.1 (2021-04-12)
Fixed
- Fix typo in validate_ipv6_address function #1176 (nbarrientos)
v7.0.0 (2021-03-01)
Changed
- pdksync - Remove Puppet 5 from testing and bump minimal version to 6.0.0 #1164 (carabasdaniel)
Added
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)
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)
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-20)
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)
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)
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)
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-10)
Changed
- pdksync - (MODULES-8444) - Raise lower Puppet bound #1011 (david22swan)
- (MODULES-8760) Add iterative feature to merge() function #1008 (hlindberg)
Added
5.2.0 (2019-01-17)
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-09-28)
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
Summary
This is a major release which removes support for the Scientific 5 and Debian 7 OS, as well as a removal of the Stdlib::(Ipv4|IPv6|Ip_address)
data types in favour of Stdlib::IP::*
.
In addition it contains a substantial piece of work centered around updating functions that have now been migrated into Puppet itself. Please note that this will be the last major release to support Puppet 2 and Puppet 3 and that they will soon be removed.
Fixed
- Docs URLs corrected.
- Docs clarified that
Stdlib::Unixpath
only matches absolute paths. dirname()
now fails when passed an empty string.basename()
documentation clarified.- Corrected documentation of
count()
wrt matches and empty string. - Corrected example in
getparam()
and added note about equivalent in puppet. - Fixed URL to use 'latest' instead of '5.5' for
Hash.new
function.
Added
- Support added for symbolic file nodes.
loadjson()
andloadyml()
now compatible with HTTPS files.loadjson()
andloadyml()
now compatible with HTTP basic auth files.any2array
now returns and empty array when given an empty string.- Support has now been added for Ubuntu 18.04.
seeded_rand_string()
function has been added.
Changed
- PDK update
1.5.0
has been applied. size()
function deprecated for Puppet 6 and above.wrt
functions moved to Puppet as of Puppet 6.sprintf_hash
has had notification put in place to show that as of Puppet 4.10.10 it's functionality is supported by the puppet core.- Added note that
abs()
is in puppet since 6.0.0. - Added information to
base64
function about Binary data type. - Added note to
camelcase()
that function is now in puppet. - Added note to
capitalize()
that function is now in puppet. - Added note to
ceiling()
that function is now in puppet. - Added note to
chomp()
that function is now in puppet. - Added note to
chop()
that function is now in puppet. - Added note how to do equivalence of
clamp()
function in puppet 6. - Added note that
concat()
can be done with + since puppet 4.0.0. - Added note to
convert_base()
how to do this with puppet core. - Added equivalent puppet core way of doing
count()
. - Added docs for equivalent puppet language for
delete_regexp()
. - Added docs for equivalent language constructs for
delete_at()
. - Added puppet 4 equivalent for
delete_undef()
function. - Added equivalent puppet language for
delete_values()
. - Updated
delete()
function with docs about equivalent language. - Added docs that - between arrays is the same as
difference()
. - Added note to
downcase()
that function is now in puppet. - Added note to
empty()
that function is now in puppet. - Added note to
flatten()
that function is now in puppet. - Added note to
floor()
that function is now in puppet. - Added note to
get_module_path()
that puppet has similar function. - Amended documentation for
getvar()
. - Add note to
grep()
thatfilter()
in puppet does the same. - Updated
has_key()
with equivalent puppet lang expresion. - Updated the
hash()
function to show equivalent expression. - Added note about more formatting options with
String()
in puppet. - Added note to
join()
that it is in puppet since 5.4.0. - Added note to
keys()
that it is in puppet since 5.4.0. - Added note to
lstrip()
,rstrip()
,strip()
andupcase()
that they are in puppet since 6.0.0. - Updated
member()
with equivalent language expression example. - Updated
merge()
with puppt language equivalent example. - Updated
min()
andmax()
with note that they are in puppet. - Updated
num2bool()
with information that Boolean can convert. - Updated
prefix()
function with equivalent operation in puppet. - Updated
range()
with information that Integer can be used. - Updated
reject()
with equivalent filter() call. - Added note to
reverse()
that thereverse_each()
Puppet function does the same as it. - Added note to
round()
that it has moved to puppet in 6.0.0. - Added note to
size()
thatlength()
is in puppet since 5.4.0. - Added note to
sort()
that is has moved to Puppet in 6.0.0. - Updated
str2bool()
with a note that Boolean can handle conversion. - Added note to
strftime()
that it moved to puppet in 4.8.0. - Added note to
suffix()
that the same can be done withmap()
. - Updated
time()
to mention Timespan and Timestamp data types. - Added note to
values_at()
for equivalent slice operation in language. - Added note to
values()
that it moved to puppet in 5.5.0. - Corrected docs for
keys()
- in puppet since 5.5.0. - Added note to
length()
that function moved to puppet. - Updated README.md with deprecations for functions moved to puppet.
- Updated documentation of
values_at()
. - Updated README with note from
time()
about data types for time. - Updated README for
strintf_hash()
(supported by builtin sprintf). - Updated README with deprecation of
hash()
function (use data type). - Updated README
suffix
with equiv example formap
. - Updated README with
reject
equivalent call tofilter
. - Updated README with
range
equiv use of type system +each
. - Updated README with
prefix
equiv func usingmap
. - Updated README for
num2bool
with info about Boolean type. - Updated README
str2bool
with information aboutBoolean
equivalent. - Updated README
merge
with info about+
operator equivalent. - Updated README
member
with equivalent alternative in language. - Updated README
join_keys_to_values
with link to String.new. - Updated README
has_key
shows deprecation in favor ofin
. - Updated README
grep
adds information aboutfilter
. - Updated README and
getvar.rb
as getvar has moved to puppet. - Updated README for
getparam
to be the same as in function. - Updated README
get_module_path
with info about built in variant. - Updated README
difference
to mention-
operator equiv. - Updated README
delete
with built-in alternatives. - Updated README
delete_values
with builtin equiv. - Updated README
delete_undef
&delete_regexp
with builtin equiv. - Updated README
delete_at
with equivalent built-in examples. - Updated README
coun
t to show built-in equiv. - Updated README
convert_base
with built-in equiv. - Updated README
concat
with built-in equiv using + and <<. - Updated README
base_64
with built-in equiv using Binary type. - Skipped tests for
abs
if puppet version < 6.0.0. - Skipped tests for
min
andmax
if puppet version < 6.0.0. - Skipped tests for
floor
if puppet version < 6.0.0. - Skipped tests for
ceiling
if puppet version < 6.0.0. - Skipped tests for
round
if puppet version < 6.0.0. - Skipped tests for
upcase
if puppet version < 6.0.0. - Skipped tests for
downcase
if puppet version < 6.0.0. - Skipped tests for
capitalize
if puppet version < 6.0.0. - Skipped tests for
camelcase
if puppet version < 6.0.0. - Skipped tests for strip functions if puppet version < 6.0.0.
- Skipped tests for
chop
andchomp
if puppet version < 6.0.0. - Skipped tests for
sort
if puppet version < 6.0.0. - Removed extra space in
describe
forabs
test. - Updated README and
any2array
with built-in equiv Array.new. - Updated README and
any2bool
with built-in equiv Boolean.new. - Updated README and
bool2num
with built-in equiv Numeric.new. - Updated README and
bool2str
with built-in equiv String.new. - Corrected equivalent example for
count
. - Updated README and made mention of
filter
indelete
a link. - Updated docs and tests for
strftime
. - Updated all acceptance test using Puppet.version.
- Change 'puppet' to 'Puppet' in function doc strings.
- HTTP type checks are now case insensitive.
Removed
- Support has been removed for
Scientific 5
andDebian 7
operating systems. Stdlib::(Ipv4|IPv6|Ip_address)
have been removed.
Supported Release 4.25.1
Summary
This is a patch which includes a roll up of small fixes. In Puppet 5.5.0 flatten()
, length(),
empty(),
join(),
keys(),
and values()
are now built into Puppet. Please note that the Puppet implementation of the functions will take precedence over the functions in 'puppetlabs-stdlib'.
Fixed
- Remove unneeded execute permission from test files.
- Puppet 5.5.0 function deprecation MODULES-6894.
Supported Release 4.25.0
Summary
This is quite a feature heavy release, it makes this module PDK-compliant for easier maintenance and includes a roll up of maintenance changes.
Added
- PDK conversion MODULES-6332.
- Update
join_keys_to_values
with an undef statement. - Type alias
Stdlib::Fqdn
matches paths on a fully qualified domain name. - Type alias
Stdlib::Host
matches a valid host, this can be a valid 'ipv4', 'ipv6' or 'fqdn'. - Type alias
Stdlib::Port
matches a valid TCP/UDP Port number. - Type alias
Stdlib::Filesource
matches paths valid values for the source parameter of the puppet file type. - Type alias
Stdlib::IP::Address
matches any IP address, including both IPv4 and IPv6 addresses, - Type alias
Stdlib::IP::Address::V4
matches any string consisting of a valid IPv4 address, this is extended by 'CIDR' and 'nosubnet'. - Type alias
Stdlib::IP::Address::V6
matches any string consisting of a valid IPv6 address, this is extended by 'Full', 'Alternate' and 'Compressed'. - Type alias
Stdlib::IP::Address::V6::Nosubnet
matches any string consisting of a valid IPv6 address with no subnet, this is extended by 'Full', 'Alternate' and 'Compressed'. - Type alias
Stdlib::Port
matches a valid TCP/UDP Port number this is then extended to 'Privileged' which are ports less than 1024 and 'Unprivileged' which are ports greater than 1024.
Supported Release 4.24.0
Summary
This release includes a roll up of minor changes and a new feature which provides the ability to skip undef values to_json_pretty()
.
We have also reverted a change that was previously made and resulted in breaking compatibility with Ruby 1.8.7.
Added
- Ability to skip undef values in
to_json_pretty()
. - Fix type3x function in stdlib (MODULES-6216)
Changed
- Indentation for
sync.yml
was fixed. - Updated type alias tests and dropped superfluous wrapper classes
- Revert to old ruby 1.X style of hash (MODULES-6139)
rubocop.yml
not managed by msync (MODULES-6201)
Supported Release 4.23.0
Summary
This release is in order to implement Rubocop changes throughout the module.
Added
- Standard and translated readme's have been updated.
- Rubocop has been implemented in the module and a wide variety of changes have been made to the code.
- Modulesync changes have been merged into the code.
Fixed
- Minor fix to the readme.
Supported Release 4.22.0
Summary
This is a clean release in preparation of putting the module through the rubocop process.
Added
- Support has been added for Debian 9
- 'Stdlib::Mode type' has been added to the module.
- A type for 'ensure' has been added to the service resources.
- A new function 'sprintf_hash' has been added to allow the use of named references.
Removed
- Support has been removed for: RedHat 4, CentOS 4, OracleLinux 4, Scientific 4, SLES 10 SP4, Windows Server 2003, Windows Server 2003 R2 and Windows 8.
Fixed
- The 'ruby_spec.rb' test file has been altered s that it properly checks results.
- Example syntax in 'file_line.rb' has been fixed.
Supported Release 4.21.0
Summary
This is a small feature release that includes a revamped, albeit backwards-compatible file_line type.
Added
replace_all_matches_not_matching_line
parameter in file_line- additional tests and documentation for file_line
Removed
- duplicate spec test for absolute_path
Fixed
- Unixpath type to allow "/" as valid path
- file_line behavior that caused infinite appending of
line
to a file (MODULES-5651)
Supported Release 4.20.0
Summary
This release adds new functions and updated README translations.
Added
to_json
,to_json_pretty
, andto_yaml
functions- new Japanese README translations
Fixed
- compatibility issue with older versions of Puppet and the
pw_hash
function (MODULES-5546)
Removed
- support for EOL platform Debian 6 (Squeeze)
Supported Release 4.19.0
Summary
This release adds new functions and better documentation/fixes for existing functions with a noteworthy fix for file_line.
Added
- Add validate_domain_name function
- Add the round function
- Add type for MAC address
- Add support for sensitive data type to pw_hash (MODULES-4908)
- Add new function, fact() (FACT-932)
Fixed
- Fixes for the file_line provider (MODULES-5003)
- Add documentation for email functions (MODULES-5382)
- unique function is deprecated for puppet version > 5. (FM-6239)
- Fix headers in CHANGELOG.md so that headers render correctly
- ensure_packages, converge ensure values 'present' and 'installed'
Changed
- Removes listed support for EOL Ubuntu versions
Supported Release 4.18.0
Summary
Small release that reverts the Puppet version requirement lower bound to again include Puppet 2.7+ and bumps the upper bound to now include Puppet 5.
Fixed
- Reverts lower bound of Puppet requirement to 2.7.20
Supported Release 4.17.1
Summary
Small release to address a bug (PUP-7650). Also pushes the Puppet version compatibility to 4.7.0.
Bugfixes
- (MODULES-5095) Workaround for PUP-7650
- (FM-6197) Formatting fixes for file_line resource
Supported Release 4.17.0
Summary
This release adds support for internationalization. It also contains Japanese translations for the README, summary and description of the metadata.json and major cleanups in the README. Additional folders have been introduced called locales and readmes where translation files can be found. A number of features and bug fixes are also included in this release. It also adds a new function glob()
for expanding file lists. Also works around an issue that appeared in puppet 4.6.0 involving types being declared multiple times.
Features
- Addition of POT file / folder structure for i18n.
- Addition of Internationalized READMEs.
glob()
function
Fixed
- Occasional duplicate type definitions when using
defined_with_params()
file_line
encoding issue on ruby 1.8 (unsupported)- Huge readme refresh
Supported Release 4.16.0
Summary
This release sees a massive update to all unit tests to test UTF8 characters. There are also multiple cleanups in preparation for internationalization. Alongside this, improvements to ipv6 support, a new length function compatible with Puppet 4, and an update to path types. Also contains multiple bug fixes around functionality and tests.
Features
- Addition of coverage in all unit tests for functions, data and resource types for UTF8 for i18n.
- All strings within the readme and functions that are split over two lines have been combined in preparation for i18n parser/decorator.
- Improvement on the ipv6 support for type - Improves regex to catch some valid (but lesser known) ipv6 strings, mostly those which are a mix of ipv6 strings and embedded ipv6 numbers.
- Adds a new parameter
encoding
to allow non UTF-8 files to specify a file encoding. This prevents receiving the error message "invalid byte sequence in UTF-8" when special characters that are not UTF-8 encoded appear in the input stream, such as the copyright symbol. - Addition of the new length function. Returns the length of a given string, array or hash. To eventually replace the deprecated size() function as can handle the new type functionality introduced in Puppet 4.
- Permit double slash in absolute/Unix path types.
Bugfixes
- Fix unsupported data type error with rspec-puppet server.
- Now allows test module metadata.json to be read by Puppet.
- Fix acceptance test failure "Hiera is not a class".
- Removal of unsupported platforms and future parser setting in acceptance tests.
- Regex for tuple checking has been loosened.
- Ensure_packages function - Now only tries to apply the resource if not defined.
- (MODULES-4528) Use versioncmp to check Puppet version for 4.10.x compat.
- Adds comments to warn for UTF8 incompatibility of the functions that may not be compatible with UTF8 with Ruby < 2.4.0.
Supported Release 4.15.0
Summary
This release introduces multiple new functions, a new fact and the addition of Ubuntu Xenial support. Also includes a bugfix and documentation update.
Features
- Addition of puppet_server fact to return agents server.
- Addition of a pry function.
- Addition of tests for ensure_resources.
- Addition of FQDN UUID generation function.
- Addition of Ubuntu Xenial to OS Support.
Bugfixes
- Ensure_packages now works with Ruby < 2.0.
- Updated the documentation of str2bool function.
Supported Release 4.14.0
Summary
Adds several new features and updates, especially around refining the deprecation and validate_legacy functions. Also includes a Gemfile update around an issue with parallel_tests dependancy for different versions of Ruby.
Features
- Deprecation function now uses puppet stacktrace if available.
- join_key_to_values function now handles array values. If values are arrays, multiple keys are added for each element.
- Updated Gemfile to deal with parallel_tests Ruby dependancy (MODULES-3983).
- Updated/Fixed ipv4 regex validator (MODULES-3980).
- Deprecation clarification added to README.
Bugfixes
- README typo fixes.
- Use .dup to duplicate classes for modification (MODULES-3829).
- Fixes spec failures that were caused by a change in the tested error message in validate_legacy_spec.
- Broken link to validate_legacy docs fixed.
- Updates deprecation tests to include future parser.
Supported Release 4.13.1
Summary
This bugfix release addresses the undefined method 'optional_repeated_param'
error messages seen by users of puppet 3.7.
It also improves the user experience around function deprecations by emitting one warning per function(-name) instead of only one deprecation overall. This allows users to identify all deprecated functions used in one agent run, with less back-and-forth.
Bugfixes
- Emit deprecations warnings for each function, instead of once per process. (MODULES-3961)
- Use a universally available API for the v4 deprecation stubs of
is_*
andvalidate_*
. (MODULES-3962) - Make
getvar()
compatible to ruby 1.8.7. (MODULES-3969) - Add v4 deprecation stubs for the
is_
counterparts of the deprecated functions to emit the deprecations warnings in all cases.
Supported Release 4.13.0
Summary
This version of stdlib deprecates a whole host of functions, and provides stepping stones to move to Puppet 4 type validations. Be sure to check out the new deprecation()
and validate_legacy()
functions to migrate off the deprecated v3-style data validations.
Many thanks to all community contributors: bob, Dmitry Ilyin, Dominic Cleal, Joris, Joseph Yaworski, Loic Antoine-Gombeaud, Maksym Melnychok, Michiel Brandenburg, Nate Potter, Romain Tartière, Stephen Benjamin, and Steve Moore, as well as anyone contributing in the code review process and by submitting issues.
Special thanks to Voxpupuli's Igor Galić for donating the puppet-tea types to kickstart this part of stdlib.
Deprecations
validate_absolute_path
,validate_array
,validate_bool
,validate_hash
,validate_integer
,validate_ip_address
,validate_ipv4_address
,validate_ipv6_address
,validate_numeric
,validate_re
,validate_slength
,validate_string
, and theiris_
counter parts are now deprecated on Puppet 4. See thevalidate_legacy()
description in the README for help on migrating away from those functions.- The
dig
function is provided by core puppet since 4.5.0 with slightly different calling convention. The stdlib version can still be accessed asdig44
for now.
Features
-
Add Puppet 4 data types for Unix, and Windows paths, and URLs.
-
Add
deprecation
function to warn users of functionality that will be removed soon. -
Add
validate_legacy
function to help with migrating to Puppet 4 data types. -
Add
any2bool
function, a combination of ofstring2bool
andnum2bool
. -
Add
delete_regex
function to delete array elements matching a regular expression. -
Add
puppet_environmentpath
fact to expose theenvironmentpath
setting. -
Add
regexpescape
function to safely insert arbitrary strings into regular expressions. -
Add
shell_escape
,shell_join
, andshell_split
functions for safer working with shell scripts.. -
The
delete
function now also accepts regular expressions as search term. -
The
loadyaml
function now accepts a default value, which is returned when there is an error loading the file.
Bugfixes
- Fix
file_line.match_for_absence
implementation and description to actually work. (MODULES-3590) - Fix
getparam
so that it can now also returnfalse
. (MODULES-3933) - Fix the fixture setup for testing and adjust
load_module_metadata
andloadjson
tests. - Fix
defined_with_params
to handleundef
correctly on all puppet versions. (PUP-6422, MODULES-3543) - Fix
file_line.path
validation to use puppet's built inabsolute_path?
matcher.
Minor Improvements
- README changes: improved descriptions of
deep_merge
,delete
,ensure_packages
,file_line.after
,range
, andvalidate_numeric
. - The
getvar
function now returns nil in all situations where the variable is not found. - Update the
dig44
function with betterundef
,nil
, andfalse
handling. - Better wording on
str2bool
argument validation error message.
Known issues
- The
validate_legacy
function relies on internal APIs from Puppet 4.4.0 (PE 2016.1) onwards, and doesn't work on earlier versions. - Puppet 4.5.0 (PE 2016.2) has a number of improvements around data types - especially error handling - that make working with them much nicer.
Supported Release 4.12.0
Summary
This release provides several new functions, bugfixes, modulesync changes, and some documentation updates.
Features
- Adds
clamp
. This function keeps values within a specified range. - Adds
validate_x509_rsa_key_pair
. This function validates an x509 RSA certificate and key pair. - Adds
dig
. This function performs a deep lookup in nested hashes or arrays. - Extends the
base64
support to fitrfc2045
andrfc4648
. - Adds
is_ipv6_address
andis_ipv4_address
. These functions validate the specified ipv4 or ipv6 addresses. - Adds
enclose_ipv6
. This function encloses IPv6 addresses in square brackets. - Adds
ensure_resources
. This function takes a list of resources and creates them if they do not exist. - Extends
suffix
to support applying a suffix to keys in a hash. - Apply modulesync changes.
- Add validate_email_address function.
Bugfixes
- Fixes
fqdn_rand_string
tests, since Puppet 4.4.0 and later have a higherfqdn_rand
ceiling. - (MODULES-3152) Adds a check to
package_provider
to prevent failures if Gem is not installed. - Fixes to README.md.
- Fixes catch StandardError rather than the gratuitous Exception
- Fixes file_line attribute validation.
- Fixes concat with Hash arguments.
Supported Release 4.11.0
Summary
Provides a validate_absolute_paths and Debian 8 support. There is a fix to the is_package_provider fact and a test improvement.
Features
- Adds new parser called is_absolute_path
- Supports Debian 8
Bugfixes
- Allow package_provider fact to resolve on PE 3.x
Improvements
- ensures that the test passes independently of changes to rubygems for ensure_resource
2015-12-15 - Supported Release 4.10.0
Summary
Includes the addition of several new functions and considerable improvements to the existing functions, tests and documentation. Includes some bug fixes which includes compatibility, test and fact issues.
Features
- Adds service_provider fact
- Adds is_a() function
- Adds package_provider fact
- Adds validate_ip_address function
- Adds seeded_rand function
Bugfixes
- Fix backwards compatibility from an improvement to the parseyaml function
- Renaming of load_module_metadata test to include _spec.rb
- Fix root_home fact on AIX 5.x, now '-c' rather than '-C'
- Fixed Gemfile to work with ruby 1.8.7
Improvements
- (MODULES-2462) Improvement of parseyaml function
- Improvement of str2bool function
- Improvement to readme
- Improvement of intersection function
- Improvement of validate_re function
- Improved speed on Facter resolution of service_provider
- empty function now handles numeric values
- Package_provider now prevents deprecation warning about the allow_virtual parameter
- load_module_metadata now succeeds on empty file
- Check added to ensure puppetversion value is not nil
- Improvement to bool2str to return a string of choice using boolean
- Improvement to naming convention in validate_ipv4_address function
Supported Release 4.9.1
Summary
Small release for support of newer PE versions. This increments the version of PE in the metadata.json file.
2015-09-08 - Supported Release 4.9.0
Summary
This release adds new features including the new functions dos2unix, unix2dos, try_get_value, convert_base as well as other features and improvements.
Features
- (MODULES-2370) allow
match
parameter to influenceensure => absent
behavior - (MODULES-2410) Add new functions dos2unix and unix2dos
- (MODULE-2456) Modify union to accept more than two arrays
- Adds a convert_base function, which can convert numbers between bases
- Add a new function "try_get_value"
Bugfixes
- n/a
Improvements
- (MODULES-2478) Support root_home fact on AIX through "lsuser" command
- Acceptance test improvements
- Unit test improvements
- Readme improvements
2015-08-10 - Supported Release 4.8.0
Summary
This release adds a function for reading metadata.json from any module, and expands file_line's abilities.
Features
- New parameter
replace
onfile_line
- New function
load_module_metadata()
to load metadata.json and return the content as a hash. - Added hash support to
size()
Bugfixes
- Fix various docs typos
- Fix
file_line
resource on puppet < 3.3
2015-06-22 - Supported Release 4.7.0
Summary
Adds Solaris 12 support along with improved Puppet 4 support. There are significant test improvements, and some minor fixes.
Features
- Add support for Solaris 12
Bugfixes
- Fix for AIO Puppet 4
- Fix time for ruby 1.8.7
- Specify rspec-puppet version
- range() fix for typeerror and missing functionality
- Fix pw_hash() on JRuby < 1.7.17
- fqdn_rand_string: fix argument error message
- catch and rescue from looking up non-existent facts
- Use puppet_install_helper, for Puppet 4
Improvements
- Enforce support for Puppet 4 testing
- fqdn_rotate/fqdn_rand_string acceptance tests and implementation
- Simplify mac address regex
- validate_integer, validate_numeric: explicitely reject hashes in arrays
- Readme edits
- Remove all the pops stuff for rspec-puppet
- Sync via modulesync
- Add validate_slength optional 3rd arg
- Move tests directory to examples directory
2015-04-14 - Supported Release 4.6.0
Summary
Adds functions and function argument abilities, and improves compatibility with the new puppet parser
Features
- MODULES-444:
concat()
can now take more than two arrays basename()
added to have Ruby File.basename functionalitydelete()
can now take an array of items to removeprefix()
can now take a hashupcase()
can now take a hash or array of upcaseable thingsvalidate_absolute_path()
can now take an arrayvalidate_cmd()
can now use % in the command to embed the validation file argument in the string- MODULES-1473: deprecate
type()
function in favor oftype3x()
- MODULES-1473: Add
type_of()
to give better type information on future parser - Deprecate
private()
forassert_private()
due to future parser - Adds
ceiling()
to take the ceiling of a number - Adds
fqdn_rand_string()
to generate random string based on fqdn - Adds
pw_hash()
to generate password hashes - Adds
validate_integer()
- Adds
validate_numeric()
(likevalidate_integer()
but also accepts floats)
Bugfixes
- Fix seeding of
fqdn_rotate()
ensure_resource()
is more verbose on debug mode- Stricter argument checking for
dirname()
- Fix
is_domain_name()
to better match RFC - Fix
uriescape()
when called with array - Fix
file_line
resource when using theafter
attribute withmatch
2015-01-14 - Supported Release 4.5.1
Summary
This release changes the temporary facter_dot_d cache locations outside of the /tmp directory due to a possible security vunerability. CVE-2015-1029
Bugfixes
- Facter_dot_d cache will now be stored in puppet libdir instead of tmp
2014-12-15 - Supported Release 4.5.0
Summary
This release improves functionality of the member function and adds improved future parser support.
Features
- MODULES-1329: Update member() to allow the variable to be an array.
- Sync .travis.yml, Gemfile, Rakefile, and CONTRIBUTING.md via modulesync
Bugfixes
- Fix range() to work with numeric ranges with the future parser
- Accurately express SLES support in metadata.json (was missing 10SP4 and 12)
- Don't require
line
to match thematch
parameter
2014-11-10 - Supported Release 4.4.0
Summary
This release has an overhauled readme, new private manifest function, and fixes many future parser bugs.
Features
- All new shiny README
- New
private()
function for making private manifests (yay!)
Bugfixes
- Code reuse in
bool2num()
andzip()
- Fix many functions to handle
generate()
no longer returning a string on new puppets concat()
no longer modifies the first argument (whoops)- strict variable support for
getvar()
,member()
,values_at
, andhas_interface_with()
to_bytes()
handles PB and EB now- Fix
tempfile
ruby requirement forvalidate_augeas()
andvalidate_cmd()
- Fix
validate_cmd()
for windows - Correct
validate_string()
docs to reflect non-handling ofundef
- Fix
file_line
matching on older rubies
2014-07-15 - Supported Release 4.3.2
Summary
This release merely updates metadata.json so the module can be uninstalled and upgraded via the puppet module command.
2014-07-14 - Supported Release 4.3.1
Summary
This supported release updates the metadata.json to work around upgrade behavior of the PMT.
Bugfixes
- Synchronize metadata.json with PMT-generated metadata to pass checksums
2014-06-27 - Supported Release 4.3.0
Summary
This release is the first supported release of the stdlib 4 series. It remains backwards-compatible with the stdlib 3 series. It adds two new functions, one bugfix, and many testing updates.
Features
- New
bool2str()
function - New
camelcase()
function
Bugfixes
- Fix
has_interface_with()
when interfaces fact is nil
2014-06-04 - Release 4.2.2
Summary
This release adds PE3.3 support in the metadata and fixes a few tests.
2014-05-08 - Release - 4.2.1
Summary
This release moves a stray symlink that can cause problems.
2014-05-08 - Release - 4.2.0
Summary
This release adds many new functions and fixes, and continues to be backwards compatible with stdlib 3.x
Features
- New
base64()
function - New
deep_merge()
function - New
delete_undef_values()
function - New
delete_values()
function - New
difference()
function - New
intersection()
function - New
is_bool()
function - New
pick_default()
function - New
union()
function - New
validate_ipv4_address
function - New
validate_ipv6_address
function - Update
ensure_packages()
to take an option hash as a second parameter. - Update
range()
to take an optional third argument for range step - Update
validate_slength()
to take an optional third argument for minimum length - Update
file_line
resource to takeafter
andmultiple
attributes
Bugfixes
- Correct
is_string
,is_domain_name
,is_array
,is_float
, andis_function_available
for parsing odd types such as bools and hashes. - Allow facts.d facts to contain
=
in the value - Fix
root_home
fact on darwin systems - Fix
concat()
to work with a second non-array argument - Fix
floor()
to work with integer strings - Fix
is_integer()
to return true if passed integer strings - Fix
is_numeric()
to return true if passed integer strings - Fix
merge()
to work with empty strings - Fix
pick()
to raise the correct error type - Fix
uriescape()
to use the default URI.escape list - Add/update unit & acceptance tests.
2014-03-04 - Supported Release - 3.2.1
Summary
This is a supported release
Bugfixes
- Fixed
is_integer
/is_float
/is_numeric
for checking the value of arithmatic expressions.
Known bugs
- No known bugs
2013-05-06 - Jeff McCune jeff@puppetlabs.com - 4.1.0
- (#20582) Restore facter_dot_d to stdlib for PE users (3b887c8)
- (maint) Update Gemfile with GEM_FACTER_VERSION (f44d535)
2013-05-06 - Alex Cline acline@us.ibm.com - 4.1.0
- Terser method of string to array conversion courtesy of ethooz. (d38bce0)
2013-05-06 - Alex Cline acline@us.ibm.com 4.1.0
- Refactor ensure_resource expectations (b33cc24)
2013-05-06 - Alex Cline acline@us.ibm.com 4.1.0
- Changed str-to-array conversion and removed abbreviation. (de253db)
2013-05-03 - Alex Cline acline@us.ibm.com 4.1.0
- (#20548) Allow an array of resource titles to be passed into the ensure_resource function (e08734a)
2013-05-02 - Raphaël Pinson raphael.pinson@camptocamp.com - 4.1.0
- Add a dirname function (2ba9e47)
2013-04-29 - Mark Smith-Guerrero msmithgu@gmail.com - 4.1.0
- (maint) Fix a small typo in hash() description (928036a)
2013-04-12 - Jeff McCune jeff@puppetlabs.com - 4.0.2
- Update user information in gemspec to make the intent of the Gem clear.
2013-04-11 - Jeff McCune jeff@puppetlabs.com - 4.0.1
- Fix README function documentation (ab3e30c)
2013-04-11 - Jeff McCune jeff@puppetlabs.com - 4.0.0
- stdlib 4.0 drops support with Puppet 2.7
- stdlib 4.0 preserves support with Puppet 3
2013-04-11 - Jeff McCune jeff@puppetlabs.com - 4.0.0
- Add ability to use puppet from git via bundler (9c5805f)
2013-04-10 - Jeff McCune jeff@puppetlabs.com - 4.0.0
- (maint) Make stdlib usable as a Ruby GEM (e81a45e)
2013-04-10 - Erik Dalén dalen@spotify.com - 4.0.0
- Add a count function (f28550e)
2013-03-31 - Amos Shapira ashapira@atlassian.com - 4.0.0
- (#19998) Implement any2array (7a2fb80)
2013-03-29 - Steve Huff shuff@vecna.org - 4.0.0
- (19864) num2bool match fix (8d217f0)
2013-03-20 - Erik Dalén dalen@spotify.com - 4.0.0
- Allow comparisons of Numeric and number as String (ff5dd5d)
2013-03-26 - Richard Soderberg rsoderberg@mozilla.com - 4.0.0
- add suffix function to accompany the prefix function (88a93ac)
2013-03-19 - Kristof Willaert kristof.willaert@gmail.com - 4.0.0
- Add floor function implementation and unit tests (0527341)
2012-04-03 - Eric Shamow eric@puppetlabs.com - 4.0.0
- (#13610) Add is_function_available to stdlib (961dcab)
2012-12-17 - Justin Lambert jlambert@eml.cc - 4.0.0
- str2bool should return a boolean if called with a boolean (5d5a4d4)
2012-10-23 - Uwe Stuehler ustuehler@team.mobile.de - 4.0.0
- Fix number of arguments check in flatten() (e80207b)
2013-03-11 - Jeff McCune jeff@puppetlabs.com - 4.0.0
- Add contributing document (96e19d0)
2013-03-04 - Raphaël Pinson raphael.pinson@camptocamp.com - 4.0.0
- Add missing documentation for validate_augeas and validate_cmd to README.markdown (a1510a1)
2013-02-14 - Joshua Hoblitt jhoblitt@cpan.org - 4.0.0
- (#19272) Add has_element() function (95cf3fe)
2013-02-07 - Raphaël Pinson raphael.pinson@camptocamp.com - 4.0.0
- validate_cmd(): Use Puppet::Util::Execution.execute when available (69248df)
2012-12-06 - Raphaël Pinson raphink@gmail.com - 4.0.0
- Add validate_augeas function (3a97c23)
2012-12-06 - Raphaël Pinson raphink@gmail.com - 4.0.0
- Add validate_cmd function (6902cc5)
2013-01-14 - David Schmitt david@dasz.at - 4.0.0
- Add geppetto project definition (b3fc0a3)
2013-01-02 - Jaka Hudoklin jakahudoklin@gmail.com - 4.0.0
- Add getparam function to get defined resource parameters (20e0e07)
2013-01-05 - Jeff McCune jeff@puppetlabs.com - 4.0.0
- (maint) Add Travis CI Support (d082046)
2012-12-04 - Jeff McCune jeff@puppetlabs.com - 4.0.0
- Clarify that stdlib 3 supports Puppet 3 (3a6085f)
2012-11-30 - Erik Dalén dalen@spotify.com - 4.0.0
- maint: style guideline fixes (7742e5f)
2012-11-09 - James Fryman james@frymanet.com - 4.0.0
- puppet-lint cleanup (88acc52)
2012-11-06 - Joe Julian me@joejulian.name - 4.0.0
- Add function, uriescape, to URI.escape strings. Redmine #17459 (fd52b8d)
2012-09-18 - Chad Metcalf chad@wibidata.com - 3.2.0
- Add an ensure_packages function. (8a8c09e)
2012-11-23 - Erik Dalén dalen@spotify.com - 3.2.0
- (#17797) min() and max() functions (9954133)
2012-05-23 - Peter Meier peter.meier@immerda.ch - 3.2.0
- (#14670) autorequire a file_line resource's path (dfcee63)
2012-11-19 - Joshua Harlan Lifton lifton@puppetlabs.com - 3.2.0
- Add join_keys_to_values function (ee0f2b3)
2012-11-17 - Joshua Harlan Lifton lifton@puppetlabs.com - 3.2.0
- Extend delete function for strings and hashes (7322e4d)
2012-08-03 - Gary Larizza gary@puppetlabs.com - 3.2.0
- Add the pick() function (ba6dd13)
2012-03-20 - Wil Cooley wcooley@pdx.edu - 3.2.0
- (#13974) Add predicate functions for interface facts (f819417)
2012-11-06 - Joe Julian me@joejulian.name - 3.2.0
- Add function, uriescape, to URI.escape strings. Redmine #17459 (70f4a0e)
2012-10-25 - Jeff McCune jeff@puppetlabs.com - 3.1.1
- (maint) Fix spec failures resulting from Facter API changes (97f836f)
2012-10-23 - Matthaus Owens matthaus@puppetlabs.com - 3.1.0
- Add PE facts to stdlib (cdf3b05)
2012-08-16 - Jeff McCune jeff@puppetlabs.com - 3.0.1
- Fix accidental removal of facts_dot_d.rb in 3.0.0 release
2012-08-16 - Jeff McCune jeff@puppetlabs.com - 3.0.0
- stdlib 3.0 drops support with Puppet 2.6
- stdlib 3.0 preserves support with Puppet 2.7
2012-08-07 - Dan Bode dan@puppetlabs.com - 3.0.0
- Add function ensure_resource and defined_with_params (ba789de)
2012-07-10 - Hailee Kenney hailee@puppetlabs.com - 3.0.0
- (#2157) Remove facter_dot_d for compatibility with external facts (f92574f)
2012-04-10 - Chris Price chris@puppetlabs.com - 3.0.0
- (#13693) moving logic from local spec_helper to puppetlabs_spec_helper (85f96df)
2012-10-25 - Jeff McCune jeff@puppetlabs.com - 2.5.1
- (maint) Fix spec failures resulting from Facter API changes (97f836f)
2012-10-23 - Matthaus Owens matthaus@puppetlabs.com - 2.5.0
- Add PE facts to stdlib (cdf3b05)
2012-08-15 - Dan Bode dan@puppetlabs.com - 2.5.0
- Explicitly load functions used by ensure_resource (9fc3063)
2012-08-13 - Dan Bode dan@puppetlabs.com - 2.5.0
- Add better docs about duplicate resource failures (97d327a)
2012-08-13 - Dan Bode dan@puppetlabs.com - 2.5.0
- Handle undef for parameter argument (4f8b133)
2012-08-07 - Dan Bode dan@puppetlabs.com - 2.5.0
- Add function ensure_resource and defined_with_params (a0cb8cd)
2012-08-20 - Jeff McCune jeff@puppetlabs.com - 2.5.0
- Disable tests that fail on 2.6.x due to #15912 (c81496e)
2012-08-20 - Jeff McCune jeff@puppetlabs.com - 2.5.0
- (Maint) Fix mis-use of rvalue functions as statements (4492913)
2012-08-20 - Jeff McCune jeff@puppetlabs.com - 2.5.0
- Add .rspec file to repo root (88789e8)
2012-06-07 - Chris Price chris@puppetlabs.com - 2.4.0
- Add support for a 'match' parameter to file_line (a06c0d8)
2012-08-07 - Erik Dalén dalen@spotify.com - 2.4.0
- (#15872) Add to_bytes function (247b69c)
2012-07-19 - Jeff McCune jeff@puppetlabs.com - 2.4.0
- (Maint) use PuppetlabsSpec::PuppetInternals.scope (main) (deafe88)
2012-07-10 - Hailee Kenney hailee@puppetlabs.com - 2.4.0
- (#2157) Make facts_dot_d compatible with external facts (5fb0ddc)
2012-03-16 - Steve Traylen steve.traylen@cern.ch - 2.4.0
- (#13205) Rotate array/string randomley based on fqdn, fqdn_rotate() (fef247b)
2012-05-22 - Peter Meier peter.meier@immerda.ch - 2.3.3
- fix regression in #11017 properly (f0a62c7)
2012-05-10 - Jeff McCune jeff@puppetlabs.com - 2.3.3
- Fix spec tests using the new spec_helper (7d34333)
2012-05-10 - Puppet Labs support@puppetlabs.com - 2.3.2
- Make file_line default to ensure => present (1373e70)
- Memoize file_line spec instance variables (20aacc5)
- Fix spec tests using the new spec_helper (1ebfa5d)
- (#13595) initialize_everything_for_tests couples modules Puppet ver (3222f35)
- (#13439) Fix MRI 1.9 issue with spec_helper (15c5fd1)
- (#13439) Fix test failures with Puppet 2.6.x (665610b)
- (#13439) refactor spec helper for compatibility with both puppet 2.7 and server (82194ca)
- (#13494) Specify the behavior of zero padded strings (61891bb)
2012-03-29 Puppet Labs support@puppetlabs.com - 2.1.3
- (#11607) Add Rakefile to enable spec testing
- (#12377) Avoid infinite loop when retrying require json
2012-03-13 Puppet Labs support@puppetlabs.com - 2.3.1
- (#13091) Fix LoadError bug with puppet apply and puppet_vardir fact
2012-03-12 Puppet Labs support@puppetlabs.com - 2.3.0
- Add a large number of new Puppet functions
- Backwards compatibility preserved with 2.2.x
2011-12-30 Puppet Labs support@puppetlabs.com - 2.2.1
- Documentation only release for the Forge
2011-12-30 Puppet Labs support@puppetlabs.com - 2.1.2
- Documentation only release for PE 2.0.x
2011-11-08 Puppet Labs support@puppetlabs.com - 2.2.0
- #10285 - Refactor json to use pson instead.
- Maint - Add watchr autotest script
- Maint - Make rspec tests work with Puppet 2.6.4
- #9859 - Add root_home fact and tests
2011-08-18 Puppet Labs support@puppetlabs.com - 2.1.1
- Change facts.d paths to match Facter 2.0 paths.
- /etc/facter/facts.d
- /etc/puppetlabs/facter/facts.d
2011-08-17 Puppet Labs support@puppetlabs.com - 2.1.0
- Add R.I. Pienaar's facts.d custom facter fact
- facts defined in /etc/facts.d and /etc/puppetlabs/facts.d are automatically loaded now.
2011-08-04 Puppet Labs support@puppetlabs.com - 2.0.0
- Rename whole_line to file_line
- This is an API change and as such motivating a 2.0.0 release according to semver.org.
2011-08-04 Puppet Labs support@puppetlabs.com - 1.1.0
- Rename append_line to whole_line
- This is an API change and as such motivating a 1.1.0 release.
2011-08-04 Puppet Labs support@puppetlabs.com - 1.0.0
- Initial stable release
- Add validate_array and validate_string functions
- Make merge() function work with Ruby 1.8.5
- Add hash merging function
- Add has_key function
- Add loadyaml() function
- Add append_line native
2011-06-21 Jeff McCune jeff@puppetlabs.com - 0.1.7
- Add validate_hash() and getvar() functions
2011-06-15 Jeff McCune jeff@puppetlabs.com - 0.1.6
- Add anchor resource type to provide containment for composite classes
2011-06-03 Jeff McCune jeff@puppetlabs.com - 0.1.5
- Add validate_bool() function to stdlib
0.1.4 2011-05-26 Jeff McCune jeff@puppetlabs.com
- Move most stages after main
0.1.3 2011-05-25 Jeff McCune jeff@puppetlabs.com
- Add validate_re() function
0.1.2 2011-05-24 Jeff McCune jeff@puppetlabs.com
- Update to add annotated tag
0.1.1 2011-05-24 Jeff McCune jeff@puppetlabs.com
- Add stdlib::stages class with a standard set of stages
* This Changelog was automatically generated by github_changelog_generator
Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: (a) You must give any other recipients of the Work or Derivative Works a copy of this License; and (b) You must cause any modified files to carry prominent notices stating that You changed the files; and (c) You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and (d) If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work. To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "[]" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright [yyyy] [name of copyright owner] Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.
Quality checks
We run a couple of automated scans to help you assess a module’s quality. Each module is given a score based on how well the author has formatted their code and documentation and select modules are also checked for malware using VirusTotal.
Please note, the information below is for guidance only and neither of these methods should be considered an endorsement by Puppet.
Malware scan results
The malware detection service on Puppet Forge is an automated process that identifies known malware in module releases before they’re published. It is not intended to replace your own virus scanning solution.
Learn more about malware scans- Module name:
- puppetlabs-stdlib
- Module version:
- 8.6.0
- Scan initiated:
- April 24th 2023, 9:04:29
- Detections:
- 0 / 59
- Scan stats:
- 59 undetected
- 0 harmless
- 0 failures
- 0 timeouts
- 0 malicious
- 0 suspicious
- 15 unsupported
- Scan report:
- View the detailed scan report