mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-06 10:40:32 -07:00
964aa945a4
clc_*: create doc fragment (#9497)
* clc_*: create doc fragment
* add BOTMETA entry
* add doc frag itself
* add empty options dict to doc frag
* fix BOTMETA entry
* fix BOTMETA entry
* move author back to module
(cherry picked from commit 39deb81514)
Co-authored-by: Alexei Znamensky <103110+russoz@users.noreply.github.com>
28 lines
1.2 KiB
Python
28 lines
1.2 KiB
Python
# -*- coding: utf-8 -*-
|
|
|
|
# Copyright (c) 2024, Alexei Znamensky <russoz@gmail.com>
|
|
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
|
# SPDX-License-Identifier: GPL-3.0-or-later
|
|
|
|
from __future__ import (absolute_import, division, print_function)
|
|
__metaclass__ = type
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
# Standard documentation fragment
|
|
DOCUMENTATION = r"""
|
|
options: {}
|
|
requirements:
|
|
- requests >= 2.5.0
|
|
- clc-sdk
|
|
notes:
|
|
- To use this module, it is required to set the below environment variables which enables access to the Centurylink Cloud.
|
|
- E(CLC_V2_API_USERNAME), the account login ID for the Centurylink Cloud.
|
|
- E(CLC_V2_API_PASSWORD), the account password for the Centurylink Cloud.
|
|
- Alternatively, the module accepts the API token and account alias. The API token can be generated using the CLC account
|
|
login and password using the HTTP API call @ https://api.ctl.io/v2/authentication/login
|
|
- E(CLC_V2_API_TOKEN), the API token generated from https://api.ctl.io/v2/authentication/login
|
|
- E(CLC_ACCT_ALIAS), the account alias associated with the Centurylink Cloud.
|
|
- Users can set E(CLC_V2_API_URL) to specify an endpoint for pointing to a different CLC environment.
|
|
"""
|