summaryrefslogtreecommitdiffstats
path: root/ansible_collections/vultr/cloud/plugins/doc_fragments
diff options
context:
space:
mode:
authorDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:04:41 +0000
committerDaniel Baumann <daniel.baumann@progress-linux.org>2024-04-13 12:04:41 +0000
commit975f66f2eebe9dadba04f275774d4ab83f74cf25 (patch)
tree89bd26a93aaae6a25749145b7e4bca4a1e75b2be /ansible_collections/vultr/cloud/plugins/doc_fragments
parentInitial commit. (diff)
downloadansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.tar.xz
ansible-975f66f2eebe9dadba04f275774d4ab83f74cf25.zip
Adding upstream version 7.7.0+dfsg.upstream/7.7.0+dfsg
Signed-off-by: Daniel Baumann <daniel.baumann@progress-linux.org>
Diffstat (limited to 'ansible_collections/vultr/cloud/plugins/doc_fragments')
-rw-r--r--ansible_collections/vultr/cloud/plugins/doc_fragments/__init__.py0
-rw-r--r--ansible_collections/vultr/cloud/plugins/doc_fragments/vultr_v2.py51
2 files changed, 51 insertions, 0 deletions
diff --git a/ansible_collections/vultr/cloud/plugins/doc_fragments/__init__.py b/ansible_collections/vultr/cloud/plugins/doc_fragments/__init__.py
new file mode 100644
index 000000000..e69de29bb
--- /dev/null
+++ b/ansible_collections/vultr/cloud/plugins/doc_fragments/__init__.py
diff --git a/ansible_collections/vultr/cloud/plugins/doc_fragments/vultr_v2.py b/ansible_collections/vultr/cloud/plugins/doc_fragments/vultr_v2.py
new file mode 100644
index 000000000..692103e8c
--- /dev/null
+++ b/ansible_collections/vultr/cloud/plugins/doc_fragments/vultr_v2.py
@@ -0,0 +1,51 @@
+# -*- coding: utf-8 -*-
+
+# Copyright (c) 2021 René Moser <mail@renemoser.net>
+# 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):
+
+ DOCUMENTATION = """
+options:
+ api_key:
+ description:
+ - API key of the Vultr API.
+ - Fallback environment variable C(VULTR_API_KEY).
+ type: str
+ required: true
+ api_timeout:
+ description:
+ - HTTP timeout to Vultr API.
+ - Fallback environment variable C(VULTR_API_TIMEOUT).
+ type: int
+ default: 180
+ api_retries:
+ description:
+ - Amount of retries in case of the Vultr API retuns an HTTP 503 code.
+ - Fallback environment variable C(VULTR_API_RETRIES).
+ type: int
+ default: 5
+ api_retry_max_delay:
+ description:
+ - Retry backoff delay in seconds is exponential up to this max. value, in seconds.
+ - Fallback environment variable C(VULTR_API_RETRY_MAX_DELAY).
+ type: int
+ default: 12
+ api_endpoint:
+ description:
+ - URL to API endpint (without trailing slash).
+ - Fallback environment variable C(VULTR_API_ENDPOINT).
+ type: str
+ default: https://api.vultr.com/v2
+ validate_certs:
+ description:
+ - Validate SSL certs of the Vultr API.
+ type: bool
+ default: true
+notes:
+ - Also see the API documentation on U(https://www.vultr.com/api/).
+"""