mirror of
https://github.com/ansible-collections/community.general.git
synced 2025-04-25 20:01:25 -07:00
doc_fragments: Clean up parameter types (cloud) (#52177)
* module_utils: Clean up parameter types (cloud) This PR includes: - Parameter types added - Copyright format fixes - Short license statement - Description fixes (only for a few files, then I stopped :-)) * More cloud stuff * Fix reported issue * Fix quotes * Use correct type * Fix quotes * Fix quotes * Fix quotes * Fix typo * Fix boolean
This commit is contained in:
parent
203caf2570
commit
25323155d2
28 changed files with 337 additions and 412 deletions
|
@ -1,4 +1,5 @@
|
|||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright (c) 2015, René Moser <mail@renemoser.net>
|
||||
# GNU General Public License v3.0+ (see COPYING or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
|
||||
|
@ -6,29 +7,33 @@
|
|||
class ModuleDocFragment(object):
|
||||
|
||||
# Standard cloudstack documentation fragment
|
||||
DOCUMENTATION = '''
|
||||
DOCUMENTATION = r'''
|
||||
options:
|
||||
api_key:
|
||||
description:
|
||||
- API key of the CloudStack API.
|
||||
- If not given, the C(CLOUDSTACK_KEY) env variable is considered.
|
||||
- As the last option, the value is taken from the ini config file, also see the notes.
|
||||
type: str
|
||||
api_secret:
|
||||
description:
|
||||
- Secret key of the CloudStack API.
|
||||
- If not set, the C(CLOUDSTACK_SECRET) env variable is considered.
|
||||
- As the last option, the value is taken from the ini config file, also see the notes.
|
||||
type: str
|
||||
api_url:
|
||||
description:
|
||||
- URL of the CloudStack API e.g. https://cloud.example.com/client/api.
|
||||
- If not given, the C(CLOUDSTACK_ENDPOINT) env variable is considered.
|
||||
- As the last option, the value is taken from the ini config file, also see the notes.
|
||||
type: str
|
||||
api_http_method:
|
||||
description:
|
||||
- HTTP method used to query the API endpoint.
|
||||
- If not given, the C(CLOUDSTACK_METHOD) env variable is considered.
|
||||
- As the last option, the value is taken from the ini config file, also see the notes.
|
||||
- Fallback value is C(get) if not specified.
|
||||
type: str
|
||||
choices: [ get, post ]
|
||||
api_timeout:
|
||||
description:
|
||||
|
@ -36,14 +41,16 @@ options:
|
|||
- If not given, the C(CLOUDSTACK_TIMEOUT) env variable is considered.
|
||||
- As the last option, the value is taken from the ini config file, also see the notes.
|
||||
- Fallback value is 10 seconds if not specified.
|
||||
type: int
|
||||
api_region:
|
||||
description:
|
||||
- Name of the ini section in the C(cloustack.ini) file.
|
||||
- If not given, the C(CLOUDSTACK_REGION) env variable is considered.
|
||||
type: str
|
||||
default: cloudstack
|
||||
requirements:
|
||||
- "python >= 2.6"
|
||||
- "cs >= 0.6.10"
|
||||
- python >= 2.6
|
||||
- cs >= 0.6.10
|
||||
notes:
|
||||
- Ansible uses the C(cs) library's configuration method if credentials are not
|
||||
provided by the arguments C(api_url), C(api_key), C(api_secret).
|
||||
|
|
Loading…
Add table
Add a link
Reference in a new issue