summaryrefslogtreecommitdiffstats
path: root/ansible_collections/community/digitalocean/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/community/digitalocean/plugins/doc_fragments
parentInitial commit. (diff)
downloadansible-upstream.tar.xz
ansible-upstream.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/community/digitalocean/plugins/doc_fragments')
-rw-r--r--ansible_collections/community/digitalocean/plugins/doc_fragments/digital_ocean.py39
1 files changed, 39 insertions, 0 deletions
diff --git a/ansible_collections/community/digitalocean/plugins/doc_fragments/digital_ocean.py b/ansible_collections/community/digitalocean/plugins/doc_fragments/digital_ocean.py
new file mode 100644
index 00000000..bc65ad38
--- /dev/null
+++ b/ansible_collections/community/digitalocean/plugins/doc_fragments/digital_ocean.py
@@ -0,0 +1,39 @@
+# -*- coding: utf-8 -*-
+
+# Copyright: (c) 2018, Ansible Project
+# Copyright: (c) 2018, Abhijeet Kasurde (akasurde@redhat.com)
+# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
+
+from __future__ import absolute_import, division, print_function
+
+__metaclass__ = type
+
+
+class ModuleDocFragment(object):
+ # Parameters for DigitalOcean modules
+ DOCUMENTATION = r"""
+options:
+ baseurl:
+ description:
+ - DigitalOcean API base url.
+ type: str
+ default: https://api.digitalocean.com/v2
+ oauth_token:
+ description:
+ - DigitalOcean OAuth token.
+ - "There are several other environment variables which can be used to provide this value."
+ - "i.e., - 'DO_API_TOKEN', 'DO_API_KEY', 'DO_OAUTH_TOKEN' and 'OAUTH_TOKEN'"
+ type: str
+ aliases: [ api_token ]
+ timeout:
+ description:
+ - The timeout in seconds used for polling DigitalOcean's API.
+ type: int
+ default: 30
+ validate_certs:
+ description:
+ - If set to C(no), the SSL certificates will not be validated.
+ - This should only set to C(no) used on personally controlled sites using self-signed certificates.
+ type: bool
+ default: yes
+"""