mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
57 lines
1.8 KiB
Python
57 lines
1.8 KiB
Python
|
# -*- coding: utf-8 -*-
|
||
|
|
|
||
|
|
# Copyright (c) 2017 René Moser <mail@renemoser.net>
|
||
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||
|
|
|
||
|
|
|
||
|
|
class ModuleDocFragment(object):
|
||
|
|
|
||
|
|
# Standard documentation fragment
|
||
|
|
DOCUMENTATION = r'''
|
||
|
|
options:
|
||
|
|
api_key:
|
||
|
|
description:
|
||
|
|
- API key of the Vultr API.
|
||
|
|
- The ENV variable C(VULTR_API_KEY) is used as default, when defined.
|
||
|
|
type: str
|
||
|
|
api_timeout:
|
||
|
|
description:
|
||
|
|
- HTTP timeout to Vultr API.
|
||
|
|
- The ENV variable C(VULTR_API_TIMEOUT) is used as default, when defined.
|
||
|
|
- Fallback value is 60 seconds if not specified.
|
||
|
|
type: int
|
||
|
|
api_retries:
|
||
|
|
description:
|
||
|
|
- Amount of retries in case of the Vultr API retuns an HTTP 503 code.
|
||
|
|
- The ENV variable C(VULTR_API_RETRIES) is used as default, when defined.
|
||
|
|
- Fallback value is 5 retries if not specified.
|
||
|
|
type: int
|
||
|
|
api_retry_max_delay:
|
||
|
|
description:
|
||
|
|
- Retry backoff delay in seconds is exponential up to this max. value, in seconds.
|
||
|
|
- The ENV variable C(VULTR_API_RETRY_MAX_DELAY) is used as default, when defined.
|
||
|
|
- Fallback value is 12 seconds.
|
||
|
|
type: int
|
||
|
|
api_account:
|
||
|
|
description:
|
||
|
|
- Name of the ini section in the C(vultr.ini) file.
|
||
|
|
- The ENV variable C(VULTR_API_ACCOUNT) is used as default, when defined.
|
||
|
|
type: str
|
||
|
|
default: default
|
||
|
|
api_endpoint:
|
||
|
|
description:
|
||
|
|
- URL to API endpint (without trailing slash).
|
||
|
|
- The ENV variable C(VULTR_API_ENDPOINT) is used as default, when defined.
|
||
|
|
- Fallback value is U(https://api.vultr.com) if not specified.
|
||
|
|
type: str
|
||
|
|
validate_certs:
|
||
|
|
description:
|
||
|
|
- Validate SSL certs of the Vultr API.
|
||
|
|
type: bool
|
||
|
|
default: yes
|
||
|
|
requirements:
|
||
|
|
- python >= 2.6
|
||
|
|
notes:
|
||
|
|
- Also see the API documentation on https://www.vultr.com/api/.
|
||
|
|
'''
|