mirror of
https://github.com/ansible-collections/community.general.git
synced 2024-09-14 20:13:21 +02:00
3ba00d5a07
Clean up doc fragments a bit (#7551)
Clean up doc fragments a bit.
(cherry picked from commit a88f6f56c7)
Co-authored-by: Felix Fontein <felix@fontein.de>
51 lines
1.7 KiB
Python
51 lines
1.7 KiB
Python
# -*- coding: utf-8 -*-
|
|
#
|
|
# Copyright (c) 2016, Dimension Data
|
|
# 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
|
|
|
|
# Authors:
|
|
# - Adam Friedman <tintoy@tintoy.io>
|
|
|
|
|
|
class ModuleDocFragment(object):
|
|
|
|
# Dimension Data doc fragment
|
|
DOCUMENTATION = r'''
|
|
|
|
options:
|
|
region:
|
|
description:
|
|
- The target region.
|
|
- Regions are defined in Apache libcloud project [libcloud/common/dimensiondata.py].
|
|
- They are also listed in U(https://libcloud.readthedocs.io/en/latest/compute/drivers/dimensiondata.html).
|
|
- Note that the default value C(na) stands for "North America".
|
|
- The module prepends C(dd-) to the region choice.
|
|
type: str
|
|
default: na
|
|
mcp_user:
|
|
description:
|
|
- The username used to authenticate to the CloudControl API.
|
|
- If not specified, will fall back to E(MCP_USER) from environment variable or C(~/.dimensiondata).
|
|
type: str
|
|
mcp_password:
|
|
description:
|
|
- The password used to authenticate to the CloudControl API.
|
|
- If not specified, will fall back to E(MCP_PASSWORD) from environment variable or C(~/.dimensiondata).
|
|
- Required if O(mcp_user) is specified.
|
|
type: str
|
|
location:
|
|
description:
|
|
- The target datacenter.
|
|
type: str
|
|
required: true
|
|
validate_certs:
|
|
description:
|
|
- If V(false), SSL certificates will not be validated.
|
|
- This should only be used on private instances of the CloudControl API that use self-signed certificates.
|
|
type: bool
|
|
default: true
|
|
'''
|