From f3ecae8cc6e6abab4a5080e570a646b25b3310db Mon Sep 17 00:00:00 2001 From: Ciaran McCrisken Date: Mon, 1 Feb 2021 15:15:26 +0000 Subject: [PATCH] Release version v6.6.0 --- CHANGELOG.md | 17 + REFERENCE.md | 1130 +++++++++++++++++++++++++++++++------------------ metadata.json | 2 +- 3 files changed, 730 insertions(+), 419 deletions(-) diff --git a/CHANGELOG.md b/CHANGELOG.md index 0c3777ec1..6583c7c3a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,6 +2,23 @@ All notable changes to this project will be documented in this file. The format is based on [Keep a Changelog](http://keepachangelog.com/en/1.0.0/) and this project adheres to [Semantic Versioning](http://semver.org). +## [v6.6.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.6.0) (2021-02-01) + +[Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.5.0...v6.6.0) + +### Added + +- stdlib::ensure: new fuction to cast ensure values [\#1150](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1150) ([b4ldr](https://github.com/b4ldr)) +- \(feat\) Add support for Puppet 7 [\#1144](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1144) ([daianamezdrea](https://github.com/daianamezdrea)) +- Allow options injection for to\_yaml [\#1137](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1137) ([baurmatt](https://github.com/baurmatt)) +- Allow start/end checks on empty strings [\#1135](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1135) ([jvrsantacruz](https://github.com/jvrsantacruz)) +- Stdlib::HttpStatus: add type for HTTP status codes as per rfc2616 [\#1132](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1132) ([b4ldr](https://github.com/b4ldr)) + +### Fixed + +- \(IAC-1375\) fix unit tests for pe\_version fact, when using later facte… [\#1155](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1155) ([tphoney](https://github.com/tphoney)) +- seeded\_rand: update funtion to ensure it returns an int not String [\#1139](https://github.com/puppetlabs/puppetlabs-stdlib/pull/1139) ([b4ldr](https://github.com/b4ldr)) + ## [v6.5.0](https://github.com/puppetlabs/puppetlabs-stdlib/tree/v6.5.0) (2020-09-30) [Full Changelog](https://github.com/puppetlabs/puppetlabs-stdlib/compare/v6.4.0...v6.5.0) diff --git a/REFERENCE.md b/REFERENCE.md index 1ede5d97c..a49b04779 100644 --- a/REFERENCE.md +++ b/REFERENCE.md @@ -87,23 +87,23 @@ the provided regular expression. * [`intersection`](#intersection): This function returns an array of the intersection of two. * [`is_a`](#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`](#is_absolute_path): Wrapper that calls the Puppet 3.x function of the same name. * [`is_absolute_path`](#is_absolute_path): **Deprecated:** Returns boolean true if the string represents an absolute path in the filesystem. -* [`is_array`](#is_array): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_absolute_path`](#is_absolute_path): Wrapper that calls the Puppet 3.x function of the same name. * [`is_array`](#is_array): **Deprecated:** Returns true if the variable passed to this function is an array. -* [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_array`](#is_array): Wrapper that calls the Puppet 3.x function of the same name. * [`is_bool`](#is_bool): **Deprecated:** Returns true if the variable passed to this function is a boolean. +* [`is_bool`](#is_bool): Wrapper that calls the Puppet 3.x function of the same name. * [`is_domain_name`](#is_domain_name): **Deprecated:** Returns true if the string passed to this function is a syntactically correct domain name. * [`is_email_address`](#is_email_address): **Deprecated:** Returns true if the string passed to this function is a valid email address. -* [`is_float`](#is_float): **Deprecated:** Returns true if the variable passed to this function is a float. * [`is_float`](#is_float): Wrapper that calls the Puppet 3.x function of the same name. +* [`is_float`](#is_float): **Deprecated:** Returns true if the variable passed to this function is a float. * [`is_function_available`](#is_function_available): **Deprecated:** Determines whether the Puppet runtime has access to a function by that name. * [`is_hash`](#is_hash): **Deprecated:** Returns true if the variable passed to this function is a hash. * [`is_integer`](#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`](#is_ip_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ip_address`](#is_ip_address): **Deprecated:** Returns true if the string passed to this function is a valid IP address. +* [`is_ip_address`](#is_ip_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv4_address`](#is_ipv4_address): Wrapper that calls the Puppet 3.x function of the same name. * [`is_ipv4_address`](#is_ipv4_address): **Deprecated:** Returns true if the string passed to this function is a valid IPv4 address. * [`is_ipv6_address`](#is_ipv6_address): Wrapper that calls the Puppet 3.x function of the same name. @@ -168,6 +168,7 @@ the provided regular expression. * [`sprintf_hash`](#sprintf_hash): Uses sprintf with named references. * [`squeeze`](#squeeze): Returns a new string where runs of the same character that occur in this set are replaced by a single character. * [`stdlib::end_with`](#stdlibend_with): Returns true if str ends with one of the prefixes given. Each of the prefixes should be a String. +* [`stdlib::ensure`](#stdlibensure): function to cast ensure parameter to resource specific value * [`stdlib::extname`](#stdlibextname): Returns the Extension (the Portion of Filename in Path starting from the last Period). * [`stdlib::ip_in_range`](#stdlibip_in_range): Returns true if the ipaddress is within the given CIDRs @@ -220,9 +221,9 @@ compilation if any value fails this check. regardless they are IPv4 or IPv6 Fail compilation if any value fails this check. * [`validate_ip_address`](#validate_ip_address): Validate the passed value represents an ip_address. -* [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. * [`validate_ipv4_address`](#validate_ipv4_address): Validate that all values passed are valid IPv4 addresses. Fail compilation if any value fails this check. +* [`validate_ipv4_address`](#validate_ipv4_address): Validate the passed value represents an ipv4_address. * [`validate_ipv6_address`](#validate_ipv6_address): Validate that all values passed are valid IPv6 addresses. Fail compilation if any value fails this check. * [`validate_ipv6_address`](#validate_ipv6_address): Validate the passed value represents an ipv6_address. @@ -233,12 +234,12 @@ Fail compilation if any value fails this check. expressions. * [`validate_re`](#validate_re): Perform validation of a string against one or more regular expressions. +* [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value * [`validate_slength`](#validate_slength): Validate that the first argument is a string (or an array of strings), and less/equal to than the length of the second argument. An optional third parameter can be given the minimum length. It fails if the first argument is not a string or array of strings, and if arg 2 and arg 3 are not convertable to a number. -* [`validate_slength`](#validate_slength): Validate that a passed string has length less/equal with the passed value -* [`validate_string`](#validate_string): Validate that all passed values are string data structures * [`validate_string`](#validate_string): Validate that all passed values are string data structures. +* [`validate_string`](#validate_string): Validate that all passed values are string data structures * [`validate_x509_rsa_key_pair`](#validate_x509_rsa_key_pair): Validates a PEM-formatted X.509 certificate and RSA private key using OpenSSL. Verifies that the certficate's signature was created from the supplied key. @@ -274,6 +275,7 @@ supplied key. * [`Stdlib::HTTPSUrl`](#stdlibhttpsurl) * [`Stdlib::HTTPUrl`](#stdlibhttpurl) * [`Stdlib::Host`](#stdlibhost) +* [`Stdlib::HttpStatus`](#stdlibhttpstatus) * [`Stdlib::IP::Address`](#stdlibipaddress) * [`Stdlib::IP::Address::Nosubnet`](#stdlibipaddressnosubnet) * [`Stdlib::IP::Address::V4`](#stdlibipaddressv4) @@ -306,7 +308,7 @@ supplied key. ## Classes -### `stdlib` +### `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. @@ -314,7 +316,7 @@ declared in order to use the standardized run stages. Declares all other classes in the stdlib module. Currently, this consists of stdlib::stages. -### `stdlib::stages` +### `stdlib::stages` Declares various run-stages for deploying infrastructure, language runtimes, and application layers. @@ -342,7 +344,7 @@ node default { ## Resource types -### `anchor` +### `anchor` 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 @@ -382,13 +384,15 @@ class { 'mcollective': } -> class { 'ntp': } The following parameters are available in the `anchor` type. -##### `name` +* [`name`](#name) + +##### `name` namevar The name of the anchor resource. -### `file_line` +### `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 @@ -504,12 +508,24 @@ The line to be appended to the file or used to replace matches found by the matc The following parameters are available in the `file_line` type. -##### `after` +* [`after`](#after) +* [`append_on_no_match`](#append_on_no_match) +* [`encoding`](#encoding) +* [`match`](#match) +* [`match_for_absence`](#match_for_absence) +* [`multiple`](#multiple) +* [`name`](#name) +* [`path`](#path) +* [`provider`](#provider) +* [`replace`](#replace) +* [`replace_all_matches_not_matching_line`](#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` +##### `append_on_no_match` Valid values: ``true``, ``false`` @@ -517,20 +533,20 @@ If true, append line if match is not found. If false, do not append line if a ma Default value: ``true`` -##### `encoding` +##### `encoding` For files that are not UTF-8 encoded, specify encoding such as iso-8859-1 Default value: `UTF-8` -##### `match` +##### `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` +##### `match_for_absence` Valid values: ``true``, ``false`` @@ -541,29 +557,29 @@ When `ensure => present`, match_for_absence is ignored. Default value: ``false`` -##### `multiple` +##### `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` +##### `name` namevar An arbitrary name used as the identity of the resource. -##### `path` +##### `path` The file Puppet will ensure contains the line specified by the line parameter. -##### `provider` +##### `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` +##### `replace` Valid values: ``true``, ``false`` @@ -571,7 +587,7 @@ If true, replace line that matches. If false, do not write line if a match is fo Default value: ``true`` -##### `replace_all_matches_not_matching_line` +##### `replace_all_matches_not_matching_line` Valid values: ``true``, ``false`` @@ -582,7 +598,7 @@ Default value: ``false`` ## Functions -### `abs` +### `abs` Type: Ruby 3.x API @@ -604,7 +620,7 @@ Takes a single integer or float value as an argument. Returns: `Any` The absolute value of the given number if it was an Integer -### `any2array` +### `any2array` Type: Ruby 3.x API @@ -662,7 +678,7 @@ transformed into an array. Returns: `Array` The new array containing the given object -### `any2bool` +### `any2bool` Type: Ruby 3.x API @@ -692,7 +708,7 @@ function. Returns: `Boolean` The boolean value of the object that was given -### `assert_private` +### `assert_private` Type: Ruby 3.x API @@ -704,7 +720,7 @@ Calling the class or definition from outside the current module will fail. Returns: `Any` set the current class or definition as private. -### `base64` +### `base64` Type: Ruby 3.x API @@ -774,7 +790,7 @@ Decode a Binary assuming it is an UTF-8 String $decodestring = String(Binary("dGhlc3RyaW5n"), "%s") ``` -### `basename` +### `basename` Type: Ruby 3.x API @@ -786,7 +802,7 @@ The basename function. Returns: `String` The stripped filename -### `bool2num` +### `bool2num` Type: Ruby 3.x API @@ -832,7 +848,7 @@ Requires a single boolean or string as an input. Returns: `Integer` The converted value as a number -### `bool2str` +### `bool2str` Type: Ruby 3.x API @@ -894,7 +910,7 @@ Requires a single boolean as an input. Returns: `Any` The converted value to string of the given Boolean -### `camelcase` +### `camelcase` Type: Ruby 3.x API @@ -912,7 +928,7 @@ Type: Ruby 3.x API Returns: `String` The converted String, if it was a String that was given -### `capitalize` +### `capitalize` Type: Ruby 3.x API @@ -934,7 +950,7 @@ Requires either a single string or an array as an input. Returns: `String` The converted String, if it was a String that was given -### `ceiling` +### `ceiling` Type: Ruby 3.x API @@ -954,7 +970,7 @@ Takes a single numeric value as an argument. Returns: `Integer` The rounded value -### `chomp` +### `chomp` Type: Ruby 3.x API @@ -976,7 +992,7 @@ built-in [`chomp`](https://puppet.com/docs/puppet/latest/function.html#chomp) fu Returns: `String` The converted String, if it was a String that was given -### `chop` +### `chop` Type: Ruby 3.x API @@ -1000,7 +1016,7 @@ built-in [`chop`](https://puppet.com/docs/puppet/latest/function.html#chop) func Returns: `String` The given String, sans the last character. -### `clamp` +### `clamp` Type: Ruby 3.x API @@ -1044,7 +1060,7 @@ clamp(16, 88, 661)` returns 88. clamp([4, 3, '99'])` returns 4. ``` -### `concat` +### `concat` Type: Ruby 3.x API @@ -1088,7 +1104,7 @@ 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` +### `convert_base` Type: Ruby 3.x API @@ -1140,7 +1156,7 @@ Returns: `Any` converted value as a string ``` -### `count` +### `count` Type: Ruby 3.x API @@ -1180,7 +1196,7 @@ Would notice the value 2. Returns: `Integer` The amount of elements counted within the array -### `deep_merge` +### `deep_merge` Type: Ruby 3.x API @@ -1228,7 +1244,7 @@ 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` +### `defined_with_params` Type: Ruby 3.x API @@ -1262,7 +1278,7 @@ to the catalog, and `false` otherwise. Returns: `Boolean` returns `true` or `false` -### `delete` +### `delete` Type: Ruby 3.x API @@ -1348,7 +1364,7 @@ Would return: {'a' => '1'} Would return: 'acada' ``` -### `delete_at` +### `delete_at` Type: Ruby 3.x API @@ -1394,7 +1410,7 @@ Or if a delete is wanted from the beginning or end of the array, by using the sl Returns: `Array` The given array, now missing the tar -### `delete_regex` +### `delete_regex` Type: Ruby 3.x API @@ -1456,7 +1472,7 @@ delete_regex({'a'=>1,'b'=>2,'c'=>3}, '^a$') Would return: {'b'=>2,'c'=>3} ``` -### `delete_undef_values` +### `delete_undef_values` Type: Ruby 3.x API @@ -1504,7 +1520,7 @@ $array = delete_undef_values(['A','',undef,false]) Would return: ['A','',false] ``` -### `delete_values` +### `delete_values` Type: Ruby 3.x API @@ -1544,7 +1560,7 @@ delete_values({'a'=>'A','b'=>'B','c'=>'C','B'=>'D'}, 'B') Would return: {'a'=>'A','c'=>'C','B'=>'D'} ``` -### `deprecation` +### `deprecation` Type: Ruby 4.x API @@ -1582,7 +1598,7 @@ Data type: `String` -### `deprecation` +### `deprecation` Type: Ruby 3.x API @@ -1596,7 +1612,7 @@ information that is formatted by the user/caller of the method.). Returns: `String` return deprecation warnings -### `difference` +### `difference` Type: Ruby 3.x API @@ -1640,7 +1656,7 @@ difference(["a","b","c"],["b","c","d"]) Would return: `["a"]` ``` -### `dig` +### `dig` Type: Ruby 3.x API @@ -1721,7 +1737,7 @@ has occurred. 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` +### `dig44` Type: Ruby 3.x API @@ -1789,7 +1805,7 @@ $value = dig44($data, ['a', 'b', 'c', 'd'], 'not_found') Returns: `String` 'not_found' will be returned if nothing is found -### `dirname` +### `dirname` Type: Ruby 3.x API @@ -1801,7 +1817,7 @@ The dirname function. Returns: `String` the given path's dirname -### `dos2unix` +### `dos2unix` Type: Ruby 3.x API @@ -1813,7 +1829,7 @@ Takes a single string argument. Returns: `Any` The retrieved version -### `downcase` +### `downcase` Type: Ruby 3.x API @@ -1833,7 +1849,7 @@ 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` +### `empty` Type: Ruby 3.x API @@ -1848,7 +1864,7 @@ Type: Ruby 3.x API 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` +### `enclose_ipv6` Type: Ruby 3.x API @@ -1860,7 +1876,7 @@ The enclose_ipv6 function. Returns: `Any` encloses the ipv6 addresses with square brackets. -### `ensure_packages` +### `ensure_packages` Type: Ruby 3.x API @@ -1874,7 +1890,7 @@ third argument to the ensure_resource() function. Returns: `Any` install the passed packages -### `ensure_resource` +### `ensure_resource` Type: Ruby 3.x API @@ -1930,7 +1946,7 @@ the type and parameters specified if it doesn't already exist. ensure_resource('user', ['dan','alex'], {'ensure' => 'present'}) ``` -### `ensure_resources` +### `ensure_resources` Type: Ruby 3.x API @@ -1996,7 +2012,7 @@ user { 'dan': } ``` -### `fact` +### `fact` Type: Ruby 4.x API @@ -2058,7 +2074,7 @@ Data type: `String` The name of the fact to check -### `flatten` +### `flatten` Type: Ruby 3.x API @@ -2090,7 +2106,7 @@ Returns: `Any` convert nested arrays into a single flat array flatten(['a', ['b', ['c']]])` returns: `['a','b','c'] ``` -### `floor` +### `floor` Type: Ruby 3.x API @@ -2108,7 +2124,7 @@ a built-in [`floor`](https://puppet.com/docs/puppet/latest/function.html#floor) Returns: `Any` the largest integer less or equal to the argument. -### `fqdn_rand_string` +### `fqdn_rand_string` Type: Ruby 3.x API @@ -2150,7 +2166,7 @@ fqdn_rand_string(10, 'ABCDEF!@$%^') fqdn_rand_string(10, '', 'custom seed') ``` -### `fqdn_rotate` +### `fqdn_rotate` Type: Ruby 3.x API @@ -2183,7 +2199,7 @@ fqdn_rotate('abcd') fqdn_rotate([1, 2, 3], 'custom seed') ``` -### `fqdn_uuid` +### `fqdn_uuid` Type: Ruby 3.x API @@ -2214,7 +2230,7 @@ fqdn_uuid('puppetlabs.com') # Returns '9c70320f-6815-5fc5-ab0f-debe68bf764c' fqdn_uuid('google.com') # Returns '64ee70a4-8cc1-5d25-abf2-dea6c79a09 ``` -### `get_module_path` +### `get_module_path` Type: Ruby 3.x API @@ -2251,7 +2267,7 @@ environment. $module_path = get_module_path('stdlib') ``` -### `getparam` +### `getparam` Type: Ruby 3.x API @@ -2333,7 +2349,7 @@ define example_get_param { example_get_param { 'show_notify': } ``` -### `getvar` +### `getvar` Type: Ruby 3.x API @@ -2381,7 +2397,7 @@ $datalocation = 'site::data' $bar = getvar("${datalocation}::bar") # Equivalent to $bar = $site::data::bar ``` -### `glob` +### `glob` Type: Ruby 3.x API @@ -2409,7 +2425,7 @@ Returns: `Any` Returns an Array of file entries of a directory or an Array of di $confs = glob(['/etc/**/*.conf', '/opt/**/*.conf']) ``` -### `grep` +### `grep` Type: Ruby 3.x API @@ -2443,7 +2459,7 @@ Returns: `Any` array of elements that match the provided regular expression. grep(['aaa','bbb','ccc','aaaddd'], 'aaa') # Returns ['aaa','aaaddd'] ``` -### `has_interface_with` +### `has_interface_with` Type: Ruby 3.x API @@ -2485,7 +2501,7 @@ has_interface_with("ipaddress", "127.0.0.1") # Returns `true` has_interface_with("lo") # Returns `true` ``` -### `has_ip_address` +### `has_ip_address` Type: Ruby 3.x API @@ -2499,7 +2515,7 @@ This function iterates through the 'interfaces' fact and checks the Returns: `Boolean` `true` or `false` -### `has_ip_network` +### `has_ip_network` Type: Ruby 3.x API @@ -2513,7 +2529,7 @@ This function iterates through the 'interfaces' fact and checks the Returns: `Any` Boolean value, `true` if the client has an IP address within the requested network. -### `has_key` +### `has_key` Type: Ruby 3.x API @@ -2563,7 +2579,7 @@ if has_key($my_hash, 'key_one') { } ``` -### `hash` +### `hash` Type: Ruby 3.x API @@ -2605,7 +2621,7 @@ Returns: `Any` the converted array as a hash hash(['a',1,'b',2,'c',3]) # Returns: {'a'=>1,'b'=>2,'c'=>3} ``` -### `intersection` +### `intersection` Type: Ruby 3.x API @@ -2635,7 +2651,7 @@ 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` +### `is_a` Type: Ruby 4.x API @@ -2703,31 +2719,7 @@ 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` +### `is_absolute_path` Type: Ruby 3.x API @@ -2795,15 +2787,15 @@ $undefined = undef is_absolute_path($undefined) ``` -### `is_array` +### `is_absolute_path` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. -#### `is_array(Any $scope, Any *$args)` +#### `is_absolute_path(Any $scope, Any *$args)` -The is_array function. +The is_absolute_path function. Returns: `Boolea` A boolean value returned from the called 3.x function. @@ -2819,7 +2811,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_array` +### `is_array` Type: Ruby 3.x API @@ -2833,15 +2825,15 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_bool` +### `is_array` Type: Ruby 4.x API Wrapper that calls the Puppet 3.x function of the same name. -#### `is_bool(Any $scope, Any *$args)` +#### `is_array(Any $scope, Any *$args)` -The is_bool function. +The is_array function. Returns: `Boolea` A boolean value returned from the called 3.x function. @@ -2857,7 +2849,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_bool` +### `is_bool` Type: Ruby 3.x API @@ -2871,49 +2863,59 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_domain_name` +### `is_bool` -Type: Ruby 3.x API +Type: Ruby 4.x API -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +Wrapper that calls the Puppet 3.x function of the same name. -#### `is_domain_name()` +#### `is_bool(Any $scope, Any *$args)` -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). +The is_bool function. -Returns: `Boolean` Returns `true` or `false` +Returns: `Boolea` A boolean value returned from the called 3.x function. + +##### `scope` -### `is_email_address` +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_domain_name` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). -#### `is_email_address()` +#### `is_domain_name()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` -### `is_float` +### `is_email_address` Type: Ruby 3.x API > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). -#### `is_float()` +#### `is_email_address()` > **Note:* **Deprecated** Will be removed in a future version of stdlib. See [`validate_legacy`](#validate_legacy). Returns: `Boolean` Returns `true` or `false` -### `is_float` +### `is_float` Type: Ruby 4.x API @@ -2937,7 +2939,21 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_function_available` +### `is_float` + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_float()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### `is_function_available` Type: Ruby 3.x API @@ -2955,7 +2971,7 @@ This function accepts a string as an argument. Returns: `Boolean` Returns `true` or `false` -### `is_hash` +### `is_hash` Type: Ruby 3.x API @@ -2969,7 +2985,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_integer` +### `is_integer` Type: Ruby 3.x API @@ -2993,7 +3009,21 @@ If given any other argument `false` is returned. Returns: `Boolean` Returns `true` or `false` -### `is_ip_address` +### `is_ip_address` + +Type: Ruby 3.x API + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +#### `is_ip_address()` + +> **Note:* **Deprecated** Will be removed in a future version of stdlib. See +[`validate_legacy`](#validate_legacy). + +Returns: `Boolean` Returns `true` or `false` + +### `is_ip_address` Type: Ruby 4.x API @@ -3017,21 +3047,7 @@ 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`](#validate_legacy). - -#### `is_ip_address()` - -> **Note:* **Deprecated** Will be removed in a future version of stdlib. See -[`validate_legacy`](#validate_legacy). - -Returns: `Boolean` Returns `true` or `false` - -### `is_ipv4_address` +### `is_ipv4_address` Type: Ruby 4.x API @@ -3055,7 +3071,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_ipv4_address` +### `is_ipv4_address` Type: Ruby 3.x API @@ -3069,7 +3085,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_ipv6_address` +### `is_ipv6_address` Type: Ruby 4.x API @@ -3093,7 +3109,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_ipv6_address` +### `is_ipv6_address` Type: Ruby 3.x API @@ -3107,7 +3123,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_mac_address` +### `is_mac_address` Type: Ruby 3.x API @@ -3121,7 +3137,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `is_numeric` +### `is_numeric` Type: Ruby 3.x API @@ -3155,7 +3171,7 @@ it must be followed by at least one digit. Returns: `Boolean` Returns `true` or `false` -### `is_numeric` +### `is_numeric` Type: Ruby 4.x API @@ -3179,7 +3195,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_string` +### `is_string` Type: Ruby 4.x API @@ -3203,7 +3219,7 @@ Data type: `Any` Any additional values that are to be passed to the wrapped method -### `is_string` +### `is_string` Type: Ruby 3.x API @@ -3217,7 +3233,7 @@ Type: Ruby 3.x API Returns: `Boolean` Returns `true` or `false` -### `join` +### `join` Type: Ruby 3.x API @@ -3247,7 +3263,7 @@ Returns: `String` The String containing each of the array values join(['a','b','c'], ",") # Results in: "a,b,c" ``` -### `join_keys_to_values` +### `join_keys_to_values` Type: Ruby 3.x API @@ -3291,7 +3307,7 @@ join_keys_to_values({'a'=>1,'b'=>2}, " is ") # Results in: ["a is 1","b is 2"] join_keys_to_values({'a'=>1,'b'=>[2,3]}, " is ") # Results in: ["a is 1","b is 2","b is 3"] ``` -### `keys` +### `keys` Type: Ruby 3.x API @@ -3305,7 +3321,7 @@ function will be used instead of this function. Returns: `Array` An array containing each of the hashes key values. -### `length` +### `length` Type: Ruby 4.x API @@ -3331,7 +3347,7 @@ Data type: `Variant[String,Array,Hash]` The value whose length is to be found -### `load_module_metadata` +### `load_module_metadata` Type: Ruby 3.x API @@ -3361,7 +3377,7 @@ $metadata = load_module_metadata('archive') notify { $metadata['author']: } ``` -### `loadjson` +### `loadjson` Type: Ruby 3.x API @@ -3399,7 +3415,7 @@ $myhash = loadjson('https://username:password@example.local/my_hash.json') $myhash = loadjson('no-file.json', {'default' => 'val ``` -### `loadyaml` +### `loadyaml` Type: Ruby 3.x API @@ -3437,7 +3453,7 @@ $myhash = loadyaml('https://username:password@example.local/my_hash.yaml') $myhash = loadyaml('no-file.yaml', {'default' => 'val ``` -### `lstrip` +### `lstrip` Type: Ruby 3.x API @@ -3451,7 +3467,7 @@ built-in [`max`](https://puppet.com/docs/puppet/latest/function.html#max) functi Returns: `String` The stripped string -### `max` +### `max` Type: Ruby 3.x API @@ -3469,7 +3485,7 @@ built-in [`lstrip`](https://puppet.com/docs/puppet/latest/function.html#lstrip) Returns: `Any` The highest value among those passed in -### `member` +### `member` Type: Ruby 3.x API @@ -3533,7 +3549,7 @@ member(['a','b'], 'c') # Returns: false member(['a', 'b', 'c'], ['d', 'b']) # Returns: false ``` -### `merge` +### `merge` Type: Ruby 3.x API @@ -3571,7 +3587,7 @@ $hash2 = {'two' => 'dos', 'three', => 'tres'} $merged_hash = merge($hash1, $hash2) # $merged_hash = {'one' => 1, 'two' => 'dos', 'three' => 'tres'} ``` -### `merge` +### `merge` Type: Ruby 4.x API @@ -3664,7 +3680,7 @@ Data type: `Callable[2,2]` A block placed on the repeatable param `args` -### `min` +### `min` Type: Ruby 3.x API @@ -3682,7 +3698,7 @@ built-in [`min`](https://puppet.com/docs/puppet/latest/function.html#min) functi Returns: `Any` The lowest value among the given arguments -### `num2bool` +### `num2bool` Type: Ruby 3.x API @@ -3697,7 +3713,7 @@ See the new() function in Puppet for the many available type conversions. Returns: `Boolean` Boolean(0) # false for any zero or negative number Boolean(1) # true for any positive number -### `os_version_gte` +### `os_version_gte` Type: Ruby 4.x API @@ -3741,7 +3757,7 @@ Data type: `String[1]` -### `parsehocon` +### `parsehocon` Type: Ruby 4.x API @@ -3782,7 +3798,7 @@ Data type: `Optional[Any]` An optional default to return if parsing hocon_string fails -### `parsejson` +### `parsejson` Type: Ruby 3.x API @@ -3798,7 +3814,7 @@ Type: Ruby 3.x API Returns: `Any` convert JSON into Puppet structure -### `parseyaml` +### `parseyaml` Type: Ruby 3.x API @@ -3814,7 +3830,7 @@ Type: Ruby 3.x API Returns: `Any` converted YAML into Puppet structure -### `pick` +### `pick` Type: Ruby 3.x API @@ -3844,7 +3860,7 @@ Dashboard/Enterprise Console, and failover to a default value like the following Returns: `Any` the first value in a list of values that is not undefined or an empty string. -### `pick_default` +### `pick_default` Type: Ruby 3.x API @@ -3886,7 +3902,7 @@ Returns: `Any` This function is similar to a coalesce function in SQL in that it the first value in a list of values that is not undefined or an empty string If no value is found, it will return the last argument. -### `prefix` +### `prefix` Type: Ruby 3.x API @@ -3922,7 +3938,7 @@ prefix(['a','b','c'], 'p') Will return: ['pa','pb','pc'] ``` -### `private` +### `private` Type: Ruby 3.x API @@ -3935,7 +3951,7 @@ The private function. Returns: `Any` Sets the current class or definition as private -### `pry` +### `pry` Type: Ruby 3.x API @@ -3965,7 +3981,7 @@ Returns: `Any` debugging information `pry()` ``` -### `pw_hash` +### `pw_hash` Type: Ruby 3.x API @@ -4011,7 +4027,7 @@ The third argument to this function is the salt to use. Returns: `Hash` Provides a hash usable on most POSIX systems. -### `range` +### `range` Type: Ruby 3.x API @@ -4085,7 +4101,7 @@ range("0", "9", "2") Will return: [0,2,4,6,8] ``` -### `regexpescape` +### `regexpescape` Type: Ruby 3.x API @@ -4098,7 +4114,7 @@ The regexpescape function. Returns: `String` A string of characters with metacharacters converted to their escaped form. -### `reject` +### `reject` Type: Ruby 3.x API @@ -4136,7 +4152,7 @@ reject(['aaa','bbb','ccc','aaaddd'], 'aaa') Would return: ['bbb','ccc'] ``` -### `reverse` +### `reverse` Type: Ruby 3.x API @@ -4148,7 +4164,7 @@ Type: Ruby 3.x API Returns: `Any` reversed string or array -### `round` +### `round` Type: Ruby 3.x API @@ -4170,7 +4186,7 @@ Type: Ruby 3.x API Returns: `Any` the rounded value as integer -### `rstrip` +### `rstrip` Type: Ruby 3.x API @@ -4184,7 +4200,7 @@ will be used instead of this function. Returns: `Any` the string with leading spaces removed -### `seeded_rand` +### `seeded_rand` Type: Ruby 3.x API @@ -4218,7 +4234,7 @@ seeded_rand(MAX, SEED). MAX must be a positive integer; SEED is any string. ``` -### `seeded_rand_string` +### `seeded_rand_string` Type: Ruby 4.x API @@ -4276,7 +4292,7 @@ Data type: `Optional[String[2]]` String that contains characters to use for the random string. -### `shell_escape` +### `shell_escape` Type: Ruby 3.x API @@ -4294,7 +4310,7 @@ This function behaves the same as ruby's Shellwords.shellescape() function. Returns: `Any` A string of characters with metacharacters converted to their escaped form. -### `shell_join` +### `shell_join` Type: Ruby 3.x API @@ -4310,7 +4326,7 @@ This function behaves the same as ruby's Shellwords.shelljoin() function Returns: `Any` a command line string -### `shell_split` +### `shell_split` Type: Ruby 3.x API @@ -4322,7 +4338,7 @@ This function behaves the same as ruby's Shellwords.shellsplit() function Returns: `Any` array of tokens -### `shuffle` +### `shuffle` Type: Ruby 3.x API @@ -4336,7 +4352,7 @@ Type: Ruby 3.x API Returns: `Any` randomized string or array -### `size` +### `size` Type: Ruby 3.x API @@ -4350,7 +4366,7 @@ of Puppet < 5.4.0 use the stdlib length() function. Returns: `Any` the number of elements in a string, an array or a hash -### `sort` +### `sort` Type: Ruby 3.x API @@ -4362,7 +4378,7 @@ Note that from Puppet 6.0.0 the same function in Puppet will be used instead of Returns: `Any` sorted string or array -### `sprintf_hash` +### `sprintf_hash` Type: Ruby 4.x API @@ -4422,7 +4438,7 @@ Data type: `Hash` Hash with parameters. -### `squeeze` +### `squeeze` Type: Ruby 3.x API @@ -4434,7 +4450,7 @@ The squeeze function. Returns: `Any` a new string where runs of the same character that occur in this set are replaced by a single character. -### `stdlib::end_with` +### `stdlib::end_with` Type: Ruby 4.x API @@ -4450,7 +4466,7 @@ Returns true if str ends with one of the prefixes given. Each of the prefixes sh 'foobar'.stdlib::end_with(['foo', 'baz']) => false ``` -#### `stdlib::end_with(String[1] $test_string, Variant[String[1],Array[String[1], 1]] $suffixes)` +#### `stdlib::end_with(String $test_string, Variant[String[1],Array[String[1], 1]] $suffixes)` The stdlib::end_with function. @@ -4468,7 +4484,7 @@ Returns: `Boolean` True or False ##### `test_string` -Data type: `String[1]` +Data type: `String` The string to check @@ -4478,7 +4494,31 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The suffixes to check -### `stdlib::extname` +### `stdlib::ensure` + +Type: Puppet Language + +function to cast ensure parameter to resource specific value + +#### `stdlib::ensure(Variant[Boolean, Enum['present', 'absent']] $ensure, Enum['directory', 'link', 'mounted', 'service', 'file'] $resource)` + +The stdlib::ensure function. + +Returns: `String` + +##### `ensure` + +Data type: `Variant[Boolean, Enum['present', 'absent']]` + + + +##### `resource` + +Data type: `Enum['directory', 'link', 'mounted', 'service', 'file']` + + + +### `stdlib::extname` Type: Ruby 4.x API @@ -4526,7 +4566,7 @@ Data type: `String` The Filename -### `stdlib::ip_in_range` +### `stdlib::ip_in_range` Type: Ruby 4.x API @@ -4567,7 +4607,7 @@ Data type: `Variant[String, Array]` One CIDR or an array of CIDRs defining the range(s) to check against -### `stdlib::start_with` +### `stdlib::start_with` Type: Ruby 4.x API @@ -4583,7 +4623,7 @@ Returns true if str starts with one of the prefixes given. Each of the prefixes 'foObar'.stdlib::start_with(['bar', 'baz']) => false ``` -#### `stdlib::start_with(String[1] $test_string, Variant[String[1],Array[String[1], 1]] $prefixes)` +#### `stdlib::start_with(String $test_string, Variant[String[1],Array[String[1], 1]] $prefixes)` The stdlib::start_with function. @@ -4601,7 +4641,7 @@ Returns: `Boolean` True or False ##### `test_string` -Data type: `String[1]` +Data type: `String` The string to check @@ -4611,7 +4651,7 @@ Data type: `Variant[String[1],Array[String[1], 1]]` The prefixes to check. -### `str2bool` +### `str2bool` Type: Ruby 3.x API @@ -4626,7 +4666,7 @@ See the function new() in Puppet for details what the Boolean data type supports Returns: `Any` This attempt to convert to boolean strings that contain things like: Y,y, 1, T,t, TRUE,true to 'true' and strings that contain things like: 0, F,f, N,n, false, FALSE, no to 'false'. -### `str2saltedpbkdf2` +### `str2saltedpbkdf2` Type: Ruby 3.x API @@ -4700,7 +4740,7 @@ user { 'jdoe': } ``` -### `str2saltedsha512` +### `str2saltedsha512` Type: Ruby 3.x API @@ -4716,7 +4756,7 @@ manifests as a valid password attribute. Returns: `Any` converted string as a hex version of a salted-SHA512 password hash -### `strip` +### `strip` Type: Ruby 3.x API @@ -4750,7 +4790,7 @@ strip(" aaa ") Would result in: "aaa" ``` -### `suffix` +### `suffix` Type: Ruby 3.x API @@ -4788,7 +4828,7 @@ suffix(['a','b','c'], 'p') Will return: ['ap','bp','cp'] ``` -### `swapcase` +### `swapcase` Type: Ruby 3.x API @@ -4820,7 +4860,7 @@ swapcase("aBcD") Would result in: "AbCd" ``` -### `time` +### `time` Type: Ruby 3.x API @@ -4860,7 +4900,7 @@ time() Will return something like: 1311972653 ``` -### `to_bytes` +### `to_bytes` Type: Ruby 3.x API @@ -4876,7 +4916,7 @@ These conversions reflect a layperson's understanding of Returns: `Any` converted value into bytes -### `to_json` +### `to_json` Type: Ruby 4.x API @@ -4918,7 +4958,7 @@ Data type: `Any` data structure which needs to be converted into JSON -### `to_json_pretty` +### `to_json_pretty` Type: Ruby 4.x API @@ -5030,7 +5070,7 @@ hash-map of settings passed to JSON.pretty_generate, see https://ruby-doc.org/stdlib-2.0.0/libdoc/json/rdoc/JSON.html#method-i-generate. Note that `max_nesting` doesn't take the value `false`; use `-1` instead. -### `to_yaml` +### `to_yaml` Type: Ruby 4.x API @@ -5038,7 +5078,7 @@ Convert a data structure and output it as YAML #### Examples -##### how to output YAML +##### How to output YAML ```puppet # output yaml to a file @@ -5048,7 +5088,16 @@ Convert a data structure and output it as YAML } ``` -#### `to_yaml(Any $data)` +##### Use options control the output format + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash, {indentation: 4}) +} +``` + +#### `to_yaml(Any $data, Optional[Hash] $options)` The to_yaml function. @@ -5056,7 +5105,7 @@ Returns: `String` ##### Examples -###### how to output YAML +###### How to output YAML ```puppet # output yaml to a file @@ -5066,13 +5115,28 @@ Returns: `String` } ``` +###### Use options control the output format + +```puppet +file { '/tmp/my.yaml': + ensure => file, + content => to_yaml($myhash, {indentation: 4}) +} +``` + ##### `data` Data type: `Any` -### `try_get_value` +##### `options` + +Data type: `Optional[Hash]` + + + +### `try_get_value` Type: Ruby 3.x API @@ -5139,7 +5203,7 @@ missing. And the fourth argument can set a variable path separator. Returns: `Any` Looks up into a complex structure of arrays and hashes and returns a value or the default value if nothing was found. -### `type` +### `type` Type: Ruby 3.x API @@ -5165,7 +5229,7 @@ please use type3x() before upgrading to Puppet 4 for backwards-compatibility, or Returns: `Any` the type when passed a value. Type can be one of: -### `type3x` +### `type3x` Type: Ruby 3.x API @@ -5187,7 +5251,7 @@ Type: Ruby 3.x API Returns: `Any` the type when passed a value. Type can be one of: -### `type_of` +### `type_of` Type: Ruby 4.x API @@ -5245,7 +5309,7 @@ Data type: `Any` -### `union` +### `union` Type: Ruby 3.x API @@ -5277,7 +5341,7 @@ union(["a","b","c"],["b","c","d"]) Would return: ["a","b","c","d"] ``` -### `unique` +### `unique` Type: Ruby 3.x API @@ -5319,7 +5383,7 @@ unique(["a","a","b","b","c","c"]) This returns: ["a","b","c"] ``` -### `unix2dos` +### `unix2dos` Type: Ruby 3.x API @@ -5331,7 +5395,7 @@ Takes a single string argument. Returns: `Any` the DOS version of the given string. -### `upcase` +### `upcase` Type: Ruby 3.x API @@ -5365,7 +5429,7 @@ upcase("abcd") Will return ABCD ``` -### `uriescape` +### `uriescape` Type: Ruby 3.x API @@ -5378,7 +5442,7 @@ The uriescape function. Returns: `String` a string that contains the converted value -### `validate_absolute_path` +### `validate_absolute_path` Type: Ruby 3.x API @@ -5447,7 +5511,7 @@ The following values will fail, causing compilation to abort: validate_absolute_path($undefin ``` -### `validate_absolute_path` +### `validate_absolute_path` Type: Ruby 4.x API @@ -5471,7 +5535,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_array` +### `validate_array` Type: Ruby 3.x API @@ -5520,7 +5584,7 @@ The following values will fail, causing compilation to abort: validate_array($undefined ``` -### `validate_array` +### `validate_array` Type: Ruby 4.x API @@ -5544,7 +5608,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_augeas` +### `validate_augeas` Type: Ruby 3.x API @@ -5618,7 +5682,7 @@ A helpful error message can be returned like this: validate_augeas($sudoerscontent, 'Sudoers.lns', [], 'Failed to validate sudoers content with Augeas') ``` -### `validate_bool` +### `validate_bool` Type: Ruby 3.x API @@ -5671,7 +5735,7 @@ The following values will fail, causing compilation to abort: validate_bool($some_array) ``` -### `validate_bool` +### `validate_bool` Type: Ruby 4.x API @@ -5696,7 +5760,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_cmd` +### `validate_cmd` Type: Ruby 3.x API @@ -5750,7 +5814,7 @@ Defaults to end of path validate_cmd($haproxycontent, '/usr/sbin/haproxy -f % -c', 'Haproxy failed to validate config content') ``` -### `validate_domain_name` +### `validate_domain_name` Type: Ruby 3.x API @@ -5805,7 +5869,7 @@ The following values will fail, causing compilation to abort: validate_domain_name('www.example.2com') ``` -### `validate_email_address` +### `validate_email_address` Type: Ruby 3.x API @@ -5854,7 +5918,7 @@ The following values will fail, causing compilation to abort: validate_email_address($some_array) ``` -### `validate_hash` +### `validate_hash` Type: Ruby 3.x API @@ -5905,7 +5969,7 @@ The following values will fail, causing compilation to abort: validate_hash($undefined) ``` -### `validate_hash` +### `validate_hash` Type: Ruby 4.x API @@ -5929,7 +5993,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_integer` +### `validate_integer` Type: Ruby 3.x API @@ -6043,7 +6107,7 @@ Plus all of the above, but with incorrect combinations of negative integer value Plus all of the above, but with non-integer items in arrays or maximum / minimum argument. ``` -### `validate_integer` +### `validate_integer` Type: Ruby 4.x API @@ -6068,7 +6132,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_ip_address` +### `validate_ip_address` Type: Ruby 3.x API @@ -6126,7 +6190,7 @@ The following values will fail, causing compilation to abort: validate_ip_address($some_array) ``` -### `validate_ip_address` +### `validate_ip_address` Type: Ruby 4.x API @@ -6151,32 +6215,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_ipv4_address` - -Type: Ruby 4.x API - -Validate the passed value represents an ipv4_address. - -#### `validate_ipv4_address(Any $scope, Any *$args)` - -The validate_ipv4_address function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### `validate_ipv4_address` +### `validate_ipv4_address` Type: Ruby 3.x API @@ -6223,7 +6262,32 @@ The following values will fail, causing compilation to abort: validate_ipv4_address($some_array) ``` -### `validate_ipv6_address` +### `validate_ipv4_address` + +Type: Ruby 4.x API + +Validate the passed value represents an ipv4_address. + +#### `validate_ipv4_address(Any $scope, Any *$args)` + +The validate_ipv4_address function. + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_ipv6_address` Type: Ruby 3.x API @@ -6272,7 +6336,7 @@ The following values will fail, causing compilation to abort: validate_ipv6_address($some_array) ``` -### `validate_ipv6_address` +### `validate_ipv6_address` Type: Ruby 4.x API @@ -6297,7 +6361,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_legacy` +### `validate_legacy` Type: Ruby 4.x API @@ -6375,7 +6439,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_numeric` +### `validate_numeric` Type: Ruby 3.x API @@ -6399,7 +6463,7 @@ For passing and failing usage, see `validate_integer()`. It is all the same for Returns: `Any` Validate that the first argument is a numeric value (or an array of numeric values). Fail compilation if any of the checks fail. -### `validate_numeric` +### `validate_numeric` Type: Ruby 4.x API @@ -6424,7 +6488,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_re` +### `validate_re` Type: Ruby 3.x API @@ -6496,7 +6560,7 @@ A helpful error message can be returned like this: validate_re($::puppetversion, '^2.7', 'The $puppetversion fact value does not match 2.7') ``` -### `validate_re` +### `validate_re` Type: Ruby 4.x API @@ -6524,7 +6588,32 @@ The first argument of this function should be a string to test, and the second argument should be a stringified regular expression (without the // delimiters) or an array of regular expressions -### `validate_slength` +### `validate_slength` + +Type: Ruby 4.x API + +Validate that a passed string has length less/equal with the passed value + +#### `validate_slength(Any $scope, Any *$args)` + +Validate that a passed string has length less/equal with the passed value + +Returns: `Boolean` `true` or `false` +A boolean value returned from the called function. + +##### `scope` + +Data type: `Any` + +The main value that will be passed to the method + +##### `*args` + +Data type: `Any` + +Any additional values that are to be passed to the method + +### `validate_slength` Type: Ruby 3.x API @@ -6574,15 +6663,15 @@ The following valueis will not: validate_slength(["discombobulate","moo"],17,10) ``` -### `validate_slength` +### `validate_string` Type: Ruby 4.x API -Validate that a passed string has length less/equal with the passed value +Validate that all passed values are string data structures. -#### `validate_slength(Any $scope, Any *$args)` +#### `validate_string(Any $scope, Any *$args)` -Validate that a passed string has length less/equal with the passed value +The validate_string function. Returns: `Boolean` `true` or `false` A boolean value returned from the called function. @@ -6599,7 +6688,7 @@ Data type: `Any` Any additional values that are to be passed to the method -### `validate_string` +### `validate_string` Type: Ruby 3.x API @@ -6658,32 +6747,7 @@ The following values will fail, causing compilation to abort: validate_string([ 'some', 'array' ]) ``` -### `validate_string` - -Type: Ruby 4.x API - -Validate that all passed values are string data structures. - -#### `validate_string(Any $scope, Any *$args)` - -The validate_string function. - -Returns: `Boolean` `true` or `false` -A boolean value returned from the called function. - -##### `scope` - -Data type: `Any` - -The main value that will be passed to the method - -##### `*args` - -Data type: `Any` - -Any additional values that are to be passed to the method - -### `validate_x509_rsa_key_pair` +### `validate_x509_rsa_key_pair` Type: Ruby 3.x API @@ -6695,7 +6759,7 @@ Type: Ruby 3.x API Returns: `Any` Fail compilation if any value fails this check. -### `values` +### `values` Type: Ruby 3.x API @@ -6741,7 +6805,7 @@ values($hash) This example would return: ```[1,2,3]``` ``` -### `values_at` +### `values_at` Type: Ruby 3.x API @@ -6811,7 +6875,7 @@ values_at(['a','b','c','d','e'], [0, "2-3"]) Would return ['a','c','d'] ``` -### `zip` +### `zip` Type: Ruby 3.x API @@ -6843,25 +6907,37 @@ Would result in: ["1", "4"], ["2", "5"], ["3", "6"] ## Data types -### `Stdlib::Absolutepath` +### `Stdlib::Absolutepath` A strict absolutepath type -Alias of `Variant[Stdlib::Windowspath, Stdlib::Unixpath]` +Alias of -### `Stdlib::Base32` +```puppet +Variant[Stdlib::Windowspath, Stdlib::Unixpath] +``` + +### `Stdlib::Base32` Type to match base32 String -Alias of `Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/]` +Alias of -### `Stdlib::Base64` +```puppet +Pattern[/\A[a-z2-7]+={,6}\z/, /\A[A-Z2-7]+={,6}\z/] +``` + +### `Stdlib::Base64` Type to match base64 String -Alias of `Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/]` +Alias of -### `Stdlib::Compat::Absolute_path` +```puppet +Pattern[/\A[a-zA-Z0-9\/\+]+={,2}\z/] +``` + +### `Stdlib::Compat::Absolute_path` Emulate the is_absolute_path and validate_absolute_path functions @@ -6870,21 +6946,33 @@ slash = '[\\\\/]' name = '[^\\\\/]+' %r!^(([A-Z]:#{slash})|(#{slash}#{slash}#{name}#{slash}#{name})|(#{slash}#{slash}\?#{slash}#{name}))!i, -Alias of `Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]]` +Alias of + +```puppet +Variant[Pattern[/^(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+))/], Pattern[/^\//]] +``` -### `Stdlib::Compat::Array` +### `Stdlib::Compat::Array` Emulate the is_array and validate_array functions -Alias of `Array[Any]` +Alias of + +```puppet +Array[Any] +``` -### `Stdlib::Compat::Bool` +### `Stdlib::Compat::Bool` Emulate the is_bool and validate_bool functions -Alias of `Boolean` +Alias of -### `Stdlib::Compat::Float` +```puppet +Boolean +``` + +### `Stdlib::Compat::Float` Emulate the is_float function The regex is what's currently used in is_float @@ -6905,15 +6993,23 @@ class example(Stdlib::Compat::Float $value) { This allows you to find all places where a consumers of your code call it with unexpected values. -Alias of `Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]]` +Alias of + +```puppet +Variant[Float, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)(?:[eE]-?\d+)?$/]] +``` -### `Stdlib::Compat::Hash` +### `Stdlib::Compat::Hash` Emulate the is_hash and validate_hash functions -Alias of `Hash[Any, Any]` +Alias of + +```puppet +Hash[Any, Any] +``` -### `Stdlib::Compat::Integer` +### `Stdlib::Compat::Integer` Emulate the is_integer and validate_integer functions The regex is what's currently used in is_integer @@ -6938,27 +7034,43 @@ class example(Stdlib::Compat::Integer $value) { This allows you to find all places where a consumers of your code call it with unexpected values. -Alias of `Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]]` +Alias of + +```puppet +Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/], Array[Variant[Integer, Pattern[/^-?(?:(?:[1-9]\d*)|0)$/]]]] +``` -### `Stdlib::Compat::Ip_address` +### `Stdlib::Compat::Ip_address` The Stdlib::Compat::Ip_address data type. -Alias of `Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6]` +Alias of -### `Stdlib::Compat::Ipv4` +```puppet +Variant[Stdlib::Compat::Ipv4, Stdlib::Compat::Ipv6] +``` + +### `Stdlib::Compat::Ipv4` Emulate the validate_ipv4_address and is_ipv4_address functions -Alias of `Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/]` +Alias of -### `Stdlib::Compat::Ipv6` +```puppet +Pattern[/^((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d)))(\/((([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))[.]){3}([0-9](?!\d)|[1-9][0-9](?!\d)|1[0-9]{2}(?!\d)|2[0-4][0-9](?!\d)|25[0-5](?!\d))|[0-9]+))?$/] +``` + +### `Stdlib::Compat::Ipv6` The Stdlib::Compat::Ipv6 data type. -Alias of `Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/]` +Alias of -### `Stdlib::Compat::Numeric` +```puppet +Pattern[/\s*((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)(\.(25[0-5]|2[0-4]\d|1\d\d|[1-9]?\d)){3}))|:)))(%.+)?\s*$/] +``` + +### `Stdlib::Compat::Numeric` Emulate the is_numeric and validate_numeric functions The regex is what's currently used in is_numeric @@ -6983,261 +7095,443 @@ class example(Stdlib::Compat::Numeric $value) { This allows you to find all places where a consumers of your code call it with unexpected values. -Alias of `Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]]` +Alias of + +```puppet +Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/], Array[Variant[Numeric, Pattern[/^-?(?:(?:[1-9]\d*)|0)(?:\.\d+)?(?:[eE]-?\d+)?$/]]]] +``` -### `Stdlib::Compat::String` +### `Stdlib::Compat::String` Emulate the is_string and validate_string functions -Alias of `Optional[String]` +Alias of -### `Stdlib::Datasize` +```puppet +Optional[String] +``` + +### `Stdlib::Datasize` The Stdlib::Datasize data type. -Alias of `Pattern[/^\d+(?i:[kmgt]b?|b)$/]` +Alias of -### `Stdlib::Ensure::File` +```puppet +Pattern[/^\d+(?i:[kmgt]b?|b)$/] +``` + +### `Stdlib::Ensure::File` The Stdlib::Ensure::File data type. -Alias of `Enum['present', 'file', 'directory', 'link', 'absent']` +Alias of -### `Stdlib::Ensure::File::Directory` +```puppet +Enum['present', 'file', 'directory', 'link', 'absent'] +``` + +### `Stdlib::Ensure::File::Directory` The Stdlib::Ensure::File::Directory data type. -Alias of `Enum['directory', 'absent']` +Alias of + +```puppet +Enum['directory', 'absent'] +``` -### `Stdlib::Ensure::File::File` +### `Stdlib::Ensure::File::File` The Stdlib::Ensure::File::File data type. -Alias of `Enum['file', 'absent']` +Alias of + +```puppet +Enum['file', 'absent'] +``` -### `Stdlib::Ensure::File::Link` +### `Stdlib::Ensure::File::Link` The Stdlib::Ensure::File::Link data type. -Alias of `Enum['link', 'absent']` +Alias of + +```puppet +Enum['link', 'absent'] +``` -### `Stdlib::Ensure::Service` +### `Stdlib::Ensure::Service` The Stdlib::Ensure::Service data type. -Alias of `Enum['stopped', 'running']` +Alias of + +```puppet +Enum['stopped', 'running'] +``` -### `Stdlib::Filemode` +### `Stdlib::Filemode` See `man chmod.1` for the regular expression for symbolic mode lint:ignore:140chars -Alias of `Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/]` +Alias of -### `Stdlib::Filesource` +```puppet +Pattern[/\A(([0-7]{1,4})|(([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+)(,([ugoa]*([-+=]([rwxXst]*|[ugo]))+|[-+=][0-7]+))*))\z/] +``` + +### `Stdlib::Filesource` Validate the source parameter on file types -Alias of `Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ +Alias of + +```puppet +Variant[Stdlib::Absolutepath, Stdlib::HTTPUrl, Pattern[ /\Afile:\/\/\/([^\n\/\0]+(\/)?)+\z/, /\Apuppet:\/\/(([\w-]+\.?)+)?\/([^\n\/\0]+(\/)?)+\z/, - ]]` + ]] +``` -### `Stdlib::Fqdn` +### `Stdlib::Fqdn` The Stdlib::Fqdn data type. -Alias of `Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/]` +Alias of -### `Stdlib::HTTPSUrl` +```puppet +Pattern[/\A(([a-zA-Z0-9]|[a-zA-Z0-9][a-zA-Z0-9\-]*[a-zA-Z0-9])\.)*([A-Za-z0-9]|[A-Za-z0-9][A-Za-z0-9\-]*[A-Za-z0-9])\z/] +``` + +### `Stdlib::HTTPSUrl` The Stdlib::HTTPSUrl data type. -Alias of `Pattern[/(?i:\Ahttps:\/\/.*\z)/]` +Alias of -### `Stdlib::HTTPUrl` +```puppet +Pattern[/(?i:\Ahttps:\/\/.*\z)/] +``` + +### `Stdlib::HTTPUrl` The Stdlib::HTTPUrl data type. -Alias of `Pattern[/(?i:\Ahttps?:\/\/.*\z)/]` +Alias of + +```puppet +Pattern[/(?i:\Ahttps?:\/\/.*\z)/] +``` -### `Stdlib::Host` +### `Stdlib::Host` The Stdlib::Host data type. -Alias of `Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address]` +Alias of + +```puppet +Variant[Stdlib::Fqdn, Stdlib::Compat::Ip_address] +``` + +### `Stdlib::HttpStatus` + +The Stdlib::HttpStatus data type. -### `Stdlib::IP::Address` +Alias of + +```puppet +Integer[100, 599] +``` + +### `Stdlib::IP::Address` The Stdlib::IP::Address data type. -Alias of `Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6]` +Alias of + +```puppet +Variant[Stdlib::IP::Address::V4, Stdlib::IP::Address::V6] +``` -### `Stdlib::IP::Address::Nosubnet` +### `Stdlib::IP::Address::Nosubnet` The Stdlib::IP::Address::Nosubnet data type. -Alias of `Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet]` +Alias of -### `Stdlib::IP::Address::V4` +```puppet +Variant[Stdlib::IP::Address::V4::Nosubnet, Stdlib::IP::Address::V6::Nosubnet] +``` + +### `Stdlib::IP::Address::V4` The Stdlib::IP::Address::V4 data type. -Alias of `Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet]` +Alias of + +```puppet +Variant[Stdlib::IP::Address::V4::CIDR, Stdlib::IP::Address::V4::Nosubnet] +``` -### `Stdlib::IP::Address::V4::CIDR` +### `Stdlib::IP::Address::V4::CIDR` lint:ignore:140chars -Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/]` +Alias of -### `Stdlib::IP::Address::V4::Nosubnet` +```puppet +Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\/([0-9]|[12][0-9]|3[0-2])\z/] +``` + +### `Stdlib::IP::Address::V4::Nosubnet` lint:ignore:140chars -Alias of `Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` +Alias of -### `Stdlib::IP::Address::V6` +```puppet +Pattern[/\A([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/] +``` + +### `Stdlib::IP::Address::V6` The Stdlib::IP::Address::V6 data type. -Alias of `Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet]` +Alias of -### `Stdlib::IP::Address::V6::Alternative` +```puppet +Variant[Stdlib::IP::Address::V6::Full, Stdlib::IP::Address::V6::Compressed, Stdlib::IP::Address::V6::Alternative, Stdlib::IP::Address::V6::Nosubnet] +``` + +### `Stdlib::IP::Address::V6::Alternative` lint:ignore:140chars -Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` +Alias of + +```puppet +Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] +``` -### `Stdlib::IP::Address::V6::CIDR` +### `Stdlib::IP::Address::V6::CIDR` lint:ignore:140chars -Alias of `Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/]` +Alias of + +```puppet +Pattern[/\A((([0-9A-Fa-f]{1,4}:){7}([0-9A-Fa-f]{1,4}|:))|(([0-9A-Fa-f]{1,4}:){6}(:[0-9A-Fa-f]{1,4}|((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){5}(((:[0-9A-Fa-f]{1,4}){1,2})|:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3})|:))|(([0-9A-Fa-f]{1,4}:){4}(((:[0-9A-Fa-f]{1,4}){1,3})|((:[0-9A-Fa-f]{1,4})?:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){3}(((:[0-9A-Fa-f]{1,4}){1,4})|((:[0-9A-Fa-f]{1,4}){0,2}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){2}(((:[0-9A-Fa-f]{1,4}){1,5})|((:[0-9A-Fa-f]{1,4}){0,3}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(([0-9A-Fa-f]{1,4}:){1}(((:[0-9A-Fa-f]{1,4}){1,6})|((:[0-9A-Fa-f]{1,4}){0,4}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:))|(:(((:[0-9A-Fa-f]{1,4}){1,7})|((:[0-9A-Fa-f]{1,4}){0,5}:((25[0-5]|2[0-4]d|1dd|[1-9]?d)(.(25[0-5]|2[0-4]d|1dd|[1-9]?d)){3}))|:)))(%.+)?s*\/([0-9]|[1-9][0-9]|1[0-1][0-9]|12[0-8])?\z/] +``` -### `Stdlib::IP::Address::V6::Compressed` +### `Stdlib::IP::Address::V6::Compressed` The Stdlib::IP::Address::V6::Compressed data type. -Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` +Alias of -### `Stdlib::IP::Address::V6::Full` +```puppet +Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/, /\A([[:xdigit:]]{1,4}:){7}:(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] +``` + +### `Stdlib::IP::Address::V6::Full` The Stdlib::IP::Address::V6::Full data type. -Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/]` +Alias of -### `Stdlib::IP::Address::V6::Nosubnet` +```puppet +Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}(\/(1([01][0-9]|2[0-8])|[1-9][0-9]|[0-9]))?\z/] +``` + +### `Stdlib::IP::Address::V6::Nosubnet` The Stdlib::IP::Address::V6::Nosubnet data type. -Alias of `Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative]` +Alias of + +```puppet +Variant[Stdlib::IP::Address::V6::Nosubnet::Full, Stdlib::IP::Address::V6::Nosubnet::Compressed, Stdlib::IP::Address::V6::Nosubnet::Alternative] +``` -### `Stdlib::IP::Address::V6::Nosubnet::Alternative` +### `Stdlib::IP::Address::V6::Nosubnet::Alternative` lint:ignore:140chars -Alias of `Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/]` +Alias of -### `Stdlib::IP::Address::V6::Nosubnet::Compressed` +```puppet +Pattern[/\A([[:xdigit:]]{1,4}:){6}([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){4}(:[[:xdigit:]]{1,4}){0,1}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){3}(:[[:xdigit:]]{1,4}){0,2}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){2}(:[[:xdigit:]]{1,4}){0,3}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A([[:xdigit:]]{1,4}:){1}(:[[:xdigit:]]{1,4}){0,4}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/, /\A:(:[[:xdigit:]]{1,4}){0,5}:([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])(\.([0-9]|[1-9][0-9]|1[0-9]{2}|2[0-4][0-9]|25[0-5])){3}\z/] +``` + +### `Stdlib::IP::Address::V6::Nosubnet::Compressed` The Stdlib::IP::Address::V6::Nosubnet::Compressed data type. -Alias of `Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/]` +Alias of + +```puppet +Pattern[/\A:(:|(:[[:xdigit:]]{1,4}){1,7})\z/, /\A([[:xdigit:]]{1,4}:){1}(:|(:[[:xdigit:]]{1,4}){1,6})\z/, /\A([[:xdigit:]]{1,4}:){2}(:|(:[[:xdigit:]]{1,4}){1,5})\z/, /\A([[:xdigit:]]{1,4}:){3}(:|(:[[:xdigit:]]{1,4}){1,4})\z/, /\A([[:xdigit:]]{1,4}:){4}(:|(:[[:xdigit:]]{1,4}){1,3})\z/, /\A([[:xdigit:]]{1,4}:){5}(:|(:[[:xdigit:]]{1,4}){1,2})\z/, /\A([[:xdigit:]]{1,4}:){6}(:|(:[[:xdigit:]]{1,4}){1,1})\z/, /\A([[:xdigit:]]{1,4}:){7}:\z/] +``` -### `Stdlib::IP::Address::V6::Nosubnet::Full` +### `Stdlib::IP::Address::V6::Nosubnet::Full` The Stdlib::IP::Address::V6::Nosubnet::Full data type. -Alias of `Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/]` +Alias of + +```puppet +Pattern[/\A[[:xdigit:]]{1,4}(:[[:xdigit:]]{1,4}){7}\z/] +``` -### `Stdlib::MAC` +### `Stdlib::MAC` A type for a MAC address -Alias of `Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/]` +Alias of -### `Stdlib::ObjectStore` +```puppet +Pattern[/\A([0-9A-Fa-f]{2}[:-]){5}([0-9A-Fa-f]{2})\z/, /\A([0-9A-Fa-f]{2}[:-]){19}([0-9A-Fa-f]{2})\z/] +``` + +### `Stdlib::ObjectStore` The Stdlib::ObjectStore data type. -Alias of `Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri]` +Alias of + +```puppet +Variant[Stdlib::ObjectStore::GSUri, Stdlib::ObjectStore::S3Uri] +``` -### `Stdlib::ObjectStore::GSUri` +### `Stdlib::ObjectStore::GSUri` The Stdlib::ObjectStore::GSUri data type. -Alias of `Pattern[/\Ags:\/\/.*\z/]` +Alias of -### `Stdlib::ObjectStore::S3Uri` +```puppet +Pattern[/\Ags:\/\/.*\z/] +``` + +### `Stdlib::ObjectStore::S3Uri` The Stdlib::ObjectStore::S3Uri data type. -Alias of `Pattern[/\As3:\/\/.*\z/]` +Alias of -### `Stdlib::Port` +```puppet +Pattern[/\As3:\/\/.*\z/] +``` + +### `Stdlib::Port` The Stdlib::Port data type. -Alias of `Integer[0, 65535]` +Alias of -### `Stdlib::Port::Dynamic` +```puppet +Integer[0, 65535] +``` + +### `Stdlib::Port::Dynamic` The Stdlib::Port::Dynamic data type. -Alias of `Integer[49152, 65535]` +Alias of + +```puppet +Integer[49152, 65535] +``` -### `Stdlib::Port::Ephemeral` +### `Stdlib::Port::Ephemeral` The Stdlib::Port::Ephemeral data type. -Alias of `Stdlib::Port::Dynamic` +Alias of + +```puppet +Stdlib::Port::Dynamic +``` -### `Stdlib::Port::Privileged` +### `Stdlib::Port::Privileged` The Stdlib::Port::Privileged data type. -Alias of `Integer[1, 1023]` +Alias of -### `Stdlib::Port::Registered` +```puppet +Integer[1, 1023] +``` + +### `Stdlib::Port::Registered` The Stdlib::Port::Registered data type. -Alias of `Stdlib::Port::User` +Alias of -### `Stdlib::Port::Unprivileged` +```puppet +Stdlib::Port::User +``` + +### `Stdlib::Port::Unprivileged` The Stdlib::Port::Unprivileged data type. -Alias of `Integer[1024, 65535]` +Alias of + +```puppet +Integer[1024, 65535] +``` -### `Stdlib::Port::User` +### `Stdlib::Port::User` The Stdlib::Port::User data type. -Alias of `Integer[1024, 49151]` +Alias of + +```puppet +Integer[1024, 49151] +``` -### `Stdlib::Syslogfacility` +### `Stdlib::Syslogfacility` The Stdlib::Syslogfacility data type. -Alias of `Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7']` +Alias of + +```puppet +Enum['kern', 'user', 'mail', 'daemon', 'auth', 'syslog', 'lpr', 'news', 'uucp', 'cron', 'authpriv', 'ftp', 'ntp', 'security', 'console', 'solaris-cron', 'local0', 'local1', 'local2', 'local3', 'local4', 'local5', 'local6', 'local7'] +``` -### `Stdlib::Unixpath` +### `Stdlib::Unixpath` this regex rejects any path component that does not start with "/" or is NUL -Alias of `Pattern[/\A\/([^\n\/\0]+\/*)*\z/]` +Alias of + +```puppet +Pattern[/\A\/([^\n\/\0]+\/*)*\z/] +``` -### `Stdlib::Windowspath` +### `Stdlib::Windowspath` The Stdlib::Windowspath data type. -Alias of `Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/]` +Alias of -### `Stdlib::Yes_no` +```puppet +Pattern[/\A(([a-zA-Z]:[\\\/])|([\\\/][\\\/][^\\\/]+[\\\/][^\\\/]+)|([\\\/][\\\/]\?[\\\/][^\\\/]+)).*\z/] +``` + +### `Stdlib::Yes_no` The Stdlib::Yes_no data type. -Alias of `Pattern[/\A(?i:(yes|no))\z/]` +Alias of + +```puppet +Pattern[/\A(?i:(yes|no))\z/] +``` diff --git a/metadata.json b/metadata.json index cd3c139fc..d28f5de87 100644 --- a/metadata.json +++ b/metadata.json @@ -1,6 +1,6 @@ { "name": "puppetlabs-stdlib", - "version": "6.5.0", + "version": "6.6.0", "author": "puppetlabs", "summary": "Standard library of resources for Puppet modules.", "license": "Apache-2.0",