summaryrefslogtreecommitdiffstats
path: root/lib/ansible/plugins/filter/root.yml
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:04:21 +0000
commit8a754e0858d922e955e71b253c139e071ecec432 (patch)
tree527d16e74bfd1840c85efd675fdecad056c54107 /lib/ansible/plugins/filter/root.yml
parentInitial commit. (diff)
downloadansible-core-8a754e0858d922e955e71b253c139e071ecec432.tar.xz
ansible-core-8a754e0858d922e955e71b253c139e071ecec432.zip
Adding upstream version 2.14.3.upstream/2.14.3upstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'lib/ansible/plugins/filter/root.yml')
-rw-r--r--lib/ansible/plugins/filter/root.yml32
1 files changed, 32 insertions, 0 deletions
diff --git a/lib/ansible/plugins/filter/root.yml b/lib/ansible/plugins/filter/root.yml
new file mode 100644
index 0000000..4f52590
--- /dev/null
+++ b/lib/ansible/plugins/filter/root.yml
@@ -0,0 +1,32 @@
+DOCUMENTATION:
+ name: root
+ version_added: "1.9"
+ short_description: root of (math operation)
+ description:
+ - Math operation that returns the Nth root of inputed number C(X ^^ N).
+ positional: _input, base
+ options:
+ _input:
+ description: Number to operate on.
+ type: float
+ required: true
+ base:
+ description: Which root to take.
+ type: float
+ default: 2
+
+EXAMPLES: |
+
+ # => 8
+ fiveroot: "{{ 32768 | root (5) }}"
+
+ # 2
+ sqrt_of_2: "{{ 4 | root }}"
+
+ # me ^^ 3
+ cuberoot_me: "{{ me | root(3) }}"
+
+RETURN:
+ _value:
+ description: Resulting number.
+ type: float