summaryrefslogtreecommitdiffstats
path: root/examples/collection/plugins
diff options
context:
space:
mode:
Diffstat (limited to 'examples/collection/plugins')
-rw-r--r--examples/collection/plugins/modules/alpha.py44
-rw-r--r--examples/collection/plugins/modules/deep/beta.py44
2 files changed, 88 insertions, 0 deletions
diff --git a/examples/collection/plugins/modules/alpha.py b/examples/collection/plugins/modules/alpha.py
new file mode 100644
index 0000000..c806cad
--- /dev/null
+++ b/examples/collection/plugins/modules/alpha.py
@@ -0,0 +1,44 @@
+"""An ansible test module."""
+
+
+DOCUMENTATION = """
+module: mod_1
+author:
+- test
+short_description: This is a test module
+description:
+- This is a test module
+version_added: 1.0.0
+options:
+ foo:
+ description:
+ - Dummy option I(foo)
+ type: str
+ bar:
+ description:
+ - Dummy option I(bar)
+ default: candidate
+ type: str
+ choices:
+ - candidate
+ - running
+ aliases:
+ - bam
+notes:
+- This is a dummy module
+"""
+
+EXAMPLES = """
+- name: test task-1
+ company_name.coll_1.mod_1:
+ foo: some value
+ bar: candidate
+"""
+
+RETURN = """
+baz:
+ description: test return 1
+ returned: success
+ type: list
+ sample: ['a','b']
+"""
diff --git a/examples/collection/plugins/modules/deep/beta.py b/examples/collection/plugins/modules/deep/beta.py
new file mode 100644
index 0000000..ffd9ff8
--- /dev/null
+++ b/examples/collection/plugins/modules/deep/beta.py
@@ -0,0 +1,44 @@
+"""An ansible test module."""
+
+
+DOCUMENTATION = """
+module: mod_2
+author:
+- test
+short_description: This is a test module
+description:
+- This is a test module
+version_added: 1.0.0
+options:
+ foo:
+ description:
+ - Dummy option I(foo)
+ type: str
+ bar:
+ description:
+ - Dummy option I(bar)
+ default: candidate
+ type: str
+ choices:
+ - candidate
+ - running
+ aliases:
+ - bam
+notes:
+- This is a dummy module
+"""
+
+EXAMPLES = """
+- name: test task-1
+ company_name.coll_1.mod_2:
+ foo: some value
+ bar: candidate
+"""
+
+RETURN = """
+baz:
+ description: test return 1
+ returned: success
+ type: list
+ sample: ['a','b']
+"""