mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
71 lines
3 KiB
Python
71 lines
3 KiB
Python
# -*- 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)
|
|
|
|
from __future__ import absolute_import, division, print_function
|
|
__metaclass__ = type
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
# Standard cloudstack documentation fragment
|
|
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:
|
|
- HTTP timeout in seconds.
|
|
- 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
|
|
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).
|
|
Configuration is read from several locations, in the following order.
|
|
The C(CLOUDSTACK_ENDPOINT), C(CLOUDSTACK_KEY), C(CLOUDSTACK_SECRET) and
|
|
C(CLOUDSTACK_METHOD). C(CLOUDSTACK_TIMEOUT) environment variables.
|
|
A C(CLOUDSTACK_CONFIG) environment variable pointing to an C(.ini) file.
|
|
A C(cloudstack.ini) file in the current working directory.
|
|
A C(.cloudstack.ini) file in the users home directory.
|
|
Optionally multiple credentials and endpoints can be specified using ini sections in C(cloudstack.ini).
|
|
Use the argument C(api_region) to select the section name, default section is C(cloudstack).
|
|
See https://github.com/exoscale/cs for more information.
|
|
- A detailed guide about cloudstack modules can be found in the L(CloudStack Cloud Guide,../scenario_guides/guide_cloudstack.html).
|
|
- This module supports check mode.
|
|
'''
|