summaryrefslogtreecommitdiff
path: root/README.markdown
diff options
context:
space:
mode:
authorEli Young <elyscape@gmail.com>2015-01-26 19:17:53 -0800
committerEli Young <elyscape@gmail.com>2015-03-31 17:33:04 -0700
commita82266c256784c4af229e026b00a4dcf9e779270 (patch)
treee6024b6337c671dd513fd4b586834fdc2079239f /README.markdown
parent14a02ea21e14111071a921e82cdf3cd1f518c7f3 (diff)
(MODULES-1715) Add fqdn_rand string generators
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 293a81a..724a48e 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