mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-18 16:31:26 -07:00
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
This commit is contained in:
parent
bb12db3c58
commit
39deb81514
12 changed files with 60 additions and 133 deletions
|
@ -16,6 +16,9 @@ description:
|
|||
- An Ansible module to Create, Delete, Start and Stop servers in CenturyLink Cloud.
|
||||
extends_documentation_fragment:
|
||||
- community.general.attributes
|
||||
- community.general.clc
|
||||
author:
|
||||
- "CLC Runner (@clc-runner)"
|
||||
attributes:
|
||||
check_mode:
|
||||
support: full
|
||||
|
@ -200,19 +203,6 @@ options:
|
|||
- Whether to wait for the provisioning tasks to finish before returning.
|
||||
type: bool
|
||||
default: true
|
||||
requirements:
|
||||
- requests >= 2.5.0
|
||||
- clc-sdk
|
||||
author: "CLC Runner (@clc-runner)"
|
||||
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.
|
||||
"""
|
||||
|
||||
EXAMPLES = r"""
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue