summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorHunter Haugen <hunter@puppetlabs.com>2015-04-09 10:45:38 -0700
committerHunter Haugen <hunter@puppetlabs.com>2015-04-09 10:45:38 -0700
commit8fba5c058ba344421796cceca8f96dffcba0a4fc (patch)
tree8e452e9979d633a228352702c5f3e3873f286e7f /README.markdown
parent487e8d4cd7384e9c3170f93a71f14c0a78766a3f (diff)
parenta82266c256784c4af229e026b00a4dcf9e779270 (diff)
Merge pull request #405 from elyscape/feature/fqdn_rand_strings
(MODULES-1715) Add FQDN-based random string generator
Diffstat (limited to 'README.markdown')
-rw-r--r--README.markdown17
1 files changed, 17 insertions, 0 deletions
diff --git a/README.markdown b/README.markdown
index d6be689..3889088 100644
--- a/README.markdown
+++ b/README.markdown
@@ -244,6 +244,23 @@ This function flattens any deeply nested arrays and returns a single flat array
Returns the largest integer less than or equal to the argument.
Takes a single numeric value as an argument. *Type*: rvalue
+#### `fqdn_rand_string`
+
+Generates a random alphanumeric string using an optionally-specified character set (default is alphanumeric), combining the `$fqdn` fact and an optional seed for repeatable randomness.
+
+*Usage:*
+```
+fqdn_rand_string(LENGTH, [CHARSET], [SEED])
+```
+*Examples:*
+```
+fqdn_rand_string(10)
+fqdn_rand_string(10, 'ABCDEF!@#$%^')
+fqdn_rand_string(10, '', 'custom seed')
+```
+
+*Type*: rvalue
+
#### `fqdn_rotate`
Rotates an array a random number of times based on a node's fqdn. *Type*: rvalue