mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-26 04:11:25 -07:00
96b3ef5553
* promote doc_fragments into actual plugins change tests hardcoded path to doc fragments avoid sanity in fragments avoid improper testing of doc_fragments also change runner paths fix botmeta updated comment for fragments updated docs
44 lines
1.5 KiB
Python
44 lines
1.5 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 = '''
|
|
options:
|
|
api_key:
|
|
description:
|
|
- API key of the Vultr API.
|
|
- The ENV variable C(VULTR_API_KEY) is used as default, when defined.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
validate_certs:
|
|
description:
|
|
- Validate SSL certs of the Vultr API.
|
|
default: yes
|
|
type: bool
|
|
requirements:
|
|
- "python >= 2.6"
|
|
notes:
|
|
- Also see the API documentation on https://www.vultr.com/api/.
|
|
'''
|