mirror of
https://github.com/thegeeklab/ansible-later.git
synced 2024-07-03 23:50:58 +02:00
37 lines
1.1 KiB
Python
37 lines
1.1 KiB
Python
# -*- coding: utf-8 -*-
|
|
# 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_token:
|
|
description:
|
|
- Online OAuth token.
|
|
aliases: ['oauth_token']
|
|
api_url:
|
|
description:
|
|
- Online API URL
|
|
default: 'https://api.online.net/api/v1'
|
|
aliases: ['base_url']
|
|
api_timeout:
|
|
description:
|
|
- HTTP timeout to Online API in seconds.
|
|
default: 30
|
|
aliases: ['timeout']
|
|
validate_certs:
|
|
description:
|
|
- Validate SSL certs of the Online API.
|
|
default: yes
|
|
type: bool
|
|
notes:
|
|
- Also see the API documentation on U(https://console.online.net/en/api/)
|
|
- If C(api_token) is not set within the module, the following
|
|
environment variables can be used in decreasing order of precedence
|
|
C(ONLINE_TOKEN), C(ONLINE_API_KEY), C(ONLINE_OAUTH_TOKEN), C(ONLINE_API_TOKEN)
|
|
- If one wants to use a different C(api_url) one can also set the C(ONLINE_API_URL)
|
|
environment variable.
|
|
'''
|