summaryrefslogtreecommitdiffstats
path: root/ansible_collections/infinidat/infinibox/plugins/doc_fragments
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:03:42 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-28 16:03:42 +0000
commit66cec45960ce1d9c794e9399de15c138acb18aed (patch)
tree59cd19d69e9d56b7989b080da7c20ef1a3fe2a5a /ansible_collections/infinidat/infinibox/plugins/doc_fragments
parentInitial commit. (diff)
downloadansible-66cec45960ce1d9c794e9399de15c138acb18aed.tar.xz
ansible-66cec45960ce1d9c794e9399de15c138acb18aed.zip
Adding upstream version 7.3.0+dfsg.upstream/7.3.0+dfsgupstream
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/infinidat/infinibox/plugins/doc_fragments')
-rw-r--r--ansible_collections/infinidat/infinibox/plugins/doc_fragments/infinibox.py43
1 files changed, 43 insertions, 0 deletions
diff --git a/ansible_collections/infinidat/infinibox/plugins/doc_fragments/infinibox.py b/ansible_collections/infinidat/infinibox/plugins/doc_fragments/infinibox.py
new file mode 100644
index 00000000..f88a55ea
--- /dev/null
+++ b/ansible_collections/infinidat/infinibox/plugins/doc_fragments/infinibox.py
@@ -0,0 +1,43 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2022, Infinidat <info@infinidat.com>
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+
+class ModuleDocFragment(object):
+ """
+ Standard Infinibox documentation fragment
+ """
+ DOCUMENTATION = r'''
+options:
+ system:
+ description:
+ - Infinibox Hostname or IPv4 Address.
+ type: str
+ required: true
+ user:
+ description:
+ - Infinibox User username with sufficient priveledges ( see notes ).
+ type: str
+ required: true
+ password:
+ description:
+ - Infinibox User password.
+ type: str
+ required: true
+notes:
+ - This module requires infinisdk python library
+ - You must set INFINIBOX_USER and INFINIBOX_PASSWORD environment variables
+ if user and password arguments are not passed to the module directly
+ - Ansible uses the infinisdk configuration file C(~/.infinidat/infinisdk.ini) if no credentials are provided.
+ See U(http://infinisdk.readthedocs.io/en/latest/getting_started.html)
+ - All Infinidat modules support check mode (--check). However, a dryrun that creates
+ resources may fail if the resource dependencies are not met for a task.
+ For example, consider a task that creates a volume in a pool.
+ If the pool does not exist, the volume creation task will fail.
+ It will fail even if there was a previous task in the playbook that would have created the pool but
+ did not because the pool creation was also part of the dry run.
+requirements:
+ - python2 >= 2.7 or python3 >= 3.6
+ - infinisdk (https://infinisdk.readthedocs.io/en/latest/)
+'''