2020-03-09 10:11:07 +01:00
|
|
|
# -*- coding: utf-8 -*-
|
|
|
|
|
|
|
|
|
|
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
|
|
|
|
2020-06-24 21:50:36 +02:00
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
|
|
|
__metaclass__ = type
|
|
|
|
|
|
2020-03-09 10:11:07 +01:00
|
|
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
|
|
|
|
|
|
# Standard documentation fragment
|
|
|
|
|
DOCUMENTATION = r'''
|
|
|
|
|
options:
|
|
|
|
|
api_token:
|
|
|
|
|
description:
|
|
|
|
|
- Online OAuth token.
|
|
|
|
|
type: str
|
2020-11-28 04:54:00 +01:00
|
|
|
required: true
|
2020-03-09 10:11:07 +01:00
|
|
|
aliases: [ oauth_token ]
|
|
|
|
|
api_url:
|
|
|
|
|
description:
|
|
|
|
|
- Online API URL
|
|
|
|
|
type: str
|
|
|
|
|
default: 'https://api.online.net'
|
|
|
|
|
aliases: [ base_url ]
|
|
|
|
|
api_timeout:
|
|
|
|
|
description:
|
|
|
|
|
- HTTP timeout to Online API in seconds.
|
|
|
|
|
type: int
|
|
|
|
|
default: 30
|
|
|
|
|
aliases: [ timeout ]
|
|
|
|
|
validate_certs:
|
|
|
|
|
description:
|
|
|
|
|
- Validate SSL certs of the Online API.
|
|
|
|
|
type: bool
|
|
|
|
|
default: yes
|
|
|
|
|
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.
|
|
|
|
|
'''
|
